acpi/acpica/acnamesp.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: acnamesp.h - Namespace subcomponent prototypes and defines
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009
0010 #ifndef __ACNAMESP_H__
0011 #define __ACNAMESP_H__
0012
0013 /* To search the entire name space, pass this as search_base */
0014
0015 #define ACPI_NS_ALL                 ((acpi_handle)0)
0016
0017 /*
0018  * Elements of acpi_ns_properties are bit significant
0019  * and should be one-to-one with values of acpi_object_type
0020  */
0021 #define ACPI_NS_NORMAL              0
0022 #define ACPI_NS_NEWSCOPE            1   /* a definition of this type opens a name scope */
0023 #define ACPI_NS_LOCAL               2   /* suppress search of enclosing scopes */
0024
0025 /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */
0026
0027 #define ACPI_NS_NO_UPSEARCH         0
0028 #define ACPI_NS_SEARCH_PARENT       0x0001
0029 #define ACPI_NS_DONT_OPEN_SCOPE     0x0002
0030 #define ACPI_NS_NO_PEER_SEARCH      0x0004
0031 #define ACPI_NS_ERROR_IF_FOUND      0x0008
0032 #define ACPI_NS_PREFIX_IS_SCOPE     0x0010
0033 #define ACPI_NS_EXTERNAL            0x0020
0034 #define ACPI_NS_TEMPORARY           0x0040
0035 #define ACPI_NS_OVERRIDE_IF_FOUND   0x0080
0036 #define ACPI_NS_EARLY_INIT          0x0100
0037 #define ACPI_NS_PREFIX_MUST_EXIST   0x0200
0038
0039 /* Flags for acpi_ns_walk_namespace */
0040
0041 #define ACPI_NS_WALK_NO_UNLOCK      0
0042 #define ACPI_NS_WALK_UNLOCK         0x01
0043 #define ACPI_NS_WALK_TEMP_NODES     0x02
0044
0045 /* Object is not a package element */
0046
0047 #define ACPI_NOT_PACKAGE_ELEMENT    ACPI_UINT32_MAX
0048 #define ACPI_ALL_PACKAGE_ELEMENTS   (ACPI_UINT32_MAX-1)
0049
0050 /* Always emit warning message, not dependent on node flags */
0051
0052 #define ACPI_WARN_ALWAYS            0
0053
0054 /*
0055  * nsinit - Namespace initialization
0056  */
0057 acpi_status acpi_ns_initialize_objects(void);
0058
0059 acpi_status acpi_ns_initialize_devices(u32 flags);
0060
0061 acpi_status
0062 acpi_ns_init_one_package(acpi_handle obj_handle,
0063              u32 level, void *context, void **return_value);
0064
0065 /*
0066  * nsload -  Namespace loading
0067  */
0068 acpi_status acpi_ns_load_namespace(void);
0069
0070 acpi_status
0071 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
0072
0073 /*
0074  * nswalk - walk the namespace
0075  */
0076 acpi_status
0077 acpi_ns_walk_namespace(acpi_object_type type,
0078                acpi_handle start_object,
0079                u32 max_depth,
0080                u32 flags,
0081                acpi_walk_callback descending_callback,
0082                acpi_walk_callback ascending_callback,
0083                void *context, void **return_value);
0084
0085 struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node
0086                           *parent,
0087                           struct acpi_namespace_node
0088                           *child);
0089
0090 struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type,
0091                             struct
0092                             acpi_namespace_node
0093                             *parent,
0094                             struct
0095                             acpi_namespace_node
0096                             *child);
0097
0098 /*
0099  * nsparse - table parsing
0100  */
0101 acpi_status
0102 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
0103
0104 acpi_status
0105 acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node);
0106
0107 acpi_status
0108 acpi_ns_one_complete_parse(u32 pass_number,
0109                u32 table_index,
0110                struct acpi_namespace_node *start_node);
0111
0112 /*
0113  * nsaccess - Top-level namespace access
0114  */
0115 acpi_status acpi_ns_root_initialize(void);
0116
0117 acpi_status
0118 acpi_ns_lookup(union acpi_generic_state *scope_info,
0119            char *name,
0120            acpi_object_type type,
0121            acpi_interpreter_mode interpreter_mode,
0122            u32 flags,
0123            struct acpi_walk_state *walk_state,
0124            struct acpi_namespace_node **ret_node);
0125
0126 /*
0127  * nsalloc - Named object allocation/deallocation
0128  */
0129 struct acpi_namespace_node *acpi_ns_create_node(u32 name);
0130
0131 void acpi_ns_delete_node(struct acpi_namespace_node *node);
0132
0133 void acpi_ns_remove_node(struct acpi_namespace_node *node);
0134
0135 void
0136 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
0137
0138 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
0139
0140 void acpi_ns_detach_object(struct acpi_namespace_node *node);
0141
0142 void acpi_ns_delete_children(struct acpi_namespace_node *parent);
0143
0144 int acpi_ns_compare_names(char *name1, char *name2);
0145
0146 /*
0147  * nsconvert - Dynamic object conversion routines
0148  */
0149 acpi_status
0150 acpi_ns_convert_to_integer(union acpi_operand_object *original_object,
0151                union acpi_operand_object **return_object);
0152
0153 acpi_status
0154 acpi_ns_convert_to_string(union acpi_operand_object *original_object,
0155               union acpi_operand_object **return_object);
0156
0157 acpi_status
0158 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object,
0159               union acpi_operand_object **return_object);
0160
0161 acpi_status
0162 acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope,
0163                union acpi_operand_object *original_object,
0164                union acpi_operand_object **return_object);
0165
0166 acpi_status
0167 acpi_ns_convert_to_resource(struct acpi_namespace_node *scope,
0168                 union acpi_operand_object *original_object,
0169                 union acpi_operand_object **return_object);
0170
0171 acpi_status
0172 acpi_ns_convert_to_reference(struct acpi_namespace_node *scope,
0173                  union acpi_operand_object *original_object,
0174                  union acpi_operand_object **return_object);
0175
0176 /*
0177  * nsdump - Namespace dump/print utilities
0178  */
0179 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
0180
0181 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
0182
0183 void
0184 acpi_ns_dump_pathname(acpi_handle handle,
0185               const char *msg, u32 level, u32 component);
0186
0187 void acpi_ns_print_pathname(u32 num_segments, const char *pathname);
0188
0189 acpi_status
0190 acpi_ns_dump_one_object(acpi_handle obj_handle,
0191             u32 level, void *context, void **return_value);
0192
0193 void
0194 acpi_ns_dump_objects(acpi_object_type type,
0195              u8 display_type,
0196              u32 max_depth,
0197              acpi_owner_id owner_id, acpi_handle start_handle);
0198
0199 void
0200 acpi_ns_dump_object_paths(acpi_object_type type,
0201               u8 display_type,
0202               u32 max_depth,
0203               acpi_owner_id owner_id, acpi_handle start_handle);
0204
0205 /*
0206  * nseval - Namespace evaluation functions
0207  */
0208 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
0209
0210 /*
0211  * nsarguments - Argument count/type checking for predefined/reserved names
0212  */
0213 void
0214 acpi_ns_check_argument_count(char *pathname,
0215                  struct acpi_namespace_node *node,
0216                  u32 user_param_count,
0217                  const union acpi_predefined_info *info);
0218
0219 void
0220 acpi_ns_check_acpi_compliance(char *pathname,
0221                   struct acpi_namespace_node *node,
0222                   const union acpi_predefined_info *predefined);
0223
0224 void acpi_ns_check_argument_types(struct acpi_evaluate_info *info);
0225
0226 /*
0227  * nspredef - Return value checking for predefined/reserved names
0228  */
0229 acpi_status
0230 acpi_ns_check_return_value(struct acpi_namespace_node *node,
0231                struct acpi_evaluate_info *info,
0232                u32 user_param_count,
0233                acpi_status return_status,
0234                union acpi_operand_object **return_object);
0235
0236 acpi_status
0237 acpi_ns_check_object_type(struct acpi_evaluate_info *info,
0238               union acpi_operand_object **return_object_ptr,
0239               u32 expected_btypes, u32 package_index);
0240
0241 /*
0242  * nsprepkg - Validation of predefined name packages
0243  */
0244 acpi_status
0245 acpi_ns_check_package(struct acpi_evaluate_info *info,
0246               union acpi_operand_object **return_object_ptr);
0247
0248 /*
0249  * nsnames - Name and Scope manipulation
0250  */
0251 u32 acpi_ns_opens_scope(acpi_object_type type);
0252
0253 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
0254
0255 u32
0256 acpi_ns_build_normalized_path(struct acpi_namespace_node *node,
0257                   char *full_path, u32 path_size, u8 no_trailing);
0258
0259 void acpi_ns_normalize_pathname(char *original_path);
0260
0261 char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node,
0262                       u8 no_trailing);
0263
0264 char *acpi_ns_build_prefixed_pathname(union acpi_generic_state *prefix_scope,
0265                       const char *internal_path);
0266
0267 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
0268
0269 acpi_status
0270 acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer);
0271
0272 acpi_status
0273 acpi_ns_handle_to_pathname(acpi_handle target_handle,
0274                struct acpi_buffer *buffer, u8 no_trailing);
0275
0276 u8
0277 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
0278
0279 acpi_status
0280 acpi_ns_get_node_unlocked(struct acpi_namespace_node *prefix_node,
0281               const char *external_pathname,
0282               u32 flags, struct acpi_namespace_node **out_node);
0283
0284 acpi_status
0285 acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
0286          const char *external_pathname,
0287          u32 flags, struct acpi_namespace_node **out_node);
0288
0289 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
0290
0291 /*
0292  * nsobject - Object management for namespace nodes
0293  */
0294 acpi_status
0295 acpi_ns_attach_object(struct acpi_namespace_node *node,
0296               union acpi_operand_object *object, acpi_object_type type);
0297
0298 union acpi_operand_object *acpi_ns_get_attached_object(struct
0299                                acpi_namespace_node
0300                                *node);
0301
0302 union acpi_operand_object *acpi_ns_get_secondary_object(union
0303                             acpi_operand_object
0304                             *obj_desc);
0305
0306 acpi_status
0307 acpi_ns_attach_data(struct acpi_namespace_node *node,
0308             acpi_object_handler handler, void *data);
0309
0310 acpi_status
0311 acpi_ns_detach_data(struct acpi_namespace_node *node,
0312             acpi_object_handler handler);
0313
0314 acpi_status
0315 acpi_ns_get_attached_data(struct acpi_namespace_node *node,
0316               acpi_object_handler handler, void **data);
0317
0318 /*
0319  * nsrepair - General return object repair for all
0320  * predefined methods/objects
0321  */
0322 acpi_status
0323 acpi_ns_simple_repair(struct acpi_evaluate_info *info,
0324               u32 expected_btypes,
0325               u32 package_index,
0326               union acpi_operand_object **return_object_ptr);
0327
0328 acpi_status
0329 acpi_ns_wrap_with_package(struct acpi_evaluate_info *info,
0330               union acpi_operand_object *original_object,
0331               union acpi_operand_object **obj_desc_ptr);
0332
0333 acpi_status
0334 acpi_ns_repair_null_element(struct acpi_evaluate_info *info,
0335                 u32 expected_btypes,
0336                 u32 package_index,
0337                 union acpi_operand_object **return_object_ptr);
0338
0339 void
0340 acpi_ns_remove_null_elements(struct acpi_evaluate_info *info,
0341                  u8 package_type,
0342                  union acpi_operand_object *obj_desc);
0343
0344 /*
0345  * nsrepair2 - Return object repair for specific
0346  * predefined methods/objects
0347  */
0348 acpi_status
0349 acpi_ns_complex_repairs(struct acpi_evaluate_info *info,
0350             struct acpi_namespace_node *node,
0351             acpi_status validate_status,
0352             union acpi_operand_object **return_object_ptr);
0353
0354 /*
0355  * nssearch - Namespace searching and entry
0356  */
0357 acpi_status
0358 acpi_ns_search_and_enter(u32 entry_name,
0359              struct acpi_walk_state *walk_state,
0360              struct acpi_namespace_node *node,
0361              acpi_interpreter_mode interpreter_mode,
0362              acpi_object_type type,
0363              u32 flags, struct acpi_namespace_node **ret_node);
0364
0365 acpi_status
0366 acpi_ns_search_one_scope(u32 entry_name,
0367              struct acpi_namespace_node *node,
0368              acpi_object_type type,
0369              struct acpi_namespace_node **ret_node);
0370
0371 void
0372 acpi_ns_install_node(struct acpi_walk_state *walk_state,
0373              struct acpi_namespace_node *parent_node,
0374              struct acpi_namespace_node *node, acpi_object_type type);
0375
0376 /*
0377  * nsutils - Utility functions
0378  */
0379 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
0380
0381 u32 acpi_ns_local(acpi_object_type type);
0382
0383 void
0384 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
0385
0386 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
0387
0388 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
0389
0390 acpi_status
0391 acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
0392
0393 acpi_status
0394 acpi_ns_externalize_name(u32 internal_name_length,
0395              const char *internal_name,
0396              u32 * converted_name_length, char **converted_name);
0397
0398 struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle);
0399
0400 void acpi_ns_terminate(void);
0401
0402 #endif              /* __ACNAMESP_H__ */