1 /****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2018, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef __ACNAMESP_H__ 45 #define __ACNAMESP_H__ 46 47 /* To search the entire name space, pass this as search_base */ 48 49 #define ACPI_NS_ALL ((acpi_handle)0) 50 51 /* 52 * Elements of acpi_ns_properties are bit significant 53 * and should be one-to-one with values of acpi_object_type 54 */ 55 #define ACPI_NS_NORMAL 0 56 #define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */ 57 #define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */ 58 59 /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */ 60 61 #define ACPI_NS_NO_UPSEARCH 0 62 #define ACPI_NS_SEARCH_PARENT 0x01 63 #define ACPI_NS_DONT_OPEN_SCOPE 0x02 64 #define ACPI_NS_NO_PEER_SEARCH 0x04 65 #define ACPI_NS_ERROR_IF_FOUND 0x08 66 #define ACPI_NS_PREFIX_IS_SCOPE 0x10 67 #define ACPI_NS_EXTERNAL 0x20 68 #define ACPI_NS_TEMPORARY 0x40 69 #define ACPI_NS_OVERRIDE_IF_FOUND 0x80 70 71 /* Flags for acpi_ns_walk_namespace */ 72 73 #define ACPI_NS_WALK_NO_UNLOCK 0 74 #define ACPI_NS_WALK_UNLOCK 0x01 75 #define ACPI_NS_WALK_TEMP_NODES 0x02 76 77 /* Object is not a package element */ 78 79 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX 80 #define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1) 81 82 /* Always emit warning message, not dependent on node flags */ 83 84 #define ACPI_WARN_ALWAYS 0 85 86 /* 87 * nsinit - Namespace initialization 88 */ 89 acpi_status acpi_ns_initialize_objects(void); 90 91 acpi_status acpi_ns_initialize_devices(u32 flags); 92 93 /* 94 * nsload - Namespace loading 95 */ 96 acpi_status acpi_ns_load_namespace(void); 97 98 acpi_status 99 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); 100 101 /* 102 * nswalk - walk the namespace 103 */ 104 acpi_status 105 acpi_ns_walk_namespace(acpi_object_type type, 106 acpi_handle start_object, 107 u32 max_depth, 108 u32 flags, 109 acpi_walk_callback descending_callback, 110 acpi_walk_callback ascending_callback, 111 void *context, void **return_value); 112 113 struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node 114 *parent, 115 struct acpi_namespace_node 116 *child); 117 118 struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, 119 struct 120 acpi_namespace_node 121 *parent, 122 struct 123 acpi_namespace_node 124 *child); 125 126 /* 127 * nsparse - table parsing 128 */ 129 acpi_status 130 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); 131 132 acpi_status 133 acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node); 134 135 acpi_status 136 acpi_ns_one_complete_parse(u32 pass_number, 137 u32 table_index, 138 struct acpi_namespace_node *start_node); 139 140 /* 141 * nsaccess - Top-level namespace access 142 */ 143 acpi_status acpi_ns_root_initialize(void); 144 145 acpi_status 146 acpi_ns_lookup(union acpi_generic_state *scope_info, 147 char *name, 148 acpi_object_type type, 149 acpi_interpreter_mode interpreter_mode, 150 u32 flags, 151 struct acpi_walk_state *walk_state, 152 struct acpi_namespace_node **ret_node); 153 154 /* 155 * nsalloc - Named object allocation/deallocation 156 */ 157 struct acpi_namespace_node *acpi_ns_create_node(u32 name); 158 159 void acpi_ns_delete_node(struct acpi_namespace_node *node); 160 161 void acpi_ns_remove_node(struct acpi_namespace_node *node); 162 163 void 164 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); 165 166 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); 167 168 void acpi_ns_detach_object(struct acpi_namespace_node *node); 169 170 void acpi_ns_delete_children(struct acpi_namespace_node *parent); 171 172 int acpi_ns_compare_names(char *name1, char *name2); 173 174 /* 175 * nsconvert - Dynamic object conversion routines 176 */ 177 acpi_status 178 acpi_ns_convert_to_integer(union acpi_operand_object *original_object, 179 union acpi_operand_object **return_object); 180 181 acpi_status 182 acpi_ns_convert_to_string(union acpi_operand_object *original_object, 183 union acpi_operand_object **return_object); 184 185 acpi_status 186 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, 187 union acpi_operand_object **return_object); 188 189 acpi_status 190 acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope, 191 union acpi_operand_object *original_object, 192 union acpi_operand_object **return_object); 193 194 acpi_status 195 acpi_ns_convert_to_resource(struct acpi_namespace_node *scope, 196 union acpi_operand_object *original_object, 197 union acpi_operand_object **return_object); 198 199 acpi_status 200 acpi_ns_convert_to_reference(struct acpi_namespace_node *scope, 201 union acpi_operand_object *original_object, 202 union acpi_operand_object **return_object); 203 204 /* 205 * nsdump - Namespace dump/print utilities 206 */ 207 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); 208 209 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); 210 211 void 212 acpi_ns_dump_pathname(acpi_handle handle, 213 const char *msg, u32 level, u32 component); 214 215 void acpi_ns_print_pathname(u32 num_segments, const char *pathname); 216 217 acpi_status 218 acpi_ns_dump_one_object(acpi_handle obj_handle, 219 u32 level, void *context, void **return_value); 220 221 void 222 acpi_ns_dump_objects(acpi_object_type type, 223 u8 display_type, 224 u32 max_depth, 225 acpi_owner_id owner_id, acpi_handle start_handle); 226 227 void 228 acpi_ns_dump_object_paths(acpi_object_type type, 229 u8 display_type, 230 u32 max_depth, 231 acpi_owner_id owner_id, acpi_handle start_handle); 232 233 /* 234 * nseval - Namespace evaluation functions 235 */ 236 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); 237 238 void acpi_ns_exec_module_code_list(void); 239 240 /* 241 * nsarguments - Argument count/type checking for predefined/reserved names 242 */ 243 void 244 acpi_ns_check_argument_count(char *pathname, 245 struct acpi_namespace_node *node, 246 u32 user_param_count, 247 const union acpi_predefined_info *info); 248 249 void 250 acpi_ns_check_acpi_compliance(char *pathname, 251 struct acpi_namespace_node *node, 252 const union acpi_predefined_info *predefined); 253 254 void acpi_ns_check_argument_types(struct acpi_evaluate_info *info); 255 256 /* 257 * nspredef - Return value checking for predefined/reserved names 258 */ 259 acpi_status 260 acpi_ns_check_return_value(struct acpi_namespace_node *node, 261 struct acpi_evaluate_info *info, 262 u32 user_param_count, 263 acpi_status return_status, 264 union acpi_operand_object **return_object); 265 266 acpi_status 267 acpi_ns_check_object_type(struct acpi_evaluate_info *info, 268 union acpi_operand_object **return_object_ptr, 269 u32 expected_btypes, u32 package_index); 270 271 /* 272 * nsprepkg - Validation of predefined name packages 273 */ 274 acpi_status 275 acpi_ns_check_package(struct acpi_evaluate_info *info, 276 union acpi_operand_object **return_object_ptr); 277 278 /* 279 * nsnames - Name and Scope manipulation 280 */ 281 u32 acpi_ns_opens_scope(acpi_object_type type); 282 283 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); 284 285 u32 286 acpi_ns_build_normalized_path(struct acpi_namespace_node *node, 287 char *full_path, u32 path_size, u8 no_trailing); 288 289 char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node, 290 u8 no_trailing); 291 292 char *acpi_ns_build_prefixed_pathname(union acpi_generic_state *prefix_scope, 293 const char *internal_path); 294 295 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); 296 297 acpi_status 298 acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer); 299 300 acpi_status 301 acpi_ns_handle_to_pathname(acpi_handle target_handle, 302 struct acpi_buffer *buffer, u8 no_trailing); 303 304 u8 305 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); 306 307 acpi_status 308 acpi_ns_get_node_unlocked(struct acpi_namespace_node *prefix_node, 309 const char *external_pathname, 310 u32 flags, struct acpi_namespace_node **out_node); 311 312 acpi_status 313 acpi_ns_get_node(struct acpi_namespace_node *prefix_node, 314 const char *external_pathname, 315 u32 flags, struct acpi_namespace_node **out_node); 316 317 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); 318 319 /* 320 * nsobject - Object management for namespace nodes 321 */ 322 acpi_status 323 acpi_ns_attach_object(struct acpi_namespace_node *node, 324 union acpi_operand_object *object, acpi_object_type type); 325 326 union acpi_operand_object *acpi_ns_get_attached_object(struct 327 acpi_namespace_node 328 *node); 329 330 union acpi_operand_object *acpi_ns_get_secondary_object(union 331 acpi_operand_object 332 *obj_desc); 333 334 acpi_status 335 acpi_ns_attach_data(struct acpi_namespace_node *node, 336 acpi_object_handler handler, void *data); 337 338 acpi_status 339 acpi_ns_detach_data(struct acpi_namespace_node *node, 340 acpi_object_handler handler); 341 342 acpi_status 343 acpi_ns_get_attached_data(struct acpi_namespace_node *node, 344 acpi_object_handler handler, void **data); 345 346 /* 347 * nsrepair - General return object repair for all 348 * predefined methods/objects 349 */ 350 acpi_status 351 acpi_ns_simple_repair(struct acpi_evaluate_info *info, 352 u32 expected_btypes, 353 u32 package_index, 354 union acpi_operand_object **return_object_ptr); 355 356 acpi_status 357 acpi_ns_wrap_with_package(struct acpi_evaluate_info *info, 358 union acpi_operand_object *original_object, 359 union acpi_operand_object **obj_desc_ptr); 360 361 acpi_status 362 acpi_ns_repair_null_element(struct acpi_evaluate_info *info, 363 u32 expected_btypes, 364 u32 package_index, 365 union acpi_operand_object **return_object_ptr); 366 367 void 368 acpi_ns_remove_null_elements(struct acpi_evaluate_info *info, 369 u8 package_type, 370 union acpi_operand_object *obj_desc); 371 372 /* 373 * nsrepair2 - Return object repair for specific 374 * predefined methods/objects 375 */ 376 acpi_status 377 acpi_ns_complex_repairs(struct acpi_evaluate_info *info, 378 struct acpi_namespace_node *node, 379 acpi_status validate_status, 380 union acpi_operand_object **return_object_ptr); 381 382 /* 383 * nssearch - Namespace searching and entry 384 */ 385 acpi_status 386 acpi_ns_search_and_enter(u32 entry_name, 387 struct acpi_walk_state *walk_state, 388 struct acpi_namespace_node *node, 389 acpi_interpreter_mode interpreter_mode, 390 acpi_object_type type, 391 u32 flags, struct acpi_namespace_node **ret_node); 392 393 acpi_status 394 acpi_ns_search_one_scope(u32 entry_name, 395 struct acpi_namespace_node *node, 396 acpi_object_type type, 397 struct acpi_namespace_node **ret_node); 398 399 void 400 acpi_ns_install_node(struct acpi_walk_state *walk_state, 401 struct acpi_namespace_node *parent_node, 402 struct acpi_namespace_node *node, acpi_object_type type); 403 404 /* 405 * nsutils - Utility functions 406 */ 407 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); 408 409 u32 acpi_ns_local(acpi_object_type type); 410 411 void 412 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); 413 414 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); 415 416 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); 417 418 acpi_status 419 acpi_ns_internalize_name(const char *dotted_name, char **converted_name); 420 421 acpi_status 422 acpi_ns_externalize_name(u32 internal_name_length, 423 const char *internal_name, 424 u32 * converted_name_length, char **converted_name); 425 426 struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); 427 428 void acpi_ns_terminate(void); 429 430 #endif /* __ACNAMESP_H__ */ 431