1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
6 * Copyright (C) 2000 - 2019, Intel Corp.
8 *****************************************************************************/
10 #ifndef __ACNAMESP_H__
11 #define __ACNAMESP_H__
13 /* To search the entire name space, pass this as search_base */
15 #define ACPI_NS_ALL ((acpi_handle)0)
18 * Elements of acpi_ns_properties are bit significant
19 * and should be one-to-one with values of acpi_object_type
21 #define ACPI_NS_NORMAL 0
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 */
25 /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */
27 #define ACPI_NS_NO_UPSEARCH 0
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
37 #define ACPI_NS_PREFIX_MUST_EXIST 0x0200
39 /* Flags for acpi_ns_walk_namespace */
41 #define ACPI_NS_WALK_NO_UNLOCK 0
42 #define ACPI_NS_WALK_UNLOCK 0x01
43 #define ACPI_NS_WALK_TEMP_NODES 0x02
45 /* Object is not a package element */
47 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
48 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1)
50 /* Always emit warning message, not dependent on node flags */
52 #define ACPI_WARN_ALWAYS 0
55 * nsinit - Namespace initialization
57 acpi_status acpi_ns_initialize_objects(void);
59 acpi_status acpi_ns_initialize_devices(u32 flags);
62 acpi_ns_init_one_package(acpi_handle obj_handle,
63 u32 level, void *context, void **return_value);
66 * nsload - Namespace loading
68 acpi_status acpi_ns_load_namespace(void);
71 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
74 * nswalk - walk the namespace
77 acpi_ns_walk_namespace(acpi_object_type type,
78 acpi_handle start_object,
81 acpi_walk_callback descending_callback,
82 acpi_walk_callback ascending_callback,
83 void *context, void **return_value);
85 struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node
87 struct acpi_namespace_node
90 struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type,
99 * nsparse - table parsing
102 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
105 acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node);
108 acpi_ns_one_complete_parse(u32 pass_number,
110 struct acpi_namespace_node *start_node);
113 * nsaccess - Top-level namespace access
115 acpi_status acpi_ns_root_initialize(void);
118 acpi_ns_lookup(union acpi_generic_state *scope_info,
120 acpi_object_type type,
121 acpi_interpreter_mode interpreter_mode,
123 struct acpi_walk_state *walk_state,
124 struct acpi_namespace_node **ret_node);
127 * nsalloc - Named object allocation/deallocation
129 struct acpi_namespace_node *acpi_ns_create_node(u32 name);
131 void acpi_ns_delete_node(struct acpi_namespace_node *node);
133 void acpi_ns_remove_node(struct acpi_namespace_node *node);
136 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
138 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
140 void acpi_ns_detach_object(struct acpi_namespace_node *node);
142 void acpi_ns_delete_children(struct acpi_namespace_node *parent);
144 int acpi_ns_compare_names(char *name1, char *name2);
147 * nsconvert - Dynamic object conversion routines
150 acpi_ns_convert_to_integer(union acpi_operand_object *original_object,
151 union acpi_operand_object **return_object);
154 acpi_ns_convert_to_string(union acpi_operand_object *original_object,
155 union acpi_operand_object **return_object);
158 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object,
159 union acpi_operand_object **return_object);
162 acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope,
163 union acpi_operand_object *original_object,
164 union acpi_operand_object **return_object);
167 acpi_ns_convert_to_resource(struct acpi_namespace_node *scope,
168 union acpi_operand_object *original_object,
169 union acpi_operand_object **return_object);
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);
177 * nsdump - Namespace dump/print utilities
179 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
181 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
184 acpi_ns_dump_pathname(acpi_handle handle,
185 const char *msg, u32 level, u32 component);
187 void acpi_ns_print_pathname(u32 num_segments, const char *pathname);
190 acpi_ns_dump_one_object(acpi_handle obj_handle,
191 u32 level, void *context, void **return_value);
194 acpi_ns_dump_objects(acpi_object_type type,
197 acpi_owner_id owner_id, acpi_handle start_handle);
200 acpi_ns_dump_object_paths(acpi_object_type type,
203 acpi_owner_id owner_id, acpi_handle start_handle);
206 * nseval - Namespace evaluation functions
208 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
211 * nsarguments - Argument count/type checking for predefined/reserved names
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);
220 acpi_ns_check_acpi_compliance(char *pathname,
221 struct acpi_namespace_node *node,
222 const union acpi_predefined_info *predefined);
224 void acpi_ns_check_argument_types(struct acpi_evaluate_info *info);
227 * nspredef - Return value checking for predefined/reserved names
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);
237 acpi_ns_check_object_type(struct acpi_evaluate_info *info,
238 union acpi_operand_object **return_object_ptr,
239 u32 expected_btypes, u32 package_index);
242 * nsprepkg - Validation of predefined name packages
245 acpi_ns_check_package(struct acpi_evaluate_info *info,
246 union acpi_operand_object **return_object_ptr);
249 * nsnames - Name and Scope manipulation
251 u32 acpi_ns_opens_scope(acpi_object_type type);
253 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
256 acpi_ns_build_normalized_path(struct acpi_namespace_node *node,
257 char *full_path, u32 path_size, u8 no_trailing);
259 char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node,
262 char *acpi_ns_build_prefixed_pathname(union acpi_generic_state *prefix_scope,
263 const char *internal_path);
265 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
268 acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer);
271 acpi_ns_handle_to_pathname(acpi_handle target_handle,
272 struct acpi_buffer *buffer, u8 no_trailing);
275 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
278 acpi_ns_get_node_unlocked(struct acpi_namespace_node *prefix_node,
279 const char *external_pathname,
280 u32 flags, struct acpi_namespace_node **out_node);
283 acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
284 const char *external_pathname,
285 u32 flags, struct acpi_namespace_node **out_node);
287 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
290 * nsobject - Object management for namespace nodes
293 acpi_ns_attach_object(struct acpi_namespace_node *node,
294 union acpi_operand_object *object, acpi_object_type type);
296 union acpi_operand_object *acpi_ns_get_attached_object(struct
300 union acpi_operand_object *acpi_ns_get_secondary_object(union
305 acpi_ns_attach_data(struct acpi_namespace_node *node,
306 acpi_object_handler handler, void *data);
309 acpi_ns_detach_data(struct acpi_namespace_node *node,
310 acpi_object_handler handler);
313 acpi_ns_get_attached_data(struct acpi_namespace_node *node,
314 acpi_object_handler handler, void **data);
317 * nsrepair - General return object repair for all
318 * predefined methods/objects
321 acpi_ns_simple_repair(struct acpi_evaluate_info *info,
324 union acpi_operand_object **return_object_ptr);
327 acpi_ns_wrap_with_package(struct acpi_evaluate_info *info,
328 union acpi_operand_object *original_object,
329 union acpi_operand_object **obj_desc_ptr);
332 acpi_ns_repair_null_element(struct acpi_evaluate_info *info,
335 union acpi_operand_object **return_object_ptr);
338 acpi_ns_remove_null_elements(struct acpi_evaluate_info *info,
340 union acpi_operand_object *obj_desc);
343 * nsrepair2 - Return object repair for specific
344 * predefined methods/objects
347 acpi_ns_complex_repairs(struct acpi_evaluate_info *info,
348 struct acpi_namespace_node *node,
349 acpi_status validate_status,
350 union acpi_operand_object **return_object_ptr);
353 * nssearch - Namespace searching and entry
356 acpi_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);
364 acpi_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);
370 acpi_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);
375 * nsutils - Utility functions
377 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
379 u32 acpi_ns_local(acpi_object_type type);
382 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
384 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
386 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
389 acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
392 acpi_ns_externalize_name(u32 internal_name_length,
393 const char *internal_name,
394 u32 * converted_name_length, char **converted_name);
396 struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle);
398 void acpi_ns_terminate(void);
400 #endif /* __ACNAMESP_H__ */