include/acpi/acnamesp.h

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