1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
6 *****************************************************************************/
9 * Copyright (C) 2000, 2001 R. Byron Moore
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #ifndef __ACNAMESP_H__
27 #define __ACNAMESP_H__
30 /* To search the entire name space, pass this as Search_base */
32 #define NS_ALL ((ACPI_HANDLE)0)
35 * Elements of Acpi_ns_properties are bit significant
36 * and should be one-to-one with values of ACPI_OBJECT_TYPE
39 #define NSP_NEWSCOPE 1 /* a definition of this type opens a name scope */
40 #define NSP_LOCAL 2 /* suppress search of enclosing scopes */
43 /* Definitions of the predefined namespace names */
45 #define ACPI_UNKNOWN_NAME (u32) 0x3F3F3F3F /* Unknown name is "????" */
46 #define ACPI_ROOT_NAME (u32) 0x2F202020 /* Root name is "/ " */
47 #define ACPI_SYS_BUS_NAME (u32) 0x5F53425F /* Sys bus name is "_SB_" */
49 #define NS_ROOT_PATH "/"
50 #define NS_SYSTEM_BUS "_SB_"
53 /* Flags for Acpi_ns_lookup, Acpi_ns_search_and_enter */
55 #define NS_NO_UPSEARCH 0
56 #define NS_SEARCH_PARENT 0x01
57 #define NS_DONT_OPEN_SCOPE 0x02
58 #define NS_NO_PEER_SEARCH 0x04
59 #define NS_ERROR_IF_FOUND 0x08
61 #define NS_WALK_UNLOCK TRUE
62 #define NS_WALK_NO_UNLOCK FALSE
66 acpi_ns_load_namespace (
70 acpi_ns_initialize_objects (
74 acpi_ns_initialize_devices (
78 /* Namespace init - nsxfinit */
81 acpi_ns_init_one_device (
82 ACPI_HANDLE obj_handle,
88 acpi_ns_init_one_object (
89 ACPI_HANDLE obj_handle,
96 acpi_ns_walk_namespace (
97 OBJECT_TYPE_INTERNAL type,
98 ACPI_HANDLE start_object,
100 u8 unlock_before_callback,
101 WALK_CALLBACK user_function,
103 void **return_value);
106 ACPI_NAMESPACE_NODE *
107 acpi_ns_get_next_object (
108 OBJECT_TYPE_INTERNAL type,
109 ACPI_NAMESPACE_NODE *parent,
110 ACPI_NAMESPACE_NODE *child);
114 acpi_ns_delete_namespace_by_owner (
118 /* Namespace loading - nsload */
121 acpi_ns_one_complete_parse (
123 ACPI_TABLE_DESC *table_desc);
126 acpi_ns_parse_table (
127 ACPI_TABLE_DESC *table_desc,
128 ACPI_NAMESPACE_NODE *scope);
132 ACPI_TABLE_DESC *table_desc,
133 ACPI_NAMESPACE_NODE *node);
136 acpi_ns_load_table_by_type (
137 ACPI_TABLE_TYPE table_type);
141 * Top-level namespace access - nsaccess
146 acpi_ns_root_initialize (
151 ACPI_GENERIC_STATE *scope_info,
153 OBJECT_TYPE_INTERNAL type,
154 OPERATING_MODE interpreter_mode,
156 ACPI_WALK_STATE *walk_state,
157 ACPI_NAMESPACE_NODE **ret_node);
161 * Named object allocation/deallocation - nsalloc
165 ACPI_NAMESPACE_NODE *
166 acpi_ns_create_node (
170 acpi_ns_delete_node (
171 ACPI_NAMESPACE_NODE *node);
174 acpi_ns_delete_namespace_subtree (
175 ACPI_NAMESPACE_NODE *parent_handle);
178 acpi_ns_detach_object (
179 ACPI_NAMESPACE_NODE *node);
182 acpi_ns_delete_children (
183 ACPI_NAMESPACE_NODE *parent);
187 * Namespace modification - nsmodify
191 acpi_ns_unload_namespace (
195 acpi_ns_delete_subtree (
196 ACPI_HANDLE start_handle);
200 * Namespace dump/print utilities - nsdump
204 acpi_ns_dump_tables (
205 ACPI_HANDLE search_base,
214 acpi_ns_dump_pathname (
221 acpi_ns_dump_root_devices (
225 acpi_ns_dump_objects (
226 OBJECT_TYPE_INTERNAL type,
229 ACPI_HANDLE start_handle);
233 * Namespace evaluation functions - nseval
237 acpi_ns_evaluate_by_handle (
238 ACPI_NAMESPACE_NODE *prefix_node,
239 ACPI_OPERAND_OBJECT **params,
240 ACPI_OPERAND_OBJECT **return_object);
243 acpi_ns_evaluate_by_name (
244 NATIVE_CHAR *pathname,
245 ACPI_OPERAND_OBJECT **params,
246 ACPI_OPERAND_OBJECT **return_object);
249 acpi_ns_evaluate_relative (
250 ACPI_NAMESPACE_NODE *prefix_node,
251 NATIVE_CHAR *pathname,
252 ACPI_OPERAND_OBJECT **params,
253 ACPI_OPERAND_OBJECT **return_object);
256 acpi_ns_execute_control_method (
257 ACPI_NAMESPACE_NODE *method_node,
258 ACPI_OPERAND_OBJECT **params,
259 ACPI_OPERAND_OBJECT **return_obj_desc);
262 acpi_ns_get_object_value (
263 ACPI_NAMESPACE_NODE *object_node,
264 ACPI_OPERAND_OBJECT **return_obj_desc);
268 * Parent/Child/Peer utility functions - nsfamily
272 acpi_ns_find_parent_name (
273 ACPI_NAMESPACE_NODE *node_to_search);
276 acpi_ns_exist_downstream_sibling (
277 ACPI_NAMESPACE_NODE *this_node);
281 * Scope manipulation - nsscope
285 acpi_ns_opens_scope (
286 OBJECT_TYPE_INTERNAL type);
289 acpi_ns_get_table_pathname (
290 ACPI_NAMESPACE_NODE *node);
293 acpi_ns_name_of_current_scope (
294 ACPI_WALK_STATE *walk_state);
297 acpi_ns_handle_to_pathname (
298 ACPI_HANDLE obj_handle,
300 NATIVE_CHAR *user_buffer);
303 acpi_ns_pattern_match (
304 ACPI_NAMESPACE_NODE *obj_node,
305 NATIVE_CHAR *search_for);
308 acpi_ns_name_compare (
309 ACPI_HANDLE obj_handle,
312 void **return_value);
316 NATIVE_CHAR *pathname,
317 ACPI_NAMESPACE_NODE *in_prefix_node,
318 ACPI_NAMESPACE_NODE **out_node);
321 acpi_ns_get_pathname_length (
322 ACPI_NAMESPACE_NODE *node);
326 * Object management for NTEs - nsobject
330 acpi_ns_attach_object (
331 ACPI_NAMESPACE_NODE *node,
332 ACPI_OPERAND_OBJECT *object,
333 OBJECT_TYPE_INTERNAL type);
337 acpi_ns_compare_value (
338 ACPI_HANDLE obj_handle,
344 * Namespace searching and entry - nssearch
348 acpi_ns_search_and_enter (
350 ACPI_WALK_STATE *walk_state,
351 ACPI_NAMESPACE_NODE *node,
352 OPERATING_MODE interpreter_mode,
353 OBJECT_TYPE_INTERNAL type,
355 ACPI_NAMESPACE_NODE **ret_node);
358 acpi_ns_search_node (
360 ACPI_NAMESPACE_NODE *node,
361 OBJECT_TYPE_INTERNAL type,
362 ACPI_NAMESPACE_NODE **ret_node);
365 acpi_ns_install_node (
366 ACPI_WALK_STATE *walk_state,
367 ACPI_NAMESPACE_NODE *parent_node, /* Parent */
368 ACPI_NAMESPACE_NODE *node, /* New Child*/
369 OBJECT_TYPE_INTERNAL type);
373 * Utility functions - nsutils
377 acpi_ns_valid_root_prefix (
381 acpi_ns_valid_path_separator (
386 ACPI_HANDLE obj_handle);
389 acpi_ns_get_attached_object (
390 ACPI_HANDLE obj_handle);
394 OBJECT_TYPE_INTERNAL type);
397 acpi_ns_internalize_name (
398 NATIVE_CHAR *dotted_name,
399 NATIVE_CHAR **converted_name);
402 acpi_ns_externalize_name (
403 u32 internal_name_length,
404 NATIVE_CHAR *internal_name,
405 u32 *converted_name_length,
406 NATIVE_CHAR **converted_name);
408 ACPI_NAMESPACE_NODE *
409 acpi_ns_convert_handle_to_entry (
413 acpi_ns_convert_entry_to_handle(
414 ACPI_NAMESPACE_NODE *node);
420 ACPI_NAMESPACE_NODE *
421 acpi_ns_get_parent_object (
422 ACPI_NAMESPACE_NODE *node);
425 ACPI_NAMESPACE_NODE *
426 acpi_ns_get_next_valid_object (
427 ACPI_NAMESPACE_NODE *node);
430 #endif /* __ACNAMESP_H__ */