Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acnamesp.h - Namespace subcomponent prototypes and defines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
c8100dc4 | 8 | * Copyright (C) 2000 - 2016, 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 | |
ee387409 | 80 | #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1) |
b2deadd5 BM |
81 | |
82 | /* Always emit warning message, not dependent on node flags */ | |
83 | ||
84 | #define ACPI_WARN_ALWAYS 0 | |
85 | ||
44f6c012 RM |
86 | /* |
87 | * nsinit - Namespace initialization | |
88 | */ | |
4be44fcd | 89 | acpi_status acpi_ns_initialize_objects(void); |
1da177e4 | 90 | |
ced04366 | 91 | acpi_status acpi_ns_initialize_devices(u32 flags); |
1da177e4 | 92 | |
44f6c012 RM |
93 | /* |
94 | * nsload - Namespace loading | |
95 | */ | |
4be44fcd | 96 | acpi_status acpi_ns_load_namespace(void); |
1da177e4 LT |
97 | |
98 | acpi_status | |
67a119f9 | 99 | acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); |
1da177e4 | 100 | |
44f6c012 RM |
101 | /* |
102 | * nswalk - walk the namespace | |
103 | */ | |
1da177e4 | 104 | acpi_status |
4be44fcd LB |
105 | acpi_ns_walk_namespace(acpi_object_type type, |
106 | acpi_handle start_object, | |
107 | u32 max_depth, | |
d1fdda83 | 108 | u32 flags, |
4ef17507 BM |
109 | acpi_walk_callback descending_callback, |
110 | acpi_walk_callback ascending_callback, | |
4be44fcd LB |
111 | void *context, void **return_value); |
112 | ||
8c725bf9 BM |
113 | struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node |
114 | *parent, | |
115 | struct acpi_namespace_node | |
4be44fcd | 116 | *child); |
1da177e4 | 117 | |
8c725bf9 BM |
118 | struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, |
119 | struct | |
120 | acpi_namespace_node | |
121 | *parent, | |
122 | struct | |
123 | acpi_namespace_node | |
124 | *child); | |
125 | ||
44f6c012 RM |
126 | /* |
127 | * nsparse - table parsing | |
128 | */ | |
1da177e4 | 129 | acpi_status |
67a119f9 | 130 | acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); |
1da177e4 LT |
131 | |
132 | acpi_status | |
67a119f9 BM |
133 | acpi_ns_one_complete_parse(u32 pass_number, |
134 | u32 table_index, | |
7f4ac9f9 | 135 | struct acpi_namespace_node *start_node); |
1da177e4 LT |
136 | |
137 | /* | |
44f6c012 | 138 | * nsaccess - Top-level namespace access |
1da177e4 | 139 | */ |
4be44fcd | 140 | acpi_status acpi_ns_root_initialize(void); |
1da177e4 LT |
141 | |
142 | acpi_status | |
4be44fcd LB |
143 | acpi_ns_lookup(union acpi_generic_state *scope_info, |
144 | char *name, | |
145 | acpi_object_type type, | |
146 | acpi_interpreter_mode interpreter_mode, | |
147 | u32 flags, | |
148 | struct acpi_walk_state *walk_state, | |
149 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
150 | |
151 | /* | |
44f6c012 | 152 | * nsalloc - Named object allocation/deallocation |
1da177e4 | 153 | */ |
4be44fcd | 154 | struct acpi_namespace_node *acpi_ns_create_node(u32 name); |
1da177e4 | 155 | |
4be44fcd | 156 | void acpi_ns_delete_node(struct acpi_namespace_node *node); |
1da177e4 | 157 | |
8e4319c4 BM |
158 | void acpi_ns_remove_node(struct acpi_namespace_node *node); |
159 | ||
44f6c012 | 160 | void |
4be44fcd | 161 | acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); |
44f6c012 | 162 | |
4be44fcd | 163 | void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); |
1da177e4 | 164 | |
4be44fcd | 165 | void acpi_ns_detach_object(struct acpi_namespace_node *node); |
1da177e4 | 166 | |
4be44fcd | 167 | void acpi_ns_delete_children(struct acpi_namespace_node *parent); |
1da177e4 | 168 | |
4be44fcd | 169 | int acpi_ns_compare_names(char *name1, char *name2); |
1da177e4 | 170 | |
76a6225b BM |
171 | /* |
172 | * nsconvert - Dynamic object conversion routines | |
173 | */ | |
174 | acpi_status | |
175 | acpi_ns_convert_to_integer(union acpi_operand_object *original_object, | |
176 | union acpi_operand_object **return_object); | |
177 | ||
178 | acpi_status | |
179 | acpi_ns_convert_to_string(union acpi_operand_object *original_object, | |
180 | union acpi_operand_object **return_object); | |
181 | ||
182 | acpi_status | |
183 | acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, | |
184 | union acpi_operand_object **return_object); | |
185 | ||
96b44cc6 | 186 | acpi_status |
4debda53 LZ |
187 | acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope, |
188 | union acpi_operand_object *original_object, | |
96b44cc6 LZ |
189 | union acpi_operand_object **return_object); |
190 | ||
88fd0ac8 | 191 | acpi_status |
4debda53 LZ |
192 | acpi_ns_convert_to_resource(struct acpi_namespace_node *scope, |
193 | union acpi_operand_object *original_object, | |
88fd0ac8 LZ |
194 | union acpi_operand_object **return_object); |
195 | ||
ee387409 LZ |
196 | acpi_status |
197 | acpi_ns_convert_to_reference(struct acpi_namespace_node *scope, | |
198 | union acpi_operand_object *original_object, | |
199 | union acpi_operand_object **return_object); | |
200 | ||
1da177e4 | 201 | /* |
44f6c012 | 202 | * nsdump - Namespace dump/print utilities |
1da177e4 | 203 | */ |
4be44fcd | 204 | void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); |
1da177e4 | 205 | |
4be44fcd | 206 | void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); |
1da177e4 LT |
207 | |
208 | void | |
0dfaaa3d BM |
209 | acpi_ns_dump_pathname(acpi_handle handle, |
210 | const char *msg, u32 level, u32 component); | |
1da177e4 | 211 | |
0dfaaa3d | 212 | void acpi_ns_print_pathname(u32 num_segments, const char *pathname); |
1da177e4 | 213 | |
1da177e4 | 214 | acpi_status |
4be44fcd LB |
215 | acpi_ns_dump_one_object(acpi_handle obj_handle, |
216 | u32 level, void *context, void **return_value); | |
1da177e4 | 217 | |
1da177e4 | 218 | void |
4be44fcd LB |
219 | acpi_ns_dump_objects(acpi_object_type type, |
220 | u8 display_type, | |
221 | u32 max_depth, | |
222 | acpi_owner_id owner_id, acpi_handle start_handle); | |
424deb38 BM |
223 | |
224 | void | |
225 | acpi_ns_dump_object_paths(acpi_object_type type, | |
226 | u8 display_type, | |
227 | u32 max_depth, | |
228 | acpi_owner_id owner_id, acpi_handle start_handle); | |
1da177e4 LT |
229 | |
230 | /* | |
44f6c012 | 231 | * nseval - Namespace evaluation functions |
1da177e4 | 232 | */ |
4119532c | 233 | acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); |
1da177e4 | 234 | |
7f0c826a LM |
235 | void acpi_ns_exec_module_code_list(void); |
236 | ||
e8707b34 | 237 | /* |
29a241cc | 238 | * nsarguments - Argument count/type checking for predefined/reserved names |
e8707b34 | 239 | */ |
29a241cc BM |
240 | void |
241 | acpi_ns_check_argument_count(char *pathname, | |
242 | struct acpi_namespace_node *node, | |
243 | u32 user_param_count, | |
244 | const union acpi_predefined_info *info); | |
e8707b34 | 245 | |
e8707b34 | 246 | void |
29a241cc | 247 | acpi_ns_check_acpi_compliance(char *pathname, |
e8707b34 | 248 | struct acpi_namespace_node *node, |
29a241cc BM |
249 | const union acpi_predefined_info *predefined); |
250 | ||
251 | void acpi_ns_check_argument_types(struct acpi_evaluate_info *info); | |
252 | ||
253 | /* | |
254 | * nspredef - Return value checking for predefined/reserved names | |
255 | */ | |
256 | acpi_status | |
257 | acpi_ns_check_return_value(struct acpi_namespace_node *node, | |
258 | struct acpi_evaluate_info *info, | |
259 | u32 user_param_count, | |
260 | acpi_status return_status, | |
261 | union acpi_operand_object **return_object); | |
e8707b34 | 262 | |
42f8fb75 | 263 | acpi_status |
29a241cc | 264 | acpi_ns_check_object_type(struct acpi_evaluate_info *info, |
42f8fb75 BM |
265 | union acpi_operand_object **return_object_ptr, |
266 | u32 expected_btypes, u32 package_index); | |
267 | ||
268 | /* | |
269 | * nsprepkg - Validation of predefined name packages | |
270 | */ | |
271 | acpi_status | |
29a241cc | 272 | acpi_ns_check_package(struct acpi_evaluate_info *info, |
42f8fb75 BM |
273 | union acpi_operand_object **return_object_ptr); |
274 | ||
1da177e4 | 275 | /* |
44f6c012 | 276 | * nsnames - Name and Scope manipulation |
1da177e4 | 277 | */ |
4be44fcd | 278 | u32 acpi_ns_opens_scope(acpi_object_type type); |
1da177e4 | 279 | |
4be44fcd | 280 | char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); |
1da177e4 | 281 | |
d1e7ffe5 LZ |
282 | u32 |
283 | acpi_ns_build_normalized_path(struct acpi_namespace_node *node, | |
284 | char *full_path, u32 path_size, u8 no_trailing); | |
285 | ||
286 | char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node, | |
287 | u8 no_trailing); | |
288 | ||
4be44fcd | 289 | char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); |
1da177e4 LT |
290 | |
291 | acpi_status | |
4be44fcd | 292 | acpi_ns_handle_to_pathname(acpi_handle target_handle, |
d1e7ffe5 | 293 | struct acpi_buffer *buffer, u8 no_trailing); |
1da177e4 LT |
294 | |
295 | u8 | |
4be44fcd | 296 | acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); |
1da177e4 LT |
297 | |
298 | acpi_status | |
4119532c | 299 | acpi_ns_get_node(struct acpi_namespace_node *prefix_node, |
4b8ed631 | 300 | const char *external_pathname, |
4119532c | 301 | u32 flags, struct acpi_namespace_node **out_node); |
1da177e4 | 302 | |
4be44fcd | 303 | acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); |
1da177e4 LT |
304 | |
305 | /* | |
44f6c012 | 306 | * nsobject - Object management for namespace nodes |
1da177e4 | 307 | */ |
1da177e4 | 308 | acpi_status |
4be44fcd LB |
309 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
310 | union acpi_operand_object *object, acpi_object_type type); | |
1da177e4 | 311 | |
4be44fcd LB |
312 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
313 | acpi_namespace_node | |
314 | *node); | |
1da177e4 | 315 | |
4be44fcd LB |
316 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
317 | acpi_operand_object | |
318 | *obj_desc); | |
1da177e4 LT |
319 | |
320 | acpi_status | |
4be44fcd LB |
321 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
322 | acpi_object_handler handler, void *data); | |
1da177e4 LT |
323 | |
324 | acpi_status | |
4be44fcd LB |
325 | acpi_ns_detach_data(struct acpi_namespace_node *node, |
326 | acpi_object_handler handler); | |
1da177e4 LT |
327 | |
328 | acpi_status | |
4be44fcd LB |
329 | acpi_ns_get_attached_data(struct acpi_namespace_node *node, |
330 | acpi_object_handler handler, void **data); | |
1da177e4 | 331 | |
b2deadd5 | 332 | /* |
ad5babee BM |
333 | * nsrepair - General return object repair for all |
334 | * predefined methods/objects | |
b2deadd5 BM |
335 | */ |
336 | acpi_status | |
29a241cc | 337 | acpi_ns_simple_repair(struct acpi_evaluate_info *info, |
b2deadd5 BM |
338 | u32 expected_btypes, |
339 | u32 package_index, | |
340 | union acpi_operand_object **return_object_ptr); | |
341 | ||
e5f69d6e | 342 | acpi_status |
29a241cc | 343 | acpi_ns_wrap_with_package(struct acpi_evaluate_info *info, |
6a99b1c9 BM |
344 | union acpi_operand_object *original_object, |
345 | union acpi_operand_object **obj_desc_ptr); | |
e5f69d6e | 346 | |
091f4d71 | 347 | acpi_status |
29a241cc | 348 | acpi_ns_repair_null_element(struct acpi_evaluate_info *info, |
091f4d71 BM |
349 | u32 expected_btypes, |
350 | u32 package_index, | |
351 | union acpi_operand_object **return_object_ptr); | |
352 | ||
353 | void | |
29a241cc | 354 | acpi_ns_remove_null_elements(struct acpi_evaluate_info *info, |
091f4d71 BM |
355 | u8 package_type, |
356 | union acpi_operand_object *obj_desc); | |
357 | ||
ad5babee BM |
358 | /* |
359 | * nsrepair2 - Return object repair for specific | |
360 | * predefined methods/objects | |
361 | */ | |
362 | acpi_status | |
29a241cc | 363 | acpi_ns_complex_repairs(struct acpi_evaluate_info *info, |
ad5babee BM |
364 | struct acpi_namespace_node *node, |
365 | acpi_status validate_status, | |
366 | union acpi_operand_object **return_object_ptr); | |
367 | ||
1da177e4 | 368 | /* |
44f6c012 | 369 | * nssearch - Namespace searching and entry |
1da177e4 | 370 | */ |
1da177e4 | 371 | acpi_status |
4be44fcd LB |
372 | acpi_ns_search_and_enter(u32 entry_name, |
373 | struct acpi_walk_state *walk_state, | |
374 | struct acpi_namespace_node *node, | |
375 | acpi_interpreter_mode interpreter_mode, | |
376 | acpi_object_type type, | |
377 | u32 flags, struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
378 | |
379 | acpi_status | |
4119532c BM |
380 | acpi_ns_search_one_scope(u32 entry_name, |
381 | struct acpi_namespace_node *node, | |
382 | acpi_object_type type, | |
383 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
384 | |
385 | void | |
4be44fcd LB |
386 | acpi_ns_install_node(struct acpi_walk_state *walk_state, |
387 | struct acpi_namespace_node *parent_node, | |
388 | struct acpi_namespace_node *node, acpi_object_type type); | |
1da177e4 LT |
389 | |
390 | /* | |
44f6c012 | 391 | * nsutils - Utility functions |
1da177e4 | 392 | */ |
4be44fcd | 393 | acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); |
1da177e4 | 394 | |
4be44fcd | 395 | u32 acpi_ns_local(acpi_object_type type); |
1da177e4 | 396 | |
4b8ed631 BM |
397 | void |
398 | acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); | |
1da177e4 | 399 | |
4be44fcd | 400 | acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); |
1da177e4 | 401 | |
4be44fcd | 402 | void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); |
1da177e4 | 403 | |
4b8ed631 BM |
404 | acpi_status |
405 | acpi_ns_internalize_name(const char *dotted_name, char **converted_name); | |
1da177e4 LT |
406 | |
407 | acpi_status | |
4be44fcd | 408 | acpi_ns_externalize_name(u32 internal_name_length, |
4b8ed631 | 409 | const char *internal_name, |
4be44fcd | 410 | u32 * converted_name_length, char **converted_name); |
1da177e4 | 411 | |
f24b664d | 412 | struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); |
1da177e4 | 413 | |
4be44fcd | 414 | void acpi_ns_terminate(void); |
1da177e4 | 415 | |
4be44fcd | 416 | #endif /* __ACNAMESP_H__ */ |