include/acpi/acnamesp.h

   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                                union acpi_operand_object *return_object);
 186
 187 const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct
 188                                                                     acpi_namespace_node
 189                                                                     *node);
 190
 191 void
 192 acpi_ns_check_parameter_count(char *pathname,
 193                               struct acpi_namespace_node *node,
 194                               const union acpi_predefined_info *info);
 195
 196 /*
 197  * nsnames - Name and Scope manipulation
 198  */
 199 u32 acpi_ns_opens_scope(acpi_object_type type);
 200
 201 acpi_status
 202 acpi_ns_build_external_path(struct acpi_namespace_node *node,
 203                             acpi_size size, char *name_buffer);
 204
 205 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
 206
 207 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
 208
 209 acpi_status
 210 acpi_ns_handle_to_pathname(acpi_handle target_handle,
 211                            struct acpi_buffer *buffer);
 212
 213 u8
 214 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
 215
 216 acpi_status
 217 acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
 218                  const char *external_pathname,
 219                  u32 flags, struct acpi_namespace_node **out_node);
 220
 221 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
 222
 223 /*
 224  * nsobject - Object management for namespace nodes
 225  */
 226 acpi_status
 227 acpi_ns_attach_object(struct acpi_namespace_node *node,
 228                       union acpi_operand_object *object, acpi_object_type type);
 229
 230 union acpi_operand_object *acpi_ns_get_attached_object(struct
 231                                                        acpi_namespace_node
 232                                                        *node);
 233
 234 union acpi_operand_object *acpi_ns_get_secondary_object(union
 235                                                         acpi_operand_object
 236                                                         *obj_desc);
 237
 238 acpi_status
 239 acpi_ns_attach_data(struct acpi_namespace_node *node,
 240                     acpi_object_handler handler, void *data);
 241
 242 acpi_status
 243 acpi_ns_detach_data(struct acpi_namespace_node *node,
 244                     acpi_object_handler handler);
 245
 246 acpi_status
 247 acpi_ns_get_attached_data(struct acpi_namespace_node *node,
 248                           acpi_object_handler handler, void **data);
 249
 250 /*
 251  * nssearch - Namespace searching and entry
 252  */
 253 acpi_status
 254 acpi_ns_search_and_enter(u32 entry_name,
 255                          struct acpi_walk_state *walk_state,
 256                          struct acpi_namespace_node *node,
 257                          acpi_interpreter_mode interpreter_mode,
 258                          acpi_object_type type,
 259                          u32 flags, struct acpi_namespace_node **ret_node);
 260
 261 acpi_status
 262 acpi_ns_search_one_scope(u32 entry_name,
 263                          struct acpi_namespace_node *node,
 264                          acpi_object_type type,
 265                          struct acpi_namespace_node **ret_node);
 266
 267 void
 268 acpi_ns_install_node(struct acpi_walk_state *walk_state,
 269                      struct acpi_namespace_node *parent_node,
 270                      struct acpi_namespace_node *node, acpi_object_type type);
 271
 272 /*
 273  * nsutils - Utility functions
 274  */
 275 u8 acpi_ns_valid_root_prefix(char prefix);
 276
 277 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
 278
 279 u32 acpi_ns_local(acpi_object_type type);
 280
 281 void
 282 acpi_ns_report_error(const char *module_name,
 283                      u32 line_number,
 284                      const char *internal_name, acpi_status lookup_status);
 285
 286 void
 287 acpi_ns_report_method_error(const char *module_name,
 288                             u32 line_number,
 289                             const char *message,
 290                             struct acpi_namespace_node *node,
 291                             const char *path, acpi_status lookup_status);
 292
 293 void
 294 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
 295
 296 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
 297
 298 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
 299
 300 acpi_status
 301 acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
 302
 303 acpi_status
 304 acpi_ns_externalize_name(u32 internal_name_length,
 305                          const char *internal_name,
 306                          u32 * converted_name_length, char **converted_name);
 307
 308 struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle);
 309
 310 acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node);
 311
 312 void acpi_ns_terminate(void);
 313
 314 struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node
 315                                                     *node);
 316
 317 struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct
 318                                                         acpi_namespace_node
 319                                                         *node);
 320
 321 #endif                          /* __ACNAMESP_H__ */