Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acnamesp.h - Namespace subcomponent prototypes and defines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
82a80941 | 8 | * Copyright (C) 2000 - 2015, 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, |
4ef17507 BM |
107 | acpi_walk_callback descending_callback, |
108 | acpi_walk_callback ascending_callback, | |
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 | 168 | |
76a6225b BM |
169 | /* |
170 | * nsconvert - Dynamic object conversion routines | |
171 | */ | |
172 | acpi_status | |
173 | acpi_ns_convert_to_integer(union acpi_operand_object *original_object, | |
174 | union acpi_operand_object **return_object); | |
175 | ||
176 | acpi_status | |
177 | acpi_ns_convert_to_string(union acpi_operand_object *original_object, | |
178 | union acpi_operand_object **return_object); | |
179 | ||
180 | acpi_status | |
181 | acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, | |
182 | union acpi_operand_object **return_object); | |
183 | ||
96b44cc6 LZ |
184 | acpi_status |
185 | acpi_ns_convert_to_unicode(union acpi_operand_object *original_object, | |
186 | union acpi_operand_object **return_object); | |
187 | ||
88fd0ac8 LZ |
188 | acpi_status |
189 | acpi_ns_convert_to_resource(union acpi_operand_object *original_object, | |
190 | union acpi_operand_object **return_object); | |
191 | ||
1da177e4 | 192 | /* |
44f6c012 | 193 | * nsdump - Namespace dump/print utilities |
1da177e4 | 194 | */ |
44f6c012 | 195 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd LB |
196 | void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); |
197 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 198 | |
4be44fcd | 199 | void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); |
1da177e4 LT |
200 | |
201 | void | |
4be44fcd | 202 | acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); |
1da177e4 | 203 | |
4be44fcd | 204 | void acpi_ns_print_pathname(u32 num_segments, char *pathname); |
1da177e4 | 205 | |
1da177e4 | 206 | acpi_status |
4be44fcd LB |
207 | acpi_ns_dump_one_object(acpi_handle obj_handle, |
208 | u32 level, void *context, void **return_value); | |
1da177e4 | 209 | |
44f6c012 | 210 | #ifdef ACPI_FUTURE_USAGE |
1da177e4 | 211 | void |
4be44fcd LB |
212 | acpi_ns_dump_objects(acpi_object_type type, |
213 | u8 display_type, | |
214 | u32 max_depth, | |
215 | acpi_owner_id owner_id, acpi_handle start_handle); | |
424deb38 BM |
216 | |
217 | void | |
218 | acpi_ns_dump_object_paths(acpi_object_type type, | |
219 | u8 display_type, | |
220 | u32 max_depth, | |
221 | acpi_owner_id owner_id, acpi_handle start_handle); | |
4be44fcd | 222 | #endif /* ACPI_FUTURE_USAGE */ |
1da177e4 LT |
223 | |
224 | /* | |
44f6c012 | 225 | * nseval - Namespace evaluation functions |
1da177e4 | 226 | */ |
4119532c | 227 | acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); |
1da177e4 | 228 | |
7f0c826a LM |
229 | void acpi_ns_exec_module_code_list(void); |
230 | ||
e8707b34 | 231 | /* |
29a241cc | 232 | * nsarguments - Argument count/type checking for predefined/reserved names |
e8707b34 | 233 | */ |
29a241cc BM |
234 | void |
235 | acpi_ns_check_argument_count(char *pathname, | |
236 | struct acpi_namespace_node *node, | |
237 | u32 user_param_count, | |
238 | const union acpi_predefined_info *info); | |
e8707b34 | 239 | |
e8707b34 | 240 | void |
29a241cc | 241 | acpi_ns_check_acpi_compliance(char *pathname, |
e8707b34 | 242 | struct acpi_namespace_node *node, |
29a241cc BM |
243 | const union acpi_predefined_info *predefined); |
244 | ||
245 | void acpi_ns_check_argument_types(struct acpi_evaluate_info *info); | |
246 | ||
247 | /* | |
248 | * nspredef - Return value checking for predefined/reserved names | |
249 | */ | |
250 | acpi_status | |
251 | acpi_ns_check_return_value(struct acpi_namespace_node *node, | |
252 | struct acpi_evaluate_info *info, | |
253 | u32 user_param_count, | |
254 | acpi_status return_status, | |
255 | union acpi_operand_object **return_object); | |
e8707b34 | 256 | |
42f8fb75 | 257 | acpi_status |
29a241cc | 258 | acpi_ns_check_object_type(struct acpi_evaluate_info *info, |
42f8fb75 BM |
259 | union acpi_operand_object **return_object_ptr, |
260 | u32 expected_btypes, u32 package_index); | |
261 | ||
262 | /* | |
263 | * nsprepkg - Validation of predefined name packages | |
264 | */ | |
265 | acpi_status | |
29a241cc | 266 | acpi_ns_check_package(struct acpi_evaluate_info *info, |
42f8fb75 BM |
267 | union acpi_operand_object **return_object_ptr); |
268 | ||
1da177e4 | 269 | /* |
44f6c012 | 270 | * nsnames - Name and Scope manipulation |
1da177e4 | 271 | */ |
4be44fcd | 272 | u32 acpi_ns_opens_scope(acpi_object_type type); |
1da177e4 | 273 | |
3c7db22a | 274 | acpi_status |
8313524a BM |
275 | acpi_ns_build_external_path(struct acpi_namespace_node *node, |
276 | acpi_size size, char *name_buffer); | |
277 | ||
4be44fcd | 278 | char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); |
1da177e4 | 279 | |
4be44fcd | 280 | char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); |
1da177e4 LT |
281 | |
282 | acpi_status | |
4be44fcd LB |
283 | acpi_ns_handle_to_pathname(acpi_handle target_handle, |
284 | struct acpi_buffer *buffer); | |
1da177e4 LT |
285 | |
286 | u8 | |
4be44fcd | 287 | acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); |
1da177e4 LT |
288 | |
289 | acpi_status | |
4119532c | 290 | acpi_ns_get_node(struct acpi_namespace_node *prefix_node, |
4b8ed631 | 291 | const char *external_pathname, |
4119532c | 292 | u32 flags, struct acpi_namespace_node **out_node); |
1da177e4 | 293 | |
4be44fcd | 294 | acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); |
1da177e4 LT |
295 | |
296 | /* | |
44f6c012 | 297 | * nsobject - Object management for namespace nodes |
1da177e4 | 298 | */ |
1da177e4 | 299 | acpi_status |
4be44fcd LB |
300 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
301 | union acpi_operand_object *object, acpi_object_type type); | |
1da177e4 | 302 | |
4be44fcd LB |
303 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
304 | acpi_namespace_node | |
305 | *node); | |
1da177e4 | 306 | |
4be44fcd LB |
307 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
308 | acpi_operand_object | |
309 | *obj_desc); | |
1da177e4 LT |
310 | |
311 | acpi_status | |
4be44fcd LB |
312 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
313 | acpi_object_handler handler, void *data); | |
1da177e4 LT |
314 | |
315 | acpi_status | |
4be44fcd LB |
316 | acpi_ns_detach_data(struct acpi_namespace_node *node, |
317 | acpi_object_handler handler); | |
1da177e4 LT |
318 | |
319 | acpi_status | |
4be44fcd LB |
320 | acpi_ns_get_attached_data(struct acpi_namespace_node *node, |
321 | acpi_object_handler handler, void **data); | |
1da177e4 | 322 | |
b2deadd5 | 323 | /* |
ad5babee BM |
324 | * nsrepair - General return object repair for all |
325 | * predefined methods/objects | |
b2deadd5 BM |
326 | */ |
327 | acpi_status | |
29a241cc | 328 | acpi_ns_simple_repair(struct acpi_evaluate_info *info, |
b2deadd5 BM |
329 | u32 expected_btypes, |
330 | u32 package_index, | |
331 | union acpi_operand_object **return_object_ptr); | |
332 | ||
e5f69d6e | 333 | acpi_status |
29a241cc | 334 | acpi_ns_wrap_with_package(struct acpi_evaluate_info *info, |
6a99b1c9 BM |
335 | union acpi_operand_object *original_object, |
336 | union acpi_operand_object **obj_desc_ptr); | |
e5f69d6e | 337 | |
091f4d71 | 338 | acpi_status |
29a241cc | 339 | acpi_ns_repair_null_element(struct acpi_evaluate_info *info, |
091f4d71 BM |
340 | u32 expected_btypes, |
341 | u32 package_index, | |
342 | union acpi_operand_object **return_object_ptr); | |
343 | ||
344 | void | |
29a241cc | 345 | acpi_ns_remove_null_elements(struct acpi_evaluate_info *info, |
091f4d71 BM |
346 | u8 package_type, |
347 | union acpi_operand_object *obj_desc); | |
348 | ||
ad5babee BM |
349 | /* |
350 | * nsrepair2 - Return object repair for specific | |
351 | * predefined methods/objects | |
352 | */ | |
353 | acpi_status | |
29a241cc | 354 | acpi_ns_complex_repairs(struct acpi_evaluate_info *info, |
ad5babee BM |
355 | struct acpi_namespace_node *node, |
356 | acpi_status validate_status, | |
357 | union acpi_operand_object **return_object_ptr); | |
358 | ||
1da177e4 | 359 | /* |
44f6c012 | 360 | * nssearch - Namespace searching and entry |
1da177e4 | 361 | */ |
1da177e4 | 362 | acpi_status |
4be44fcd LB |
363 | acpi_ns_search_and_enter(u32 entry_name, |
364 | struct acpi_walk_state *walk_state, | |
365 | struct acpi_namespace_node *node, | |
366 | acpi_interpreter_mode interpreter_mode, | |
367 | acpi_object_type type, | |
368 | u32 flags, struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
369 | |
370 | acpi_status | |
4119532c BM |
371 | acpi_ns_search_one_scope(u32 entry_name, |
372 | struct acpi_namespace_node *node, | |
373 | acpi_object_type type, | |
374 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
375 | |
376 | void | |
4be44fcd LB |
377 | acpi_ns_install_node(struct acpi_walk_state *walk_state, |
378 | struct acpi_namespace_node *parent_node, | |
379 | struct acpi_namespace_node *node, acpi_object_type type); | |
1da177e4 LT |
380 | |
381 | /* | |
44f6c012 | 382 | * nsutils - Utility functions |
1da177e4 | 383 | */ |
4be44fcd | 384 | acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); |
1da177e4 | 385 | |
4be44fcd | 386 | u32 acpi_ns_local(acpi_object_type type); |
1da177e4 | 387 | |
4b8ed631 BM |
388 | void |
389 | acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); | |
1da177e4 | 390 | |
4be44fcd | 391 | acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); |
1da177e4 | 392 | |
4be44fcd | 393 | void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); |
1da177e4 | 394 | |
4b8ed631 BM |
395 | acpi_status |
396 | acpi_ns_internalize_name(const char *dotted_name, char **converted_name); | |
1da177e4 LT |
397 | |
398 | acpi_status | |
4be44fcd | 399 | acpi_ns_externalize_name(u32 internal_name_length, |
4b8ed631 | 400 | const char *internal_name, |
4be44fcd | 401 | u32 * converted_name_length, char **converted_name); |
1da177e4 | 402 | |
f24b664d | 403 | struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); |
1da177e4 | 404 | |
4be44fcd | 405 | void acpi_ns_terminate(void); |
1da177e4 | 406 | |
4be44fcd | 407 | #endif /* __ACNAMESP_H__ */ |