1 /****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, 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_one_complete_parse(u32 pass_number, 134 u32 table_index, 135 struct acpi_namespace_node *start_node); 136 137 /* 138 * nsaccess - Top-level namespace access 139 */ 140 acpi_status acpi_ns_root_initialize(void); 141 142 acpi_status 143 acpi_ns_lookup(union acpi_generic_state *scope_info, 144 char *name, 145 acpi_object_type type, 146 acpi_interpreter_mode interpreter_mode, 147 u32 flags, 148 struct acpi_walk_state *walk_state, 149 struct acpi_namespace_node **ret_node); 150 151 /* 152 * nsalloc - Named object allocation/deallocation 153 */ 154 struct acpi_namespace_node *acpi_ns_create_node(u32 name); 155 156 void acpi_ns_delete_node(struct acpi_namespace_node *node); 157 158 void acpi_ns_remove_node(struct acpi_namespace_node *node); 159 160 void 161 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); 162 163 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); 164 165 void acpi_ns_detach_object(struct acpi_namespace_node *node); 166 167 void acpi_ns_delete_children(struct acpi_namespace_node *parent); 168 169 int acpi_ns_compare_names(char *name1, char *name2); 170 171 /* 172 * nsconvert - Dynamic object conversion routines 173 */ 174 acpi_status 175 acpi_ns_convert_to_integer(union acpi_operand_object *original_object, 176 union acpi_operand_object **return_object); 177 178 acpi_status 179 acpi_ns_convert_to_string(union acpi_operand_object *original_object, 180 union acpi_operand_object **return_object); 181 182 acpi_status 183 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, 184 union acpi_operand_object **return_object); 185 186 acpi_status 187 acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope, 188 union acpi_operand_object *original_object, 189 union acpi_operand_object **return_object); 190 191 acpi_status 192 acpi_ns_convert_to_resource(struct acpi_namespace_node *scope, 193 union acpi_operand_object *original_object, 194 union acpi_operand_object **return_object); 195 196 acpi_status 197 acpi_ns_convert_to_reference(struct acpi_namespace_node *scope, 198 union acpi_operand_object *original_object, 199 union acpi_operand_object **return_object); 200 201 /* 202 * nsdump - Namespace dump/print utilities 203 */ 204 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); 205 206 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); 207 208 void 209 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); 210 211 void acpi_ns_print_pathname(u32 num_segments, char *pathname); 212 213 acpi_status 214 acpi_ns_dump_one_object(acpi_handle obj_handle, 215 u32 level, void *context, void **return_value); 216 217 void 218 acpi_ns_dump_objects(acpi_object_type type, 219 u8 display_type, 220 u32 max_depth, 221 acpi_owner_id owner_id, acpi_handle start_handle); 222 223 void 224 acpi_ns_dump_object_paths(acpi_object_type type, 225 u8 display_type, 226 u32 max_depth, 227 acpi_owner_id owner_id, acpi_handle start_handle); 228 229 /* 230 * nseval - Namespace evaluation functions 231 */ 232 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); 233 234 void acpi_ns_exec_module_code_list(void); 235 236 /* 237 * nsarguments - Argument count/type checking for predefined/reserved names 238 */ 239 void 240 acpi_ns_check_argument_count(char *pathname, 241 struct acpi_namespace_node *node, 242 u32 user_param_count, 243 const union acpi_predefined_info *info); 244 245 void 246 acpi_ns_check_acpi_compliance(char *pathname, 247 struct acpi_namespace_node *node, 248 const union acpi_predefined_info *predefined); 249 250 void acpi_ns_check_argument_types(struct acpi_evaluate_info *info); 251 252 /* 253 * nspredef - Return value checking for predefined/reserved names 254 */ 255 acpi_status 256 acpi_ns_check_return_value(struct acpi_namespace_node *node, 257 struct acpi_evaluate_info *info, 258 u32 user_param_count, 259 acpi_status return_status, 260 union acpi_operand_object **return_object); 261 262 acpi_status 263 acpi_ns_check_object_type(struct acpi_evaluate_info *info, 264 union acpi_operand_object **return_object_ptr, 265 u32 expected_btypes, u32 package_index); 266 267 /* 268 * nsprepkg - Validation of predefined name packages 269 */ 270 acpi_status 271 acpi_ns_check_package(struct acpi_evaluate_info *info, 272 union acpi_operand_object **return_object_ptr); 273 274 /* 275 * nsnames - Name and Scope manipulation 276 */ 277 u32 acpi_ns_opens_scope(acpi_object_type type); 278 279 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); 280 281 u32 282 acpi_ns_build_normalized_path(struct acpi_namespace_node *node, 283 char *full_path, u32 path_size, u8 no_trailing); 284 285 char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node, 286 u8 no_trailing); 287 288 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); 289 290 acpi_status 291 acpi_ns_handle_to_pathname(acpi_handle target_handle, 292 struct acpi_buffer *buffer, u8 no_trailing); 293 294 u8 295 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); 296 297 acpi_status 298 acpi_ns_get_node(struct acpi_namespace_node *prefix_node, 299 const char *external_pathname, 300 u32 flags, struct acpi_namespace_node **out_node); 301 302 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); 303 304 /* 305 * nsobject - Object management for namespace nodes 306 */ 307 acpi_status 308 acpi_ns_attach_object(struct acpi_namespace_node *node, 309 union acpi_operand_object *object, acpi_object_type type); 310 311 union acpi_operand_object *acpi_ns_get_attached_object(struct 312 acpi_namespace_node 313 *node); 314 315 union acpi_operand_object *acpi_ns_get_secondary_object(union 316 acpi_operand_object 317 *obj_desc); 318 319 acpi_status 320 acpi_ns_attach_data(struct acpi_namespace_node *node, 321 acpi_object_handler handler, void *data); 322 323 acpi_status 324 acpi_ns_detach_data(struct acpi_namespace_node *node, 325 acpi_object_handler handler); 326 327 acpi_status 328 acpi_ns_get_attached_data(struct acpi_namespace_node *node, 329 acpi_object_handler handler, void **data); 330 331 /* 332 * nsrepair - General return object repair for all 333 * predefined methods/objects 334 */ 335 acpi_status 336 acpi_ns_simple_repair(struct acpi_evaluate_info *info, 337 u32 expected_btypes, 338 u32 package_index, 339 union acpi_operand_object **return_object_ptr); 340 341 acpi_status 342 acpi_ns_wrap_with_package(struct acpi_evaluate_info *info, 343 union acpi_operand_object *original_object, 344 union acpi_operand_object **obj_desc_ptr); 345 346 acpi_status 347 acpi_ns_repair_null_element(struct acpi_evaluate_info *info, 348 u32 expected_btypes, 349 u32 package_index, 350 union acpi_operand_object **return_object_ptr); 351 352 void 353 acpi_ns_remove_null_elements(struct acpi_evaluate_info *info, 354 u8 package_type, 355 union acpi_operand_object *obj_desc); 356 357 /* 358 * nsrepair2 - Return object repair for specific 359 * predefined methods/objects 360 */ 361 acpi_status 362 acpi_ns_complex_repairs(struct acpi_evaluate_info *info, 363 struct acpi_namespace_node *node, 364 acpi_status validate_status, 365 union acpi_operand_object **return_object_ptr); 366 367 /* 368 * nssearch - Namespace searching and entry 369 */ 370 acpi_status 371 acpi_ns_search_and_enter(u32 entry_name, 372 struct acpi_walk_state *walk_state, 373 struct acpi_namespace_node *node, 374 acpi_interpreter_mode interpreter_mode, 375 acpi_object_type type, 376 u32 flags, struct acpi_namespace_node **ret_node); 377 378 acpi_status 379 acpi_ns_search_one_scope(u32 entry_name, 380 struct acpi_namespace_node *node, 381 acpi_object_type type, 382 struct acpi_namespace_node **ret_node); 383 384 void 385 acpi_ns_install_node(struct acpi_walk_state *walk_state, 386 struct acpi_namespace_node *parent_node, 387 struct acpi_namespace_node *node, acpi_object_type type); 388 389 /* 390 * nsutils - Utility functions 391 */ 392 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); 393 394 u32 acpi_ns_local(acpi_object_type type); 395 396 void 397 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); 398 399 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); 400 401 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); 402 403 acpi_status 404 acpi_ns_internalize_name(const char *dotted_name, char **converted_name); 405 406 acpi_status 407 acpi_ns_externalize_name(u32 internal_name_length, 408 const char *internal_name, 409 u32 * converted_name_length, char **converted_name); 410 411 struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); 412 413 void acpi_ns_terminate(void); 414 415 #endif /* __ACNAMESP_H__ */ 416