1 /****************************************************************************** 2 * 3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2008, 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 user_function, 108 void *context, void **return_value); 109 110 struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node 111 *parent, 112 struct acpi_namespace_node 113 *child); 114 115 struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type, 116 struct 117 acpi_namespace_node 118 *parent, 119 struct 120 acpi_namespace_node 121 *child); 122 123 /* 124 * nsparse - table parsing 125 */ 126 acpi_status 127 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); 128 129 acpi_status 130 acpi_ns_one_complete_parse(u32 pass_number, 131 u32 table_index, 132 struct acpi_namespace_node *start_node); 133 134 /* 135 * nsaccess - Top-level namespace access 136 */ 137 acpi_status acpi_ns_root_initialize(void); 138 139 acpi_status 140 acpi_ns_lookup(union acpi_generic_state *scope_info, 141 char *name, 142 acpi_object_type type, 143 acpi_interpreter_mode interpreter_mode, 144 u32 flags, 145 struct acpi_walk_state *walk_state, 146 struct acpi_namespace_node **ret_node); 147 148 /* 149 * nsalloc - Named object allocation/deallocation 150 */ 151 struct acpi_namespace_node *acpi_ns_create_node(u32 name); 152 153 void acpi_ns_delete_node(struct acpi_namespace_node *node); 154 155 void acpi_ns_remove_node(struct acpi_namespace_node *node); 156 157 void 158 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); 159 160 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); 161 162 void acpi_ns_detach_object(struct acpi_namespace_node *node); 163 164 void acpi_ns_delete_children(struct acpi_namespace_node *parent); 165 166 int acpi_ns_compare_names(char *name1, char *name2); 167 168 /* 169 * nsdump - Namespace dump/print utilities 170 */ 171 #ifdef ACPI_FUTURE_USAGE 172 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); 173 #endif /* ACPI_FUTURE_USAGE */ 174 175 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); 176 177 void 178 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); 179 180 void acpi_ns_print_pathname(u32 num_segments, char *pathname); 181 182 acpi_status 183 acpi_ns_dump_one_object(acpi_handle obj_handle, 184 u32 level, void *context, void **return_value); 185 186 #ifdef ACPI_FUTURE_USAGE 187 void 188 acpi_ns_dump_objects(acpi_object_type type, 189 u8 display_type, 190 u32 max_depth, 191 acpi_owner_id owner_id, acpi_handle start_handle); 192 #endif /* ACPI_FUTURE_USAGE */ 193 194 /* 195 * nseval - Namespace evaluation functions 196 */ 197 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); 198 199 void acpi_ns_exec_module_code_list(void); 200 201 /* 202 * nspredef - Support for predefined/reserved names 203 */ 204 acpi_status 205 acpi_ns_check_predefined_names(struct acpi_namespace_node *node, 206 u32 user_param_count, 207 acpi_status return_status, 208 union acpi_operand_object **return_object); 209 210 const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct 211 acpi_namespace_node 212 *node); 213 214 void 215 acpi_ns_check_parameter_count(char *pathname, 216 struct acpi_namespace_node *node, 217 u32 user_param_count, 218 const union acpi_predefined_info *info); 219 220 /* 221 * nsnames - Name and Scope manipulation 222 */ 223 u32 acpi_ns_opens_scope(acpi_object_type type); 224 225 acpi_status 226 acpi_ns_build_external_path(struct acpi_namespace_node *node, 227 acpi_size size, char *name_buffer); 228 229 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); 230 231 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); 232 233 acpi_status 234 acpi_ns_handle_to_pathname(acpi_handle target_handle, 235 struct acpi_buffer *buffer); 236 237 u8 238 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); 239 240 acpi_status 241 acpi_ns_get_node(struct acpi_namespace_node *prefix_node, 242 const char *external_pathname, 243 u32 flags, struct acpi_namespace_node **out_node); 244 245 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); 246 247 /* 248 * nsobject - Object management for namespace nodes 249 */ 250 acpi_status 251 acpi_ns_attach_object(struct acpi_namespace_node *node, 252 union acpi_operand_object *object, acpi_object_type type); 253 254 union acpi_operand_object *acpi_ns_get_attached_object(struct 255 acpi_namespace_node 256 *node); 257 258 union acpi_operand_object *acpi_ns_get_secondary_object(union 259 acpi_operand_object 260 *obj_desc); 261 262 acpi_status 263 acpi_ns_attach_data(struct acpi_namespace_node *node, 264 acpi_object_handler handler, void *data); 265 266 acpi_status 267 acpi_ns_detach_data(struct acpi_namespace_node *node, 268 acpi_object_handler handler); 269 270 acpi_status 271 acpi_ns_get_attached_data(struct acpi_namespace_node *node, 272 acpi_object_handler handler, void **data); 273 274 /* 275 * nsrepair - return object repair for predefined methods/objects 276 */ 277 acpi_status 278 acpi_ns_repair_object(struct acpi_predefined_data *data, 279 u32 expected_btypes, 280 u32 package_index, 281 union acpi_operand_object **return_object_ptr); 282 283 acpi_status 284 acpi_ns_repair_package_list(struct acpi_predefined_data *data, 285 union acpi_operand_object **obj_desc_ptr); 286 287 /* 288 * nssearch - Namespace searching and entry 289 */ 290 acpi_status 291 acpi_ns_search_and_enter(u32 entry_name, 292 struct acpi_walk_state *walk_state, 293 struct acpi_namespace_node *node, 294 acpi_interpreter_mode interpreter_mode, 295 acpi_object_type type, 296 u32 flags, struct acpi_namespace_node **ret_node); 297 298 acpi_status 299 acpi_ns_search_one_scope(u32 entry_name, 300 struct acpi_namespace_node *node, 301 acpi_object_type type, 302 struct acpi_namespace_node **ret_node); 303 304 void 305 acpi_ns_install_node(struct acpi_walk_state *walk_state, 306 struct acpi_namespace_node *parent_node, 307 struct acpi_namespace_node *node, acpi_object_type type); 308 309 /* 310 * nsutils - Utility functions 311 */ 312 u8 acpi_ns_valid_root_prefix(char prefix); 313 314 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); 315 316 u32 acpi_ns_local(acpi_object_type type); 317 318 void 319 acpi_ns_report_error(const char *module_name, 320 u32 line_number, 321 const char *internal_name, acpi_status lookup_status); 322 323 void 324 acpi_ns_report_method_error(const char *module_name, 325 u32 line_number, 326 const char *message, 327 struct acpi_namespace_node *node, 328 const char *path, acpi_status lookup_status); 329 330 void 331 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); 332 333 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); 334 335 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); 336 337 acpi_status 338 acpi_ns_internalize_name(const char *dotted_name, char **converted_name); 339 340 acpi_status 341 acpi_ns_externalize_name(u32 internal_name_length, 342 const char *internal_name, 343 u32 * converted_name_length, char **converted_name); 344 345 struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle); 346 347 acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node); 348 349 void acpi_ns_terminate(void); 350 351 struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node 352 *node); 353 354 struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct 355 acpi_namespace_node 356 *node); 357 358 #endif /* __ACNAMESP_H__ */ 359