Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acnamesp.h - Namespace subcomponent prototypes and defines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
77848130 | 8 | * Copyright (C) 2000 - 2012, Intel Corp. |
1da177e4 LT |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
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. | |
25 | * | |
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. | |
29 | * | |
30 | * NO WARRANTY | |
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. | |
42 | */ | |
43 | ||
44 | #ifndef __ACNAMESP_H__ | |
45 | #define __ACNAMESP_H__ | |
46 | ||
1da177e4 LT |
47 | /* To search the entire name space, pass this as search_base */ |
48 | ||
49 | #define ACPI_NS_ALL ((acpi_handle)0) | |
50 | ||
51 | /* | |
52 | * Elements of acpi_ns_properties are bit significant | |
53 | * and should be one-to-one with values of acpi_object_type | |
54 | */ | |
55 | #define ACPI_NS_NORMAL 0 | |
4be44fcd LB |
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 */ | |
1da177e4 | 58 | |
1da177e4 LT |
59 | /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */ |
60 | ||
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 | |
8313524a | 66 | #define ACPI_NS_PREFIX_IS_SCOPE 0x10 |
958dd242 | 67 | #define ACPI_NS_EXTERNAL 0x20 |
d1fdda83 | 68 | #define ACPI_NS_TEMPORARY 0x40 |
1da177e4 | 69 | |
d1fdda83 BM |
70 | /* Flags for acpi_ns_walk_namespace */ |
71 | ||
72 | #define ACPI_NS_WALK_NO_UNLOCK 0 | |
73 | #define ACPI_NS_WALK_UNLOCK 0x01 | |
74 | #define ACPI_NS_WALK_TEMP_NODES 0x02 | |
1da177e4 | 75 | |
b2deadd5 BM |
76 | /* Object is not a package element */ |
77 | ||
78 | #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX | |
79 | ||
80 | /* Always emit warning message, not dependent on node flags */ | |
81 | ||
82 | #define ACPI_WARN_ALWAYS 0 | |
83 | ||
44f6c012 RM |
84 | /* |
85 | * nsinit - Namespace initialization | |
86 | */ | |
4be44fcd | 87 | acpi_status acpi_ns_initialize_objects(void); |
1da177e4 | 88 | |
4be44fcd | 89 | acpi_status acpi_ns_initialize_devices(void); |
1da177e4 | 90 | |
44f6c012 RM |
91 | /* |
92 | * nsload - Namespace loading | |
93 | */ | |
4be44fcd | 94 | acpi_status acpi_ns_load_namespace(void); |
1da177e4 LT |
95 | |
96 | acpi_status | |
67a119f9 | 97 | acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); |
1da177e4 | 98 | |
44f6c012 RM |
99 | /* |
100 | * nswalk - walk the namespace | |
101 | */ | |
1da177e4 | 102 | acpi_status |
4be44fcd LB |
103 | acpi_ns_walk_namespace(acpi_object_type type, |
104 | acpi_handle start_object, | |
105 | u32 max_depth, | |
d1fdda83 | 106 | u32 flags, |
2263576c LM |
107 | acpi_walk_callback pre_order_visit, |
108 | acpi_walk_callback post_order_visit, | |
4be44fcd LB |
109 | void *context, void **return_value); |
110 | ||
8c725bf9 BM |
111 | struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node |
112 | *parent, | |
113 | struct acpi_namespace_node | |
4be44fcd | 114 | *child); |
1da177e4 | 115 | |
8c725bf9 BM |
116 | struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, |
117 | struct | |
118 | acpi_namespace_node | |
119 | *parent, | |
120 | struct | |
121 | acpi_namespace_node | |
122 | *child); | |
123 | ||
44f6c012 RM |
124 | /* |
125 | * nsparse - table parsing | |
126 | */ | |
1da177e4 | 127 | acpi_status |
67a119f9 | 128 | acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); |
1da177e4 LT |
129 | |
130 | acpi_status | |
67a119f9 BM |
131 | acpi_ns_one_complete_parse(u32 pass_number, |
132 | u32 table_index, | |
7f4ac9f9 | 133 | struct acpi_namespace_node *start_node); |
1da177e4 LT |
134 | |
135 | /* | |
44f6c012 | 136 | * nsaccess - Top-level namespace access |
1da177e4 | 137 | */ |
4be44fcd | 138 | acpi_status acpi_ns_root_initialize(void); |
1da177e4 LT |
139 | |
140 | acpi_status | |
4be44fcd LB |
141 | acpi_ns_lookup(union acpi_generic_state *scope_info, |
142 | char *name, | |
143 | acpi_object_type type, | |
144 | acpi_interpreter_mode interpreter_mode, | |
145 | u32 flags, | |
146 | struct acpi_walk_state *walk_state, | |
147 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
148 | |
149 | /* | |
44f6c012 | 150 | * nsalloc - Named object allocation/deallocation |
1da177e4 | 151 | */ |
4be44fcd | 152 | struct acpi_namespace_node *acpi_ns_create_node(u32 name); |
1da177e4 | 153 | |
4be44fcd | 154 | void acpi_ns_delete_node(struct acpi_namespace_node *node); |
1da177e4 | 155 | |
8e4319c4 BM |
156 | void acpi_ns_remove_node(struct acpi_namespace_node *node); |
157 | ||
44f6c012 | 158 | void |
4be44fcd | 159 | acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); |
44f6c012 | 160 | |
4be44fcd | 161 | void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); |
1da177e4 | 162 | |
4be44fcd | 163 | void acpi_ns_detach_object(struct acpi_namespace_node *node); |
1da177e4 | 164 | |
4be44fcd | 165 | void acpi_ns_delete_children(struct acpi_namespace_node *parent); |
1da177e4 | 166 | |
4be44fcd | 167 | int acpi_ns_compare_names(char *name1, char *name2); |
1da177e4 LT |
168 | |
169 | /* | |
44f6c012 | 170 | * nsdump - Namespace dump/print utilities |
1da177e4 | 171 | */ |
44f6c012 | 172 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd LB |
173 | void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); |
174 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 175 | |
4be44fcd | 176 | void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); |
1da177e4 LT |
177 | |
178 | void | |
4be44fcd | 179 | acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); |
1da177e4 | 180 | |
4be44fcd | 181 | void acpi_ns_print_pathname(u32 num_segments, char *pathname); |
1da177e4 | 182 | |
1da177e4 | 183 | acpi_status |
4be44fcd LB |
184 | acpi_ns_dump_one_object(acpi_handle obj_handle, |
185 | u32 level, void *context, void **return_value); | |
1da177e4 | 186 | |
44f6c012 | 187 | #ifdef ACPI_FUTURE_USAGE |
1da177e4 | 188 | void |
4be44fcd LB |
189 | acpi_ns_dump_objects(acpi_object_type type, |
190 | u8 display_type, | |
191 | u32 max_depth, | |
192 | acpi_owner_id owner_id, acpi_handle start_handle); | |
193 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 LT |
194 | |
195 | /* | |
44f6c012 | 196 | * nseval - Namespace evaluation functions |
1da177e4 | 197 | */ |
4119532c | 198 | acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); |
1da177e4 | 199 | |
7f0c826a LM |
200 | void acpi_ns_exec_module_code_list(void); |
201 | ||
e8707b34 BM |
202 | /* |
203 | * nspredef - Support for predefined/reserved names | |
204 | */ | |
205 | acpi_status | |
206 | acpi_ns_check_predefined_names(struct acpi_namespace_node *node, | |
eeb4437e BM |
207 | u32 user_param_count, |
208 | acpi_status return_status, | |
a647b5c3 | 209 | union acpi_operand_object **return_object); |
e8707b34 BM |
210 | |
211 | const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct | |
212 | acpi_namespace_node | |
213 | *node); | |
214 | ||
215 | void | |
216 | acpi_ns_check_parameter_count(char *pathname, | |
217 | struct acpi_namespace_node *node, | |
eeb4437e | 218 | u32 user_param_count, |
e8707b34 BM |
219 | const union acpi_predefined_info *info); |
220 | ||
1da177e4 | 221 | /* |
44f6c012 | 222 | * nsnames - Name and Scope manipulation |
1da177e4 | 223 | */ |
4be44fcd | 224 | u32 acpi_ns_opens_scope(acpi_object_type type); |
1da177e4 | 225 | |
3c7db22a | 226 | acpi_status |
8313524a BM |
227 | acpi_ns_build_external_path(struct acpi_namespace_node *node, |
228 | acpi_size size, char *name_buffer); | |
229 | ||
4be44fcd | 230 | char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); |
1da177e4 | 231 | |
4be44fcd | 232 | char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); |
1da177e4 LT |
233 | |
234 | acpi_status | |
4be44fcd LB |
235 | acpi_ns_handle_to_pathname(acpi_handle target_handle, |
236 | struct acpi_buffer *buffer); | |
1da177e4 LT |
237 | |
238 | u8 | |
4be44fcd | 239 | acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); |
1da177e4 LT |
240 | |
241 | acpi_status | |
4119532c | 242 | acpi_ns_get_node(struct acpi_namespace_node *prefix_node, |
4b8ed631 | 243 | const char *external_pathname, |
4119532c | 244 | u32 flags, struct acpi_namespace_node **out_node); |
1da177e4 | 245 | |
4be44fcd | 246 | acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); |
1da177e4 LT |
247 | |
248 | /* | |
44f6c012 | 249 | * nsobject - Object management for namespace nodes |
1da177e4 | 250 | */ |
1da177e4 | 251 | acpi_status |
4be44fcd LB |
252 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
253 | union acpi_operand_object *object, acpi_object_type type); | |
1da177e4 | 254 | |
4be44fcd LB |
255 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
256 | acpi_namespace_node | |
257 | *node); | |
1da177e4 | 258 | |
4be44fcd LB |
259 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
260 | acpi_operand_object | |
261 | *obj_desc); | |
1da177e4 LT |
262 | |
263 | acpi_status | |
4be44fcd LB |
264 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
265 | acpi_object_handler handler, void *data); | |
1da177e4 LT |
266 | |
267 | acpi_status | |
4be44fcd LB |
268 | acpi_ns_detach_data(struct acpi_namespace_node *node, |
269 | acpi_object_handler handler); | |
1da177e4 LT |
270 | |
271 | acpi_status | |
4be44fcd LB |
272 | acpi_ns_get_attached_data(struct acpi_namespace_node *node, |
273 | acpi_object_handler handler, void **data); | |
1da177e4 | 274 | |
b2deadd5 | 275 | /* |
ad5babee BM |
276 | * nsrepair - General return object repair for all |
277 | * predefined methods/objects | |
b2deadd5 BM |
278 | */ |
279 | acpi_status | |
280 | acpi_ns_repair_object(struct acpi_predefined_data *data, | |
281 | u32 expected_btypes, | |
282 | u32 package_index, | |
283 | union acpi_operand_object **return_object_ptr); | |
284 | ||
e5f69d6e BM |
285 | acpi_status |
286 | acpi_ns_repair_package_list(struct acpi_predefined_data *data, | |
287 | union acpi_operand_object **obj_desc_ptr); | |
288 | ||
091f4d71 BM |
289 | acpi_status |
290 | acpi_ns_repair_null_element(struct acpi_predefined_data *data, | |
291 | u32 expected_btypes, | |
292 | u32 package_index, | |
293 | union acpi_operand_object **return_object_ptr); | |
294 | ||
295 | void | |
296 | acpi_ns_remove_null_elements(struct acpi_predefined_data *data, | |
297 | u8 package_type, | |
298 | union acpi_operand_object *obj_desc); | |
299 | ||
ad5babee BM |
300 | /* |
301 | * nsrepair2 - Return object repair for specific | |
302 | * predefined methods/objects | |
303 | */ | |
304 | acpi_status | |
305 | acpi_ns_complex_repairs(struct acpi_predefined_data *data, | |
306 | struct acpi_namespace_node *node, | |
307 | acpi_status validate_status, | |
308 | union acpi_operand_object **return_object_ptr); | |
309 | ||
1da177e4 | 310 | /* |
44f6c012 | 311 | * nssearch - Namespace searching and entry |
1da177e4 | 312 | */ |
1da177e4 | 313 | acpi_status |
4be44fcd LB |
314 | acpi_ns_search_and_enter(u32 entry_name, |
315 | struct acpi_walk_state *walk_state, | |
316 | struct acpi_namespace_node *node, | |
317 | acpi_interpreter_mode interpreter_mode, | |
318 | acpi_object_type type, | |
319 | u32 flags, struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
320 | |
321 | acpi_status | |
4119532c BM |
322 | acpi_ns_search_one_scope(u32 entry_name, |
323 | struct acpi_namespace_node *node, | |
324 | acpi_object_type type, | |
325 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
326 | |
327 | void | |
4be44fcd LB |
328 | acpi_ns_install_node(struct acpi_walk_state *walk_state, |
329 | struct acpi_namespace_node *parent_node, | |
330 | struct acpi_namespace_node *node, acpi_object_type type); | |
1da177e4 LT |
331 | |
332 | /* | |
44f6c012 | 333 | * nsutils - Utility functions |
1da177e4 | 334 | */ |
4be44fcd | 335 | u8 acpi_ns_valid_root_prefix(char prefix); |
1da177e4 | 336 | |
4be44fcd | 337 | acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); |
1da177e4 | 338 | |
4be44fcd | 339 | u32 acpi_ns_local(acpi_object_type type); |
1da177e4 | 340 | |
4b8ed631 BM |
341 | void |
342 | acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); | |
1da177e4 | 343 | |
4be44fcd | 344 | acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); |
1da177e4 | 345 | |
4be44fcd | 346 | void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); |
1da177e4 | 347 | |
4b8ed631 BM |
348 | acpi_status |
349 | acpi_ns_internalize_name(const char *dotted_name, char **converted_name); | |
1da177e4 LT |
350 | |
351 | acpi_status | |
4be44fcd | 352 | acpi_ns_externalize_name(u32 internal_name_length, |
4b8ed631 | 353 | const char *internal_name, |
4be44fcd | 354 | u32 * converted_name_length, char **converted_name); |
1da177e4 | 355 | |
f24b664d | 356 | struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); |
1da177e4 | 357 | |
4be44fcd | 358 | void acpi_ns_terminate(void); |
1da177e4 | 359 | |
4be44fcd | 360 | #endif /* __ACNAMESP_H__ */ |