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 /* 77 * nsinit - Namespace initialization 78 */ 79 acpi_status acpi_ns_initialize_objects(void); 80 81 acpi_status acpi_ns_initialize_devices(void); 82 83 /* 84 * nsload - Namespace loading 85 */ 86 acpi_status acpi_ns_load_namespace(void); 87 88 acpi_status 89 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node); 90 91 /* 92 * nswalk - walk the namespace 93 */ 94 acpi_status 95 acpi_ns_walk_namespace(acpi_object_type type, 96 acpi_handle start_object, 97 u32 max_depth, 98 u32 flags, 99 acpi_walk_callback user_function, 100 void *context, void **return_value); 101 102 struct acpi_namespace_node *acpi_ns_get_next_node(acpi_object_type type, struct acpi_namespace_node 103 *parent, struct acpi_namespace_node 104 *child); 105 106 /* 107 * nsparse - table parsing 108 */ 109 acpi_status 110 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node); 111 112 acpi_status 113 acpi_ns_one_complete_parse(u32 pass_number, 114 u32 table_index, 115 struct acpi_namespace_node *start_node); 116 117 /* 118 * nsaccess - Top-level namespace access 119 */ 120 acpi_status acpi_ns_root_initialize(void); 121 122 acpi_status 123 acpi_ns_lookup(union acpi_generic_state *scope_info, 124 char *name, 125 acpi_object_type type, 126 acpi_interpreter_mode interpreter_mode, 127 u32 flags, 128 struct acpi_walk_state *walk_state, 129 struct acpi_namespace_node **ret_node); 130 131 /* 132 * nsalloc - Named object allocation/deallocation 133 */ 134 struct acpi_namespace_node *acpi_ns_create_node(u32 name); 135 136 void acpi_ns_delete_node(struct acpi_namespace_node *node); 137 138 void 139 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); 140 141 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); 142 143 void acpi_ns_detach_object(struct acpi_namespace_node *node); 144 145 void acpi_ns_delete_children(struct acpi_namespace_node *parent); 146 147 int acpi_ns_compare_names(char *name1, char *name2); 148 149 /* 150 * nsdump - Namespace dump/print utilities 151 */ 152 #ifdef ACPI_FUTURE_USAGE 153 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); 154 #endif /* ACPI_FUTURE_USAGE */ 155 156 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); 157 158 void 159 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); 160 161 void acpi_ns_print_pathname(u32 num_segments, char *pathname); 162 163 acpi_status 164 acpi_ns_dump_one_object(acpi_handle obj_handle, 165 u32 level, void *context, void **return_value); 166 167 #ifdef ACPI_FUTURE_USAGE 168 void 169 acpi_ns_dump_objects(acpi_object_type type, 170 u8 display_type, 171 u32 max_depth, 172 acpi_owner_id owner_id, acpi_handle start_handle); 173 #endif /* ACPI_FUTURE_USAGE */ 174 175 /* 176 * nseval - Namespace evaluation functions 177 */ 178 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); 179 180 /* 181 * nspredef - Support for predefined/reserved names 182 */ 183 acpi_status 184 acpi_ns_check_predefined_names(struct acpi_namespace_node *node, 185 u32 user_param_count, 186 acpi_status return_status, 187 union acpi_operand_object **return_object); 188 189 const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct 190 acpi_namespace_node 191 *node); 192 193 void 194 acpi_ns_check_parameter_count(char *pathname, 195 struct acpi_namespace_node *node, 196 u32 user_param_count, 197 const union acpi_predefined_info *info); 198 199 /* 200 * nsnames - Name and Scope manipulation 201 */ 202 u32 acpi_ns_opens_scope(acpi_object_type type); 203 204 acpi_status 205 acpi_ns_build_external_path(struct acpi_namespace_node *node, 206 acpi_size size, char *name_buffer); 207 208 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); 209 210 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); 211 212 acpi_status 213 acpi_ns_handle_to_pathname(acpi_handle target_handle, 214 struct acpi_buffer *buffer); 215 216 u8 217 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); 218 219 acpi_status 220 acpi_ns_get_node(struct acpi_namespace_node *prefix_node, 221 const char *external_pathname, 222 u32 flags, struct acpi_namespace_node **out_node); 223 224 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); 225 226 /* 227 * nsobject - Object management for namespace nodes 228 */ 229 acpi_status 230 acpi_ns_attach_object(struct acpi_namespace_node *node, 231 union acpi_operand_object *object, acpi_object_type type); 232 233 union acpi_operand_object *acpi_ns_get_attached_object(struct 234 acpi_namespace_node 235 *node); 236 237 union acpi_operand_object *acpi_ns_get_secondary_object(union 238 acpi_operand_object 239 *obj_desc); 240 241 acpi_status 242 acpi_ns_attach_data(struct acpi_namespace_node *node, 243 acpi_object_handler handler, void *data); 244 245 acpi_status 246 acpi_ns_detach_data(struct acpi_namespace_node *node, 247 acpi_object_handler handler); 248 249 acpi_status 250 acpi_ns_get_attached_data(struct acpi_namespace_node *node, 251 acpi_object_handler handler, void **data); 252 253 /* 254 * nssearch - Namespace searching and entry 255 */ 256 acpi_status 257 acpi_ns_search_and_enter(u32 entry_name, 258 struct acpi_walk_state *walk_state, 259 struct acpi_namespace_node *node, 260 acpi_interpreter_mode interpreter_mode, 261 acpi_object_type type, 262 u32 flags, struct acpi_namespace_node **ret_node); 263 264 acpi_status 265 acpi_ns_search_one_scope(u32 entry_name, 266 struct acpi_namespace_node *node, 267 acpi_object_type type, 268 struct acpi_namespace_node **ret_node); 269 270 void 271 acpi_ns_install_node(struct acpi_walk_state *walk_state, 272 struct acpi_namespace_node *parent_node, 273 struct acpi_namespace_node *node, acpi_object_type type); 274 275 /* 276 * nsutils - Utility functions 277 */ 278 u8 acpi_ns_valid_root_prefix(char prefix); 279 280 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); 281 282 u32 acpi_ns_local(acpi_object_type type); 283 284 void 285 acpi_ns_report_error(const char *module_name, 286 u32 line_number, 287 const char *internal_name, acpi_status lookup_status); 288 289 void 290 acpi_ns_report_method_error(const char *module_name, 291 u32 line_number, 292 const char *message, 293 struct acpi_namespace_node *node, 294 const char *path, acpi_status lookup_status); 295 296 void 297 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg); 298 299 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); 300 301 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); 302 303 acpi_status 304 acpi_ns_internalize_name(const char *dotted_name, char **converted_name); 305 306 acpi_status 307 acpi_ns_externalize_name(u32 internal_name_length, 308 const char *internal_name, 309 u32 * converted_name_length, char **converted_name); 310 311 struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle); 312 313 acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node); 314 315 void acpi_ns_terminate(void); 316 317 struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node 318 *node); 319 320 struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct 321 acpi_namespace_node 322 *node); 323 324 #endif /* __ACNAMESP_H__ */ 325