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 |
8f6f0361 | 69 | #define ACPI_NS_OVERRIDE_IF_FOUND 0x80 |
1da177e4 | 70 | |
d1fdda83 BM |
71 | /* Flags for acpi_ns_walk_namespace */ |
72 | ||
73 | #define ACPI_NS_WALK_NO_UNLOCK 0 | |
74 | #define ACPI_NS_WALK_UNLOCK 0x01 | |
75 | #define ACPI_NS_WALK_TEMP_NODES 0x02 | |
1da177e4 | 76 | |
b2deadd5 BM |
77 | /* Object is not a package element */ |
78 | ||
79 | #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX | |
80 | ||
81 | /* Always emit warning message, not dependent on node flags */ | |
82 | ||
83 | #define ACPI_WARN_ALWAYS 0 | |
84 | ||
44f6c012 RM |
85 | /* |
86 | * nsinit - Namespace initialization | |
87 | */ | |
4be44fcd | 88 | acpi_status acpi_ns_initialize_objects(void); |
1da177e4 | 89 | |
4be44fcd | 90 | acpi_status acpi_ns_initialize_devices(void); |
1da177e4 | 91 | |
44f6c012 RM |
92 | /* |
93 | * nsload - Namespace loading | |
94 | */ | |
4be44fcd | 95 | acpi_status acpi_ns_load_namespace(void); |
1da177e4 LT |
96 | |
97 | acpi_status | |
67a119f9 | 98 | acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); |
1da177e4 | 99 | |
44f6c012 RM |
100 | /* |
101 | * nswalk - walk the namespace | |
102 | */ | |
1da177e4 | 103 | acpi_status |
4be44fcd LB |
104 | acpi_ns_walk_namespace(acpi_object_type type, |
105 | acpi_handle start_object, | |
106 | u32 max_depth, | |
d1fdda83 | 107 | u32 flags, |
4ef17507 BM |
108 | acpi_walk_callback descending_callback, |
109 | acpi_walk_callback ascending_callback, | |
4be44fcd LB |
110 | void *context, void **return_value); |
111 | ||
8c725bf9 BM |
112 | struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node |
113 | *parent, | |
114 | struct acpi_namespace_node | |
4be44fcd | 115 | *child); |
1da177e4 | 116 | |
8c725bf9 BM |
117 | struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, |
118 | struct | |
119 | acpi_namespace_node | |
120 | *parent, | |
121 | struct | |
122 | acpi_namespace_node | |
123 | *child); | |
124 | ||
44f6c012 RM |
125 | /* |
126 | * nsparse - table parsing | |
127 | */ | |
1da177e4 | 128 | acpi_status |
67a119f9 | 129 | acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); |
1da177e4 LT |
130 | |
131 | acpi_status | |
67a119f9 BM |
132 | acpi_ns_one_complete_parse(u32 pass_number, |
133 | u32 table_index, | |
7f4ac9f9 | 134 | struct acpi_namespace_node *start_node); |
1da177e4 LT |
135 | |
136 | /* | |
44f6c012 | 137 | * nsaccess - Top-level namespace access |
1da177e4 | 138 | */ |
4be44fcd | 139 | acpi_status acpi_ns_root_initialize(void); |
1da177e4 LT |
140 | |
141 | acpi_status | |
4be44fcd LB |
142 | acpi_ns_lookup(union acpi_generic_state *scope_info, |
143 | char *name, | |
144 | acpi_object_type type, | |
145 | acpi_interpreter_mode interpreter_mode, | |
146 | u32 flags, | |
147 | struct acpi_walk_state *walk_state, | |
148 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
149 | |
150 | /* | |
44f6c012 | 151 | * nsalloc - Named object allocation/deallocation |
1da177e4 | 152 | */ |
4be44fcd | 153 | struct acpi_namespace_node *acpi_ns_create_node(u32 name); |
1da177e4 | 154 | |
4be44fcd | 155 | void acpi_ns_delete_node(struct acpi_namespace_node *node); |
1da177e4 | 156 | |
8e4319c4 BM |
157 | void acpi_ns_remove_node(struct acpi_namespace_node *node); |
158 | ||
44f6c012 | 159 | void |
4be44fcd | 160 | acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); |
44f6c012 | 161 | |
4be44fcd | 162 | void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); |
1da177e4 | 163 | |
4be44fcd | 164 | void acpi_ns_detach_object(struct acpi_namespace_node *node); |
1da177e4 | 165 | |
4be44fcd | 166 | void acpi_ns_delete_children(struct acpi_namespace_node *parent); |
1da177e4 | 167 | |
4be44fcd | 168 | int acpi_ns_compare_names(char *name1, char *name2); |
1da177e4 | 169 | |
76a6225b BM |
170 | /* |
171 | * nsconvert - Dynamic object conversion routines | |
172 | */ | |
173 | acpi_status | |
174 | acpi_ns_convert_to_integer(union acpi_operand_object *original_object, | |
175 | union acpi_operand_object **return_object); | |
176 | ||
177 | acpi_status | |
178 | acpi_ns_convert_to_string(union acpi_operand_object *original_object, | |
179 | union acpi_operand_object **return_object); | |
180 | ||
181 | acpi_status | |
182 | acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, | |
183 | union acpi_operand_object **return_object); | |
184 | ||
96b44cc6 LZ |
185 | acpi_status |
186 | acpi_ns_convert_to_unicode(union acpi_operand_object *original_object, | |
187 | union acpi_operand_object **return_object); | |
188 | ||
88fd0ac8 LZ |
189 | acpi_status |
190 | acpi_ns_convert_to_resource(union acpi_operand_object *original_object, | |
191 | union acpi_operand_object **return_object); | |
192 | ||
1da177e4 | 193 | /* |
44f6c012 | 194 | * nsdump - Namespace dump/print utilities |
1da177e4 | 195 | */ |
4be44fcd | 196 | void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); |
1da177e4 | 197 | |
4be44fcd | 198 | void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); |
1da177e4 LT |
199 | |
200 | void | |
4be44fcd | 201 | acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); |
1da177e4 | 202 | |
4be44fcd | 203 | void acpi_ns_print_pathname(u32 num_segments, char *pathname); |
1da177e4 | 204 | |
1da177e4 | 205 | acpi_status |
4be44fcd LB |
206 | acpi_ns_dump_one_object(acpi_handle obj_handle, |
207 | u32 level, void *context, void **return_value); | |
1da177e4 | 208 | |
1da177e4 | 209 | void |
4be44fcd LB |
210 | acpi_ns_dump_objects(acpi_object_type type, |
211 | u8 display_type, | |
212 | u32 max_depth, | |
213 | acpi_owner_id owner_id, acpi_handle start_handle); | |
424deb38 BM |
214 | |
215 | void | |
216 | acpi_ns_dump_object_paths(acpi_object_type type, | |
217 | u8 display_type, | |
218 | u32 max_depth, | |
219 | acpi_owner_id owner_id, acpi_handle start_handle); | |
1da177e4 LT |
220 | |
221 | /* | |
44f6c012 | 222 | * nseval - Namespace evaluation functions |
1da177e4 | 223 | */ |
4119532c | 224 | acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); |
1da177e4 | 225 | |
7f0c826a LM |
226 | void acpi_ns_exec_module_code_list(void); |
227 | ||
e8707b34 | 228 | /* |
29a241cc | 229 | * nsarguments - Argument count/type checking for predefined/reserved names |
e8707b34 | 230 | */ |
29a241cc BM |
231 | void |
232 | acpi_ns_check_argument_count(char *pathname, | |
233 | struct acpi_namespace_node *node, | |
234 | u32 user_param_count, | |
235 | const union acpi_predefined_info *info); | |
e8707b34 | 236 | |
e8707b34 | 237 | void |
29a241cc | 238 | acpi_ns_check_acpi_compliance(char *pathname, |
e8707b34 | 239 | struct acpi_namespace_node *node, |
29a241cc BM |
240 | const union acpi_predefined_info *predefined); |
241 | ||
242 | void acpi_ns_check_argument_types(struct acpi_evaluate_info *info); | |
243 | ||
244 | /* | |
245 | * nspredef - Return value checking for predefined/reserved names | |
246 | */ | |
247 | acpi_status | |
248 | acpi_ns_check_return_value(struct acpi_namespace_node *node, | |
249 | struct acpi_evaluate_info *info, | |
250 | u32 user_param_count, | |
251 | acpi_status return_status, | |
252 | union acpi_operand_object **return_object); | |
e8707b34 | 253 | |
42f8fb75 | 254 | acpi_status |
29a241cc | 255 | acpi_ns_check_object_type(struct acpi_evaluate_info *info, |
42f8fb75 BM |
256 | union acpi_operand_object **return_object_ptr, |
257 | u32 expected_btypes, u32 package_index); | |
258 | ||
259 | /* | |
260 | * nsprepkg - Validation of predefined name packages | |
261 | */ | |
262 | acpi_status | |
29a241cc | 263 | acpi_ns_check_package(struct acpi_evaluate_info *info, |
42f8fb75 BM |
264 | union acpi_operand_object **return_object_ptr); |
265 | ||
1da177e4 | 266 | /* |
44f6c012 | 267 | * nsnames - Name and Scope manipulation |
1da177e4 | 268 | */ |
4be44fcd | 269 | u32 acpi_ns_opens_scope(acpi_object_type type); |
1da177e4 | 270 | |
4be44fcd | 271 | char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); |
1da177e4 | 272 | |
d1e7ffe5 LZ |
273 | u32 |
274 | acpi_ns_build_normalized_path(struct acpi_namespace_node *node, | |
275 | char *full_path, u32 path_size, u8 no_trailing); | |
276 | ||
277 | char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node, | |
278 | u8 no_trailing); | |
279 | ||
4be44fcd | 280 | char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); |
1da177e4 LT |
281 | |
282 | acpi_status | |
4be44fcd | 283 | acpi_ns_handle_to_pathname(acpi_handle target_handle, |
d1e7ffe5 | 284 | struct acpi_buffer *buffer, u8 no_trailing); |
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__ */ |