]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - drivers/acpi/acpica/acnamesp.h
ACPICA: All acpica: Update copyrights to 2020 Including tool signons.
[mirror_ubuntu-hirsute-kernel.git] / drivers / acpi / acpica / acnamesp.h
CommitLineData
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 57acpi_status acpi_ns_initialize_objects(void);
1da177e4 58
ced04366 59acpi_status acpi_ns_initialize_devices(u32 flags);
1da177e4 60
7b34c0fb
BM
61acpi_status
62acpi_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 68acpi_status acpi_ns_load_namespace(void);
1da177e4
LT
69
70acpi_status
67a119f9 71acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
1da177e4 72
44f6c012
RM
73/*
74 * nswalk - walk the namespace
75 */
1da177e4 76acpi_status
4be44fcd
LB
77acpi_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
85struct 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
90struct 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 101acpi_status
67a119f9 102acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
1da177e4 103
de56ba95
LZ
104acpi_status
105acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node);
106
1da177e4 107acpi_status
67a119f9
BM
108acpi_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 115acpi_status acpi_ns_root_initialize(void);
1da177e4
LT
116
117acpi_status
4be44fcd
LB
118acpi_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 129struct acpi_namespace_node *acpi_ns_create_node(u32 name);
1da177e4 130
4be44fcd 131void acpi_ns_delete_node(struct acpi_namespace_node *node);
1da177e4 132
8e4319c4
BM
133void acpi_ns_remove_node(struct acpi_namespace_node *node);
134
44f6c012 135void
4be44fcd 136acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
44f6c012 137
4be44fcd 138void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
1da177e4 139
4be44fcd 140void acpi_ns_detach_object(struct acpi_namespace_node *node);
1da177e4 141
4be44fcd 142void acpi_ns_delete_children(struct acpi_namespace_node *parent);
1da177e4 143
4be44fcd 144int acpi_ns_compare_names(char *name1, char *name2);
1da177e4 145
76a6225b
BM
146/*
147 * nsconvert - Dynamic object conversion routines
148 */
149acpi_status
150acpi_ns_convert_to_integer(union acpi_operand_object *original_object,
151 union acpi_operand_object **return_object);
152
153acpi_status
154acpi_ns_convert_to_string(union acpi_operand_object *original_object,
155 union acpi_operand_object **return_object);
156
157acpi_status
158acpi_ns_convert_to_buffer(union acpi_operand_object *original_object,
159 union acpi_operand_object **return_object);
160
96b44cc6 161acpi_status
4debda53
LZ
162acpi_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 166acpi_status
4debda53
LZ
167acpi_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
171acpi_status
172acpi_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 179void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
1da177e4 180
4be44fcd 181void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
1da177e4
LT
182
183void
0dfaaa3d
BM
184acpi_ns_dump_pathname(acpi_handle handle,
185 const char *msg, u32 level, u32 component);
1da177e4 186
0dfaaa3d 187void acpi_ns_print_pathname(u32 num_segments, const char *pathname);
1da177e4 188
1da177e4 189acpi_status
4be44fcd
LB
190acpi_ns_dump_one_object(acpi_handle obj_handle,
191 u32 level, void *context, void **return_value);
1da177e4 192
1da177e4 193void
4be44fcd
LB
194acpi_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
199void
200acpi_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 208acpi_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
213void
214acpi_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 219void
29a241cc 220acpi_ns_check_acpi_compliance(char *pathname,
e8707b34 221 struct acpi_namespace_node *node,
29a241cc
BM
222 const union acpi_predefined_info *predefined);
223
224void acpi_ns_check_argument_types(struct acpi_evaluate_info *info);
225
226/*
227 * nspredef - Return value checking for predefined/reserved names
228 */
229acpi_status
230acpi_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 236acpi_status
29a241cc 237acpi_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 */
244acpi_status
29a241cc 245acpi_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 251u32 acpi_ns_opens_scope(acpi_object_type type);
1da177e4 252
4be44fcd 253char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
1da177e4 254
d1e7ffe5
LZ
255u32
256acpi_ns_build_normalized_path(struct acpi_namespace_node *node,
257 char *full_path, u32 path_size, u8 no_trailing);
258
259char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node,
260 u8 no_trailing);
261
16ccf829
BM
262char *acpi_ns_build_prefixed_pathname(union acpi_generic_state *prefix_scope,
263 const char *internal_path);
264
4be44fcd 265char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
1da177e4 266
523db19b
LZ
267acpi_status
268acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer);
269
1da177e4 270acpi_status
4be44fcd 271acpi_ns_handle_to_pathname(acpi_handle target_handle,
d1e7ffe5 272 struct acpi_buffer *buffer, u8 no_trailing);
1da177e4
LT
273
274u8
4be44fcd 275acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
1da177e4 276
c2d981aa
LZ
277acpi_status
278acpi_ns_get_node_unlocked(struct acpi_namespace_node *prefix_node,
279 const char *external_pathname,
280 u32 flags, struct acpi_namespace_node **out_node);
281
1da177e4 282acpi_status
4119532c 283acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
4b8ed631 284 const char *external_pathname,
4119532c 285 u32 flags, struct acpi_namespace_node **out_node);
1da177e4 286
4be44fcd 287acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
1da177e4
LT
288
289/*
44f6c012 290 * nsobject - Object management for namespace nodes
1da177e4 291 */
1da177e4 292acpi_status
4be44fcd
LB
293acpi_ns_attach_object(struct acpi_namespace_node *node,
294 union acpi_operand_object *object, acpi_object_type type);
1da177e4 295
4be44fcd
LB
296union acpi_operand_object *acpi_ns_get_attached_object(struct
297 acpi_namespace_node
298 *node);
1da177e4 299
4be44fcd
LB
300union acpi_operand_object *acpi_ns_get_secondary_object(union
301 acpi_operand_object
302 *obj_desc);
1da177e4
LT
303
304acpi_status
4be44fcd
LB
305acpi_ns_attach_data(struct acpi_namespace_node *node,
306 acpi_object_handler handler, void *data);
1da177e4
LT
307
308acpi_status
4be44fcd
LB
309acpi_ns_detach_data(struct acpi_namespace_node *node,
310 acpi_object_handler handler);
1da177e4
LT
311
312acpi_status
4be44fcd
LB
313acpi_ns_get_attached_data(struct acpi_namespace_node *node,
314 acpi_object_handler handler, void **data);
1da177e4 315
b2deadd5 316/*
ad5babee
BM
317 * nsrepair - General return object repair for all
318 * predefined methods/objects
b2deadd5
BM
319 */
320acpi_status
29a241cc 321acpi_ns_simple_repair(struct acpi_evaluate_info *info,
b2deadd5
BM
322 u32 expected_btypes,
323 u32 package_index,
324 union acpi_operand_object **return_object_ptr);
325
e5f69d6e 326acpi_status
29a241cc 327acpi_ns_wrap_with_package(struct acpi_evaluate_info *info,
6a99b1c9
BM
328 union acpi_operand_object *original_object,
329 union acpi_operand_object **obj_desc_ptr);
e5f69d6e 330
091f4d71 331acpi_status
29a241cc 332acpi_ns_repair_null_element(struct acpi_evaluate_info *info,
091f4d71
BM
333 u32 expected_btypes,
334 u32 package_index,
335 union acpi_operand_object **return_object_ptr);
336
337void
29a241cc 338acpi_ns_remove_null_elements(struct acpi_evaluate_info *info,
091f4d71
BM
339 u8 package_type,
340 union acpi_operand_object *obj_desc);
341
ad5babee
BM
342/*
343 * nsrepair2 - Return object repair for specific
344 * predefined methods/objects
345 */
346acpi_status
29a241cc 347acpi_ns_complex_repairs(struct acpi_evaluate_info *info,
ad5babee
BM
348 struct acpi_namespace_node *node,
349 acpi_status validate_status,
350 union acpi_operand_object **return_object_ptr);
351
1da177e4 352/*
44f6c012 353 * nssearch - Namespace searching and entry
1da177e4 354 */
1da177e4 355acpi_status
4be44fcd
LB
356acpi_ns_search_and_enter(u32 entry_name,
357 struct acpi_walk_state *walk_state,
358 struct acpi_namespace_node *node,
359 acpi_interpreter_mode interpreter_mode,
360 acpi_object_type type,
361 u32 flags, struct acpi_namespace_node **ret_node);
1da177e4
LT
362
363acpi_status
4119532c
BM
364acpi_ns_search_one_scope(u32 entry_name,
365 struct acpi_namespace_node *node,
366 acpi_object_type type,
367 struct acpi_namespace_node **ret_node);
1da177e4
LT
368
369void
4be44fcd
LB
370acpi_ns_install_node(struct acpi_walk_state *walk_state,
371 struct acpi_namespace_node *parent_node,
372 struct acpi_namespace_node *node, acpi_object_type type);
1da177e4
LT
373
374/*
44f6c012 375 * nsutils - Utility functions
1da177e4 376 */
4be44fcd 377acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
1da177e4 378
4be44fcd 379u32 acpi_ns_local(acpi_object_type type);
1da177e4 380
4b8ed631
BM
381void
382acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
1da177e4 383
4be44fcd 384acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
1da177e4 385
4be44fcd 386void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
1da177e4 387
4b8ed631
BM
388acpi_status
389acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
1da177e4
LT
390
391acpi_status
4be44fcd 392acpi_ns_externalize_name(u32 internal_name_length,
4b8ed631 393 const char *internal_name,
4be44fcd 394 u32 * converted_name_length, char **converted_name);
1da177e4 395
f24b664d 396struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle);
1da177e4 397
4be44fcd 398void acpi_ns_terminate(void);
1da177e4 399
4be44fcd 400#endif /* __ACNAMESP_H__ */