]>
Commit | Line | Data |
---|---|---|
95857638 | 1 | /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ |
1da177e4 LT |
2 | /****************************************************************************** |
3 | * | |
4 | * Name: acnamesp.h - Namespace subcomponent prototypes and defines | |
5 | * | |
800ba7c5 | 6 | * Copyright (C) 2000 - 2020, Intel Corp. |
1da177e4 | 7 | * |
95857638 | 8 | *****************************************************************************/ |
1da177e4 LT |
9 | |
10 | #ifndef __ACNAMESP_H__ | |
11 | #define __ACNAMESP_H__ | |
12 | ||
1da177e4 LT |
13 | /* To search the entire name space, pass this as search_base */ |
14 | ||
15 | #define ACPI_NS_ALL ((acpi_handle)0) | |
16 | ||
17 | /* | |
18 | * Elements of acpi_ns_properties are bit significant | |
19 | * and should be one-to-one with values of acpi_object_type | |
20 | */ | |
21 | #define ACPI_NS_NORMAL 0 | |
4be44fcd LB |
22 | #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */ |
23 | #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */ | |
1da177e4 | 24 | |
1da177e4 LT |
25 | /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */ |
26 | ||
27 | #define ACPI_NS_NO_UPSEARCH 0 | |
77d4e096 EK |
28 | #define ACPI_NS_SEARCH_PARENT 0x0001 |
29 | #define ACPI_NS_DONT_OPEN_SCOPE 0x0002 | |
30 | #define ACPI_NS_NO_PEER_SEARCH 0x0004 | |
31 | #define ACPI_NS_ERROR_IF_FOUND 0x0008 | |
32 | #define ACPI_NS_PREFIX_IS_SCOPE 0x0010 | |
33 | #define ACPI_NS_EXTERNAL 0x0020 | |
34 | #define ACPI_NS_TEMPORARY 0x0040 | |
35 | #define ACPI_NS_OVERRIDE_IF_FOUND 0x0080 | |
36 | #define ACPI_NS_EARLY_INIT 0x0100 | |
927a6abf | 37 | #define ACPI_NS_PREFIX_MUST_EXIST 0x0200 |
1da177e4 | 38 | |
d1fdda83 BM |
39 | /* Flags for acpi_ns_walk_namespace */ |
40 | ||
41 | #define ACPI_NS_WALK_NO_UNLOCK 0 | |
42 | #define ACPI_NS_WALK_UNLOCK 0x01 | |
43 | #define ACPI_NS_WALK_TEMP_NODES 0x02 | |
1da177e4 | 44 | |
b2deadd5 BM |
45 | /* Object is not a package element */ |
46 | ||
47 | #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX | |
ee387409 | 48 | #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1) |
b2deadd5 BM |
49 | |
50 | /* Always emit warning message, not dependent on node flags */ | |
51 | ||
52 | #define ACPI_WARN_ALWAYS 0 | |
53 | ||
44f6c012 RM |
54 | /* |
55 | * nsinit - Namespace initialization | |
56 | */ | |
4be44fcd | 57 | acpi_status acpi_ns_initialize_objects(void); |
1da177e4 | 58 | |
ced04366 | 59 | acpi_status acpi_ns_initialize_devices(u32 flags); |
1da177e4 | 60 | |
7b34c0fb BM |
61 | acpi_status |
62 | acpi_ns_init_one_package(acpi_handle obj_handle, | |
63 | u32 level, void *context, void **return_value); | |
64 | ||
44f6c012 RM |
65 | /* |
66 | * nsload - Namespace loading | |
67 | */ | |
4be44fcd | 68 | acpi_status acpi_ns_load_namespace(void); |
1da177e4 LT |
69 | |
70 | acpi_status | |
67a119f9 | 71 | acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); |
1da177e4 | 72 | |
44f6c012 RM |
73 | /* |
74 | * nswalk - walk the namespace | |
75 | */ | |
1da177e4 | 76 | acpi_status |
4be44fcd LB |
77 | acpi_ns_walk_namespace(acpi_object_type type, |
78 | acpi_handle start_object, | |
79 | u32 max_depth, | |
d1fdda83 | 80 | u32 flags, |
4ef17507 BM |
81 | acpi_walk_callback descending_callback, |
82 | acpi_walk_callback ascending_callback, | |
4be44fcd LB |
83 | void *context, void **return_value); |
84 | ||
8c725bf9 BM |
85 | struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node |
86 | *parent, | |
87 | struct acpi_namespace_node | |
4be44fcd | 88 | *child); |
1da177e4 | 89 | |
8c725bf9 BM |
90 | struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, |
91 | struct | |
92 | acpi_namespace_node | |
93 | *parent, | |
94 | struct | |
95 | acpi_namespace_node | |
96 | *child); | |
97 | ||
44f6c012 RM |
98 | /* |
99 | * nsparse - table parsing | |
100 | */ | |
1da177e4 | 101 | acpi_status |
67a119f9 | 102 | acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); |
1da177e4 | 103 | |
de56ba95 LZ |
104 | acpi_status |
105 | acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node); | |
106 | ||
1da177e4 | 107 | acpi_status |
67a119f9 BM |
108 | acpi_ns_one_complete_parse(u32 pass_number, |
109 | u32 table_index, | |
7f4ac9f9 | 110 | struct acpi_namespace_node *start_node); |
1da177e4 LT |
111 | |
112 | /* | |
44f6c012 | 113 | * nsaccess - Top-level namespace access |
1da177e4 | 114 | */ |
4be44fcd | 115 | acpi_status acpi_ns_root_initialize(void); |
1da177e4 LT |
116 | |
117 | acpi_status | |
4be44fcd LB |
118 | acpi_ns_lookup(union acpi_generic_state *scope_info, |
119 | char *name, | |
120 | acpi_object_type type, | |
121 | acpi_interpreter_mode interpreter_mode, | |
122 | u32 flags, | |
123 | struct acpi_walk_state *walk_state, | |
124 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
125 | |
126 | /* | |
44f6c012 | 127 | * nsalloc - Named object allocation/deallocation |
1da177e4 | 128 | */ |
4be44fcd | 129 | struct acpi_namespace_node *acpi_ns_create_node(u32 name); |
1da177e4 | 130 | |
4be44fcd | 131 | void acpi_ns_delete_node(struct acpi_namespace_node *node); |
1da177e4 | 132 | |
8e4319c4 BM |
133 | void acpi_ns_remove_node(struct acpi_namespace_node *node); |
134 | ||
44f6c012 | 135 | void |
4be44fcd | 136 | acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); |
44f6c012 | 137 | |
4be44fcd | 138 | void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); |
1da177e4 | 139 | |
4be44fcd | 140 | void acpi_ns_detach_object(struct acpi_namespace_node *node); |
1da177e4 | 141 | |
4be44fcd | 142 | void acpi_ns_delete_children(struct acpi_namespace_node *parent); |
1da177e4 | 143 | |
4be44fcd | 144 | int acpi_ns_compare_names(char *name1, char *name2); |
1da177e4 | 145 | |
76a6225b BM |
146 | /* |
147 | * nsconvert - Dynamic object conversion routines | |
148 | */ | |
149 | acpi_status | |
150 | acpi_ns_convert_to_integer(union acpi_operand_object *original_object, | |
151 | union acpi_operand_object **return_object); | |
152 | ||
153 | acpi_status | |
154 | acpi_ns_convert_to_string(union acpi_operand_object *original_object, | |
155 | union acpi_operand_object **return_object); | |
156 | ||
157 | acpi_status | |
158 | acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, | |
159 | union acpi_operand_object **return_object); | |
160 | ||
96b44cc6 | 161 | acpi_status |
4debda53 LZ |
162 | acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope, |
163 | union acpi_operand_object *original_object, | |
96b44cc6 LZ |
164 | union acpi_operand_object **return_object); |
165 | ||
88fd0ac8 | 166 | acpi_status |
4debda53 LZ |
167 | acpi_ns_convert_to_resource(struct acpi_namespace_node *scope, |
168 | union acpi_operand_object *original_object, | |
88fd0ac8 LZ |
169 | union acpi_operand_object **return_object); |
170 | ||
ee387409 LZ |
171 | acpi_status |
172 | acpi_ns_convert_to_reference(struct acpi_namespace_node *scope, | |
173 | union acpi_operand_object *original_object, | |
174 | union acpi_operand_object **return_object); | |
175 | ||
1da177e4 | 176 | /* |
44f6c012 | 177 | * nsdump - Namespace dump/print utilities |
1da177e4 | 178 | */ |
4be44fcd | 179 | void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); |
1da177e4 | 180 | |
4be44fcd | 181 | void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); |
1da177e4 LT |
182 | |
183 | void | |
0dfaaa3d BM |
184 | acpi_ns_dump_pathname(acpi_handle handle, |
185 | const char *msg, u32 level, u32 component); | |
1da177e4 | 186 | |
0dfaaa3d | 187 | void acpi_ns_print_pathname(u32 num_segments, const char *pathname); |
1da177e4 | 188 | |
1da177e4 | 189 | acpi_status |
4be44fcd LB |
190 | acpi_ns_dump_one_object(acpi_handle obj_handle, |
191 | u32 level, void *context, void **return_value); | |
1da177e4 | 192 | |
1da177e4 | 193 | void |
4be44fcd LB |
194 | acpi_ns_dump_objects(acpi_object_type type, |
195 | u8 display_type, | |
196 | u32 max_depth, | |
197 | acpi_owner_id owner_id, acpi_handle start_handle); | |
424deb38 BM |
198 | |
199 | void | |
200 | acpi_ns_dump_object_paths(acpi_object_type type, | |
201 | u8 display_type, | |
202 | u32 max_depth, | |
203 | acpi_owner_id owner_id, acpi_handle start_handle); | |
1da177e4 LT |
204 | |
205 | /* | |
44f6c012 | 206 | * nseval - Namespace evaluation functions |
1da177e4 | 207 | */ |
4119532c | 208 | acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); |
1da177e4 | 209 | |
e8707b34 | 210 | /* |
29a241cc | 211 | * nsarguments - Argument count/type checking for predefined/reserved names |
e8707b34 | 212 | */ |
29a241cc BM |
213 | void |
214 | acpi_ns_check_argument_count(char *pathname, | |
215 | struct acpi_namespace_node *node, | |
216 | u32 user_param_count, | |
217 | const union acpi_predefined_info *info); | |
e8707b34 | 218 | |
e8707b34 | 219 | void |
29a241cc | 220 | acpi_ns_check_acpi_compliance(char *pathname, |
e8707b34 | 221 | struct acpi_namespace_node *node, |
29a241cc BM |
222 | const union acpi_predefined_info *predefined); |
223 | ||
224 | void acpi_ns_check_argument_types(struct acpi_evaluate_info *info); | |
225 | ||
226 | /* | |
227 | * nspredef - Return value checking for predefined/reserved names | |
228 | */ | |
229 | acpi_status | |
230 | acpi_ns_check_return_value(struct acpi_namespace_node *node, | |
231 | struct acpi_evaluate_info *info, | |
232 | u32 user_param_count, | |
233 | acpi_status return_status, | |
234 | union acpi_operand_object **return_object); | |
e8707b34 | 235 | |
42f8fb75 | 236 | acpi_status |
29a241cc | 237 | acpi_ns_check_object_type(struct acpi_evaluate_info *info, |
42f8fb75 BM |
238 | union acpi_operand_object **return_object_ptr, |
239 | u32 expected_btypes, u32 package_index); | |
240 | ||
241 | /* | |
242 | * nsprepkg - Validation of predefined name packages | |
243 | */ | |
244 | acpi_status | |
29a241cc | 245 | acpi_ns_check_package(struct acpi_evaluate_info *info, |
42f8fb75 BM |
246 | union acpi_operand_object **return_object_ptr); |
247 | ||
1da177e4 | 248 | /* |
44f6c012 | 249 | * nsnames - Name and Scope manipulation |
1da177e4 | 250 | */ |
4be44fcd | 251 | u32 acpi_ns_opens_scope(acpi_object_type type); |
1da177e4 | 252 | |
4be44fcd | 253 | char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); |
1da177e4 | 254 | |
d1e7ffe5 LZ |
255 | u32 |
256 | acpi_ns_build_normalized_path(struct acpi_namespace_node *node, | |
257 | char *full_path, u32 path_size, u8 no_trailing); | |
258 | ||
9a1ae804 BM |
259 | void acpi_ns_normalize_pathname(char *original_path); |
260 | ||
d1e7ffe5 LZ |
261 | char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node, |
262 | u8 no_trailing); | |
263 | ||
16ccf829 BM |
264 | char *acpi_ns_build_prefixed_pathname(union acpi_generic_state *prefix_scope, |
265 | const char *internal_path); | |
266 | ||
4be44fcd | 267 | char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); |
1da177e4 | 268 | |
523db19b LZ |
269 | acpi_status |
270 | acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer); | |
271 | ||
1da177e4 | 272 | acpi_status |
4be44fcd | 273 | acpi_ns_handle_to_pathname(acpi_handle target_handle, |
d1e7ffe5 | 274 | struct acpi_buffer *buffer, u8 no_trailing); |
1da177e4 LT |
275 | |
276 | u8 | |
4be44fcd | 277 | acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); |
1da177e4 | 278 | |
c2d981aa LZ |
279 | acpi_status |
280 | acpi_ns_get_node_unlocked(struct acpi_namespace_node *prefix_node, | |
281 | const char *external_pathname, | |
282 | u32 flags, struct acpi_namespace_node **out_node); | |
283 | ||
1da177e4 | 284 | acpi_status |
4119532c | 285 | acpi_ns_get_node(struct acpi_namespace_node *prefix_node, |
4b8ed631 | 286 | const char *external_pathname, |
4119532c | 287 | u32 flags, struct acpi_namespace_node **out_node); |
1da177e4 | 288 | |
4be44fcd | 289 | acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); |
1da177e4 LT |
290 | |
291 | /* | |
44f6c012 | 292 | * nsobject - Object management for namespace nodes |
1da177e4 | 293 | */ |
1da177e4 | 294 | acpi_status |
4be44fcd LB |
295 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
296 | union acpi_operand_object *object, acpi_object_type type); | |
1da177e4 | 297 | |
4be44fcd LB |
298 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
299 | acpi_namespace_node | |
300 | *node); | |
1da177e4 | 301 | |
4be44fcd LB |
302 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
303 | acpi_operand_object | |
304 | *obj_desc); | |
1da177e4 LT |
305 | |
306 | acpi_status | |
4be44fcd LB |
307 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
308 | acpi_object_handler handler, void *data); | |
1da177e4 LT |
309 | |
310 | acpi_status | |
4be44fcd LB |
311 | acpi_ns_detach_data(struct acpi_namespace_node *node, |
312 | acpi_object_handler handler); | |
1da177e4 LT |
313 | |
314 | acpi_status | |
4be44fcd LB |
315 | acpi_ns_get_attached_data(struct acpi_namespace_node *node, |
316 | acpi_object_handler handler, void **data); | |
1da177e4 | 317 | |
b2deadd5 | 318 | /* |
ad5babee BM |
319 | * nsrepair - General return object repair for all |
320 | * predefined methods/objects | |
b2deadd5 BM |
321 | */ |
322 | acpi_status | |
29a241cc | 323 | acpi_ns_simple_repair(struct acpi_evaluate_info *info, |
b2deadd5 BM |
324 | u32 expected_btypes, |
325 | u32 package_index, | |
326 | union acpi_operand_object **return_object_ptr); | |
327 | ||
e5f69d6e | 328 | acpi_status |
29a241cc | 329 | acpi_ns_wrap_with_package(struct acpi_evaluate_info *info, |
6a99b1c9 BM |
330 | union acpi_operand_object *original_object, |
331 | union acpi_operand_object **obj_desc_ptr); | |
e5f69d6e | 332 | |
091f4d71 | 333 | acpi_status |
29a241cc | 334 | acpi_ns_repair_null_element(struct acpi_evaluate_info *info, |
091f4d71 BM |
335 | u32 expected_btypes, |
336 | u32 package_index, | |
337 | union acpi_operand_object **return_object_ptr); | |
338 | ||
339 | void | |
29a241cc | 340 | acpi_ns_remove_null_elements(struct acpi_evaluate_info *info, |
091f4d71 BM |
341 | u8 package_type, |
342 | union acpi_operand_object *obj_desc); | |
343 | ||
ad5babee BM |
344 | /* |
345 | * nsrepair2 - Return object repair for specific | |
346 | * predefined methods/objects | |
347 | */ | |
348 | acpi_status | |
29a241cc | 349 | acpi_ns_complex_repairs(struct acpi_evaluate_info *info, |
ad5babee BM |
350 | struct acpi_namespace_node *node, |
351 | acpi_status validate_status, | |
352 | union acpi_operand_object **return_object_ptr); | |
353 | ||
1da177e4 | 354 | /* |
44f6c012 | 355 | * nssearch - Namespace searching and entry |
1da177e4 | 356 | */ |
1da177e4 | 357 | acpi_status |
4be44fcd LB |
358 | acpi_ns_search_and_enter(u32 entry_name, |
359 | struct acpi_walk_state *walk_state, | |
360 | struct acpi_namespace_node *node, | |
361 | acpi_interpreter_mode interpreter_mode, | |
362 | acpi_object_type type, | |
363 | u32 flags, struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
364 | |
365 | acpi_status | |
4119532c BM |
366 | acpi_ns_search_one_scope(u32 entry_name, |
367 | struct acpi_namespace_node *node, | |
368 | acpi_object_type type, | |
369 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
370 | |
371 | void | |
4be44fcd LB |
372 | acpi_ns_install_node(struct acpi_walk_state *walk_state, |
373 | struct acpi_namespace_node *parent_node, | |
374 | struct acpi_namespace_node *node, acpi_object_type type); | |
1da177e4 LT |
375 | |
376 | /* | |
44f6c012 | 377 | * nsutils - Utility functions |
1da177e4 | 378 | */ |
4be44fcd | 379 | acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); |
1da177e4 | 380 | |
4be44fcd | 381 | u32 acpi_ns_local(acpi_object_type type); |
1da177e4 | 382 | |
4b8ed631 BM |
383 | void |
384 | acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); | |
1da177e4 | 385 | |
4be44fcd | 386 | acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); |
1da177e4 | 387 | |
4be44fcd | 388 | void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); |
1da177e4 | 389 | |
4b8ed631 BM |
390 | acpi_status |
391 | acpi_ns_internalize_name(const char *dotted_name, char **converted_name); | |
1da177e4 LT |
392 | |
393 | acpi_status | |
4be44fcd | 394 | acpi_ns_externalize_name(u32 internal_name_length, |
4b8ed631 | 395 | const char *internal_name, |
4be44fcd | 396 | u32 * converted_name_length, char **converted_name); |
1da177e4 | 397 | |
f24b664d | 398 | struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); |
1da177e4 | 399 | |
4be44fcd | 400 | void acpi_ns_terminate(void); |
1da177e4 | 401 | |
4be44fcd | 402 | #endif /* __ACNAMESP_H__ */ |