1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 5 * 6 * Copyright (C) 2000 - 2018, Intel Corp. 7 * 8 *****************************************************************************/ 9 10 #ifndef __ACNAMESP_H__ 11 #define __ACNAMESP_H__ 12 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 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 */ 24 25 /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */ 26 27 #define ACPI_NS_NO_UPSEARCH 0 28 #define ACPI_NS_SEARCH_PARENT 0x01 29 #define ACPI_NS_DONT_OPEN_SCOPE 0x02 30 #define ACPI_NS_NO_PEER_SEARCH 0x04 31 #define ACPI_NS_ERROR_IF_FOUND 0x08 32 #define ACPI_NS_PREFIX_IS_SCOPE 0x10 33 #define ACPI_NS_EXTERNAL 0x20 34 #define ACPI_NS_TEMPORARY 0x40 35 #define ACPI_NS_OVERRIDE_IF_FOUND 0x80 36 37 /* Flags for acpi_ns_walk_namespace */ 38 39 #define ACPI_NS_WALK_NO_UNLOCK 0 40 #define ACPI_NS_WALK_UNLOCK 0x01 41 #define ACPI_NS_WALK_TEMP_NODES 0x02 42 43 /* Object is not a package element */ 44 45 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX 46 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1) 47 48 /* Always emit warning message, not dependent on node flags */ 49 50 #define ACPI_WARN_ALWAYS 0 51 52 /* 53 * nsinit - Namespace initialization 54 */ 55 acpi_status acpi_ns_initialize_objects(void); 56 57 acpi_status acpi_ns_initialize_devices(u32 flags); 58 59 acpi_status 60 acpi_ns_init_one_package(acpi_handle obj_handle, 61 u32 level, void *context, void **return_value); 62 63 /* 64 * nsload - Namespace loading 65 */ 66 acpi_status acpi_ns_load_namespace(void); 67 68 acpi_status 69 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); 70 71 /* 72 * nswalk - walk the namespace 73 */ 74 acpi_status 75 acpi_ns_walk_namespace(acpi_object_type type, 76 acpi_handle start_object, 77 u32 max_depth, 78 u32 flags, 79 acpi_walk_callback descending_callback, 80 acpi_walk_callback ascending_callback, 81 void *context, void **return_value); 82 83 struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node 84 *parent, 85 struct acpi_namespace_node 86 *child); 87 88 struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, 89 struct 90 acpi_namespace_node 91 *parent, 92 struct 93 acpi_namespace_node 94 *child); 95 96 /* 97 * nsparse - table parsing 98 */ 99 acpi_status 100 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); 101 102 acpi_status 103 acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node); 104 105 acpi_status 106 acpi_ns_one_complete_parse(u32 pass_number, 107 u32 table_index, 108 struct acpi_namespace_node *start_node); 109 110 /* 111 * nsaccess - Top-level namespace access 112 */ 113 acpi_status acpi_ns_root_initialize(void); 114 115 acpi_status 116 acpi_ns_lookup(union acpi_generic_state *scope_info, 117 char *name, 118 acpi_object_type type, 119 acpi_interpreter_mode interpreter_mode, 120 u32 flags, 121 struct acpi_walk_state *walk_state, 122 struct acpi_namespace_node **ret_node); 123 124 /* 125 * nsalloc - Named object allocation/deallocation 126 */ 127 struct acpi_namespace_node *acpi_ns_create_node(u32 name); 128 129 void acpi_ns_delete_node(struct acpi_namespace_node *node); 130 131 void acpi_ns_remove_node(struct acpi_namespace_node *node); 132 133 void 134 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); 135 136 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); 137 138 void acpi_ns_detach_object(struct acpi_namespace_node *node); 139 140 void acpi_ns_delete_children(struct acpi_namespace_node *parent); 141 142 int acpi_ns_compare_names(char *name1, char *name2); 143 144 /* 145 * nsconvert - Dynamic object conversion routines 146 */ 147 acpi_status 148 acpi_ns_convert_to_integer(union acpi_operand_object *original_object, 149 union acpi_operand_object **return_object); 150 151 acpi_status 152 acpi_ns_convert_to_string(union acpi_operand_object *original_object, 153 union acpi_operand_object **return_object); 154 155 acpi_status 156 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, 157 union acpi_operand_object **return_object); 158 159 acpi_status 160 acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope, 161 union acpi_operand_object *original_object, 162 union acpi_operand_object **return_object); 163 164 acpi_status 165 acpi_ns_convert_to_resource(struct acpi_namespace_node *scope, 166 union acpi_operand_object *original_object, 167 union acpi_operand_object **return_object); 168 169 acpi_status 170 acpi_ns_convert_to_reference(struct acpi_namespace_node *scope, 171 union acpi_operand_object *original_object, 172 union acpi_operand_object **return_object); 173 174 /* 175 * nsdump - Namespace dump/print utilities 176 */ 177 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); 178 179 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); 180 181 void 182 acpi_ns_dump_pathname(acpi_handle handle, 183 const char *msg, u32 level, u32 component); 184 185 void acpi_ns_print_pathname(u32 num_segments, const char *pathname); 186 187 acpi_status 188 acpi_ns_dump_one_object(acpi_handle obj_handle, 189 u32 level, void *context, void **return_value); 190 191 void 192 acpi_ns_dump_objects(acpi_object_type type, 193 u8 display_type, 194 u32 max_depth, 195 acpi_owner_id owner_id, acpi_handle start_handle); 196 197 void 198 acpi_ns_dump_object_paths(acpi_object_type type, 199 u8 display_type, 200 u32 max_depth, 201 acpi_owner_id owner_id, acpi_handle start_handle); 202 203 /* 204 * nseval - Namespace evaluation functions 205 */ 206 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); 207 208 void acpi_ns_exec_module_code_list(void); 209 210 /* 211 * nsarguments - Argument count/type checking for predefined/reserved names 212 */ 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); 218 219 void 220 acpi_ns_check_acpi_compliance(char *pathname, 221 struct acpi_namespace_node *node, 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); 235 236 acpi_status 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); 240 241 /* 242 * nsprepkg - Validation of predefined name packages 243 */ 244 acpi_status 245 acpi_ns_check_package(struct acpi_evaluate_info *info, 246 union acpi_operand_object **return_object_ptr); 247 248 /* 249 * nsnames - Name and Scope manipulation 250 */ 251 u32 acpi_ns_opens_scope(acpi_object_type type); 252 253 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); 254 255 u32 256 acpi_ns_build_normalized_path(struct acpi_namespace_node *node, 257 char *full_path, u32 path_size, u8 no_trailing); 258 259 char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node, 260 u8 no_trailing); 261 262 char *acpi_ns_build_prefixed_pathname(union acpi_generic_state *prefix_scope, 263 const char *internal_path); 264 265 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); 266 267 acpi_status 268 acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer); 269 270 acpi_status 271 acpi_ns_handle_to_pathname(acpi_handle target_handle, 272 struct acpi_buffer *buffer, u8 no_trailing); 273 274 u8 275 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); 276 277 acpi_status 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); 281 282 acpi_status 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); 286 287 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); 288 289 /* 290 * nsobject - Object management for namespace nodes 291 */ 292 acpi_status 293 acpi_ns_attach_object(struct acpi_namespace_node *node, 294 union acpi_operand_object *object, acpi_object_type type); 295 296 union acpi_operand_object *acpi_ns_get_attached_object(struct 297 acpi_namespace_node 298 *node); 299 300 union acpi_operand_object *acpi_ns_get_secondary_object(union 301 acpi_operand_object 302 *obj_desc); 303 304 acpi_status 305 acpi_ns_attach_data(struct acpi_namespace_node *node, 306 acpi_object_handler handler, void *data); 307 308 acpi_status 309 acpi_ns_detach_data(struct acpi_namespace_node *node, 310 acpi_object_handler handler); 311 312 acpi_status 313 acpi_ns_get_attached_data(struct acpi_namespace_node *node, 314 acpi_object_handler handler, void **data); 315 316 /* 317 * nsrepair - General return object repair for all 318 * predefined methods/objects 319 */ 320 acpi_status 321 acpi_ns_simple_repair(struct acpi_evaluate_info *info, 322 u32 expected_btypes, 323 u32 package_index, 324 union acpi_operand_object **return_object_ptr); 325 326 acpi_status 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); 330 331 acpi_status 332 acpi_ns_repair_null_element(struct acpi_evaluate_info *info, 333 u32 expected_btypes, 334 u32 package_index, 335 union acpi_operand_object **return_object_ptr); 336 337 void 338 acpi_ns_remove_null_elements(struct acpi_evaluate_info *info, 339 u8 package_type, 340 union acpi_operand_object *obj_desc); 341 342 /* 343 * nsrepair2 - Return object repair for specific 344 * predefined methods/objects 345 */ 346 acpi_status 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); 351 352 /* 353 * nssearch - Namespace searching and entry 354 */ 355 acpi_status 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); 362 363 acpi_status 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); 368 369 void 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); 373 374 /* 375 * nsutils - Utility functions 376 */ 377 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); 378 379 u32 acpi_ns_local(acpi_object_type type); 380 381 void 382 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); 383 384 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); 385 386 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); 387 388 acpi_status 389 acpi_ns_internalize_name(const char *dotted_name, char **converted_name); 390 391 acpi_status 392 acpi_ns_externalize_name(u32 internal_name_length, 393 const char *internal_name, 394 u32 * converted_name_length, char **converted_name); 395 396 struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); 397 398 void acpi_ns_terminate(void); 399 400 #endif /* __ACNAMESP_H__ */ 401