1 /****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2013, 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 70 /* Flags for acpi_ns_walk_namespace */ 71 72 #define ACPI_NS_WALK_NO_UNLOCK 0 73 #define ACPI_NS_WALK_UNLOCK 0x01 74 #define ACPI_NS_WALK_TEMP_NODES 0x02 75 76 /* Object is not a package element */ 77 78 #define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX 79 80 /* Always emit warning message, not dependent on node flags */ 81 82 #define ACPI_WARN_ALWAYS 0 83 84 /* 85 * nsinit - Namespace initialization 86 */ 87 acpi_status acpi_ns_initialize_objects(void); 88 89 acpi_status acpi_ns_initialize_devices(void); 90 91 /* 92 * nsload - Namespace loading 93 */ 94 acpi_status acpi_ns_load_namespace(void); 95 96 acpi_status 97 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); 98 99 /* 100 * nswalk - walk the namespace 101 */ 102 acpi_status 103 acpi_ns_walk_namespace(acpi_object_type type, 104 acpi_handle start_object, 105 u32 max_depth, 106 u32 flags, 107 acpi_walk_callback pre_order_visit, 108 acpi_walk_callback post_order_visit, 109 void *context, void **return_value); 110 111 struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node 112 *parent, 113 struct acpi_namespace_node 114 *child); 115 116 struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, 117 struct 118 acpi_namespace_node 119 *parent, 120 struct 121 acpi_namespace_node 122 *child); 123 124 /* 125 * nsparse - table parsing 126 */ 127 acpi_status 128 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); 129 130 acpi_status 131 acpi_ns_one_complete_parse(u32 pass_number, 132 u32 table_index, 133 struct acpi_namespace_node *start_node); 134 135 /* 136 * nsaccess - Top-level namespace access 137 */ 138 acpi_status acpi_ns_root_initialize(void); 139 140 acpi_status 141 acpi_ns_lookup(union acpi_generic_state *scope_info, 142 char *name, 143 acpi_object_type type, 144 acpi_interpreter_mode interpreter_mode, 145 u32 flags, 146 struct acpi_walk_state *walk_state, 147 struct acpi_namespace_node **ret_node); 148 149 /* 150 * nsalloc - Named object allocation/deallocation 151 */ 152 struct acpi_namespace_node *acpi_ns_create_node(u32 name); 153 154 void acpi_ns_delete_node(struct acpi_namespace_node *node); 155 156 void acpi_ns_remove_node(struct acpi_namespace_node *node); 157 158 void 159 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); 160 161 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); 162 163 void acpi_ns_detach_object(struct acpi_namespace_node *node); 164 165 void acpi_ns_delete_children(struct acpi_namespace_node *parent); 166 167 int acpi_ns_compare_names(char *name1, char *name2); 168 169 /* 170 * nsconvert - Dynamic object conversion routines 171 */ 172 acpi_status 173 acpi_ns_convert_to_integer(union acpi_operand_object *original_object, 174 union acpi_operand_object **return_object); 175 176 acpi_status 177 acpi_ns_convert_to_string(union acpi_operand_object *original_object, 178 union acpi_operand_object **return_object); 179 180 acpi_status 181 acpi_ns_convert_to_buffer(union acpi_operand_object *original_object, 182 union acpi_operand_object **return_object); 183 184 acpi_status 185 acpi_ns_convert_to_unicode(union acpi_operand_object *original_object, 186 union acpi_operand_object **return_object); 187 188 acpi_status 189 acpi_ns_convert_to_resource(union acpi_operand_object *original_object, 190 union acpi_operand_object **return_object); 191 192 /* 193 * nsdump - Namespace dump/print utilities 194 */ 195 #ifdef ACPI_FUTURE_USAGE 196 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); 197 #endif /* ACPI_FUTURE_USAGE */ 198 199 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); 200 201 void 202 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); 203 204 void acpi_ns_print_pathname(u32 num_segments, char *pathname); 205 206 acpi_status 207 acpi_ns_dump_one_object(acpi_handle obj_handle, 208 u32 level, void *context, void **return_value); 209 210 #ifdef ACPI_FUTURE_USAGE 211 void 212 acpi_ns_dump_objects(acpi_object_type type, 213 u8 display_type, 214 u32 max_depth, 215 acpi_owner_id owner_id, acpi_handle start_handle); 216 #endif /* ACPI_FUTURE_USAGE */ 217 218 /* 219 * nseval - Namespace evaluation functions 220 */ 221 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); 222 223 void acpi_ns_exec_module_code_list(void); 224 225 /* 226 * nspredef - Support for predefined/reserved names 227 */ 228 acpi_status 229 acpi_ns_check_predefined_names(struct acpi_namespace_node *node, 230 u32 user_param_count, 231 acpi_status return_status, 232 union acpi_operand_object **return_object); 233 234 void 235 acpi_ns_check_parameter_count(char *pathname, 236 struct acpi_namespace_node *node, 237 u32 user_param_count, 238 const union acpi_predefined_info *info); 239 240 acpi_status 241 acpi_ns_check_object_type(struct acpi_predefined_data *data, 242 union acpi_operand_object **return_object_ptr, 243 u32 expected_btypes, u32 package_index); 244 245 /* 246 * nsprepkg - Validation of predefined name packages 247 */ 248 acpi_status 249 acpi_ns_check_package(struct acpi_predefined_data *data, 250 union acpi_operand_object **return_object_ptr); 251 252 /* 253 * nsnames - Name and Scope manipulation 254 */ 255 u32 acpi_ns_opens_scope(acpi_object_type type); 256 257 acpi_status 258 acpi_ns_build_external_path(struct acpi_namespace_node *node, 259 acpi_size size, char *name_buffer); 260 261 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); 262 263 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); 264 265 acpi_status 266 acpi_ns_handle_to_pathname(acpi_handle target_handle, 267 struct acpi_buffer *buffer); 268 269 u8 270 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); 271 272 acpi_status 273 acpi_ns_get_node(struct acpi_namespace_node *prefix_node, 274 const char *external_pathname, 275 u32 flags, struct acpi_namespace_node **out_node); 276 277 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); 278 279 /* 280 * nsobject - Object management for namespace nodes 281 */ 282 acpi_status 283 acpi_ns_attach_object(struct acpi_namespace_node *node, 284 union acpi_operand_object *object, acpi_object_type type); 285 286 union acpi_operand_object *acpi_ns_get_attached_object(struct 287 acpi_namespace_node 288 *node); 289 290 union acpi_operand_object *acpi_ns_get_secondary_object(union 291 acpi_operand_object 292 *obj_desc); 293 294 acpi_status 295 acpi_ns_attach_data(struct acpi_namespace_node *node, 296 acpi_object_handler handler, void *data); 297 298 acpi_status 299 acpi_ns_detach_data(struct acpi_namespace_node *node, 300 acpi_object_handler handler); 301 302 acpi_status 303 acpi_ns_get_attached_data(struct acpi_namespace_node *node, 304 acpi_object_handler handler, void **data); 305 306 /* 307 * nsrepair - General return object repair for all 308 * predefined methods/objects 309 */ 310 acpi_status 311 acpi_ns_simple_repair(struct acpi_predefined_data *data, 312 u32 expected_btypes, 313 u32 package_index, 314 union acpi_operand_object **return_object_ptr); 315 316 acpi_status 317 acpi_ns_wrap_with_package(struct acpi_predefined_data *data, 318 union acpi_operand_object *original_object, 319 union acpi_operand_object **obj_desc_ptr); 320 321 acpi_status 322 acpi_ns_repair_null_element(struct acpi_predefined_data *data, 323 u32 expected_btypes, 324 u32 package_index, 325 union acpi_operand_object **return_object_ptr); 326 327 void 328 acpi_ns_remove_null_elements(struct acpi_predefined_data *data, 329 u8 package_type, 330 union acpi_operand_object *obj_desc); 331 332 /* 333 * nsrepair2 - Return object repair for specific 334 * predefined methods/objects 335 */ 336 acpi_status 337 acpi_ns_complex_repairs(struct acpi_predefined_data *data, 338 struct acpi_namespace_node *node, 339 acpi_status validate_status, 340 union acpi_operand_object **return_object_ptr); 341 342 /* 343 * nssearch - Namespace searching and entry 344 */ 345 acpi_status 346 acpi_ns_search_and_enter(u32 entry_name, 347 struct acpi_walk_state *walk_state, 348 struct acpi_namespace_node *node, 349 acpi_interpreter_mode interpreter_mode, 350 acpi_object_type type, 351 u32 flags, struct acpi_namespace_node **ret_node); 352 353 acpi_status 354 acpi_ns_search_one_scope(u32 entry_name, 355 struct acpi_namespace_node *node, 356 acpi_object_type type, 357 struct acpi_namespace_node **ret_node); 358 359 void 360 acpi_ns_install_node(struct acpi_walk_state *walk_state, 361 struct acpi_namespace_node *parent_node, 362 struct acpi_namespace_node *node, acpi_object_type type); 363 364 /* 365 * nsutils - Utility functions 366 */ 367 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); 368 369 u32 acpi_ns_local(acpi_object_type type); 370 371 void 372 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); 373 374 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); 375 376 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); 377 378 acpi_status 379 acpi_ns_internalize_name(const char *dotted_name, char **converted_name); 380 381 acpi_status 382 acpi_ns_externalize_name(u32 internal_name_length, 383 const char *internal_name, 384 u32 * converted_name_length, char **converted_name); 385 386 struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle); 387 388 void acpi_ns_terminate(void); 389 390 #endif /* __ACNAMESP_H__ */ 391