1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #ifndef __ACNAMESP_H__
45 #define __ACNAMESP_H__
47 /* To search the entire name space, pass this as search_base */
49 #define ACPI_NS_ALL ((acpi_handle)0)
52 * Elements of acpi_ns_properties are bit significant
53 * and should be one-to-one with values of acpi_object_type
55 #define ACPI_NS_NORMAL 0
56 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
57 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
59 /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */
61 #define ACPI_NS_NO_UPSEARCH 0
62 #define ACPI_NS_SEARCH_PARENT 0x01
63 #define ACPI_NS_DONT_OPEN_SCOPE 0x02
64 #define ACPI_NS_NO_PEER_SEARCH 0x04
65 #define ACPI_NS_ERROR_IF_FOUND 0x08
66 #define ACPI_NS_PREFIX_IS_SCOPE 0x10
67 #define ACPI_NS_EXTERNAL 0x20
69 #define ACPI_NS_WALK_UNLOCK TRUE
70 #define ACPI_NS_WALK_NO_UNLOCK FALSE
73 * nsinit - Namespace initialization
75 acpi_status acpi_ns_initialize_objects(void);
77 acpi_status acpi_ns_initialize_devices(void);
80 * nsload - Namespace loading
82 acpi_status acpi_ns_load_namespace(void);
85 acpi_ns_load_table(struct acpi_table_desc *table_desc,
86 struct acpi_namespace_node *node);
89 * nswalk - walk the namespace
92 acpi_ns_walk_namespace(acpi_object_type type,
93 acpi_handle start_object,
95 u8 unlock_before_callback,
96 acpi_walk_callback user_function,
97 void *context, void **return_value);
99 struct acpi_namespace_node *acpi_ns_get_next_node(acpi_object_type type,
100 struct acpi_namespace_node
102 struct acpi_namespace_node
106 * nsparse - table parsing
109 acpi_ns_parse_table(struct acpi_table_desc *table_desc,
110 struct acpi_namespace_node *scope);
113 acpi_ns_one_complete_parse(u8 pass_number, struct acpi_table_desc *table_desc);
116 * nsaccess - Top-level namespace access
118 acpi_status acpi_ns_root_initialize(void);
121 acpi_ns_lookup(union acpi_generic_state *scope_info,
123 acpi_object_type type,
124 acpi_interpreter_mode interpreter_mode,
126 struct acpi_walk_state *walk_state,
127 struct acpi_namespace_node **ret_node);
130 * nsalloc - Named object allocation/deallocation
132 struct acpi_namespace_node *acpi_ns_create_node(u32 name);
134 void acpi_ns_delete_node(struct acpi_namespace_node *node);
137 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
139 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
141 void acpi_ns_detach_object(struct acpi_namespace_node *node);
143 void acpi_ns_delete_children(struct acpi_namespace_node *parent);
145 int acpi_ns_compare_names(char *name1, char *name2);
148 * nsdump - Namespace dump/print utilities
150 #ifdef ACPI_FUTURE_USAGE
151 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
152 #endif /* ACPI_FUTURE_USAGE */
154 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
157 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component);
159 void acpi_ns_print_pathname(u32 num_segments, char *pathname);
162 acpi_ns_dump_one_object(acpi_handle obj_handle,
163 u32 level, void *context, void **return_value);
165 #ifdef ACPI_FUTURE_USAGE
167 acpi_ns_dump_objects(acpi_object_type type,
170 acpi_owner_id owner_id, acpi_handle start_handle);
171 #endif /* ACPI_FUTURE_USAGE */
174 * nseval - Namespace evaluation functions
176 acpi_status acpi_ns_evaluate_by_handle(struct acpi_parameter_info *info);
179 acpi_ns_evaluate_by_name(char *pathname, struct acpi_parameter_info *info);
182 acpi_ns_evaluate_relative(char *pathname, struct acpi_parameter_info *info);
185 * nsnames - Name and Scope manipulation
187 u32 acpi_ns_opens_scope(acpi_object_type type);
190 acpi_ns_build_external_path(struct acpi_namespace_node *node,
191 acpi_size size, char *name_buffer);
193 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
195 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
198 acpi_ns_handle_to_pathname(acpi_handle target_handle,
199 struct acpi_buffer *buffer);
202 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
205 acpi_ns_get_node_by_path(char *external_pathname,
206 struct acpi_namespace_node *in_prefix_node,
207 u32 flags, struct acpi_namespace_node **out_node);
209 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
212 * nsobject - Object management for namespace nodes
215 acpi_ns_attach_object(struct acpi_namespace_node *node,
216 union acpi_operand_object *object, acpi_object_type type);
218 union acpi_operand_object *acpi_ns_get_attached_object(struct
222 union acpi_operand_object *acpi_ns_get_secondary_object(union
227 acpi_ns_attach_data(struct acpi_namespace_node *node,
228 acpi_object_handler handler, void *data);
231 acpi_ns_detach_data(struct acpi_namespace_node *node,
232 acpi_object_handler handler);
235 acpi_ns_get_attached_data(struct acpi_namespace_node *node,
236 acpi_object_handler handler, void **data);
239 * nssearch - Namespace searching and entry
242 acpi_ns_search_and_enter(u32 entry_name,
243 struct acpi_walk_state *walk_state,
244 struct acpi_namespace_node *node,
245 acpi_interpreter_mode interpreter_mode,
246 acpi_object_type type,
247 u32 flags, struct acpi_namespace_node **ret_node);
250 acpi_ns_search_node(u32 entry_name,
251 struct acpi_namespace_node *node,
252 acpi_object_type type,
253 struct acpi_namespace_node **ret_node);
256 acpi_ns_install_node(struct acpi_walk_state *walk_state,
257 struct acpi_namespace_node *parent_node,
258 struct acpi_namespace_node *node, acpi_object_type type);
261 * nsutils - Utility functions
263 u8 acpi_ns_valid_root_prefix(char prefix);
265 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
267 u32 acpi_ns_local(acpi_object_type type);
270 acpi_ns_report_error(char *module_name,
272 char *internal_name, acpi_status lookup_status);
275 acpi_ns_report_method_error(char *module_name,
278 struct acpi_namespace_node *node,
279 char *path, acpi_status lookup_status);
281 void acpi_ns_print_node_pathname(struct acpi_namespace_node *node, char *msg);
283 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
285 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
287 acpi_status acpi_ns_internalize_name(char *dotted_name, char **converted_name);
290 acpi_ns_externalize_name(u32 internal_name_length,
292 u32 * converted_name_length, char **converted_name);
294 struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle);
296 acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node);
298 void acpi_ns_terminate(void);
300 struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node
303 struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct
307 #endif /* __ACNAMESP_H__ */