drivers/acpi/include/namesp.h

   1
   2 /******************************************************************************
   3  *
   4  * Name: namesp.h - Namespace subcomponent prototypes and defines
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  *  Copyright (C) 2000 R. Byron Moore
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to the Free Software
  23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #ifndef __NAMESPACE_H__
  27 #define __NAMESPACE_H__
  28
  29 #include "actables.h"
  30
  31
  32 /* To search the entire name space, pass this as Search_base */
  33
  34 #define NS_ALL                  ((ACPI_HANDLE)0)
  35
  36 /*
  37  * Elements of Acpi_ns_properties are bit significant
  38  * and should be one-to-one with values of ACPI_OBJECT_TYPE
  39  */
  40 #define NSP_NORMAL              0
  41 #define NSP_NEWSCOPE            1   /* a definition of this type opens a name scope */
  42 #define NSP_LOCAL               2   /* suppress search of enclosing scopes */
  43
  44
  45 /* Definitions of the predefined namespace names  */
  46
  47 #define ACPI_UNKNOWN_NAME       (u32) 0x3F3F3F3F     /* Unknown name is  "????" */
  48 #define ACPI_ROOT_NAME          (u32) 0x2F202020     /* Root name is     "/   " */
  49 #define ACPI_SYS_BUS_NAME       (u32) 0x5F53425F     /* Sys bus name is  "_SB_" */
  50
  51 #define NS_ROOT_PATH            "/"
  52 #define NS_SYSTEM_BUS           "_SB_"
  53
  54
  55 /* Flags for Acpi_ns_lookup, Acpi_ns_search_and_enter */
  56
  57 #define NS_NO_UPSEARCH          0
  58 #define NS_SEARCH_PARENT        0x01
  59 #define NS_DONT_OPEN_SCOPE      0x02
  60 #define NS_NO_PEER_SEARCH       0x04
  61
  62 #define NS_WALK_UNLOCK          TRUE
  63 #define NS_WALK_NO_UNLOCK       FALSE
  64
  65
  66 ACPI_STATUS
  67 acpi_ns_walk_namespace (
  68         OBJECT_TYPE_INTERNAL    type,
  69         ACPI_HANDLE             start_object,
  70         u32                     max_depth,
  71         u8                      unlock_before_callback,
  72         WALK_CALLBACK           user_function,
  73         void                    *context,
  74         void                    **return_value);
  75
  76
  77 ACPI_NAMED_OBJECT*
  78 acpi_ns_get_next_object (
  79         OBJECT_TYPE_INTERNAL    type,
  80         ACPI_NAMED_OBJECT       *parent,
  81         ACPI_NAMED_OBJECT       *child);
  82
  83
  84 ACPI_STATUS
  85 acpi_ns_delete_namespace_by_owner (
  86         u16                     table_id);
  87
  88 void
  89 acpi_ns_free_table_entry (
  90         ACPI_NAMED_OBJECT       *entry);
  91
  92
  93 /* Namespace loading - nsload */
  94
  95 ACPI_STATUS
  96 acpi_ns_parse_table (
  97         ACPI_TABLE_DESC         *table_desc,
  98         ACPI_NAME_TABLE         *scope);
  99
 100 ACPI_STATUS
 101 acpi_ns_load_table (
 102         ACPI_TABLE_DESC         *table_desc,
 103         ACPI_NAMED_OBJECT       *entry);
 104
 105 ACPI_STATUS
 106 acpi_ns_load_table_by_type (
 107         ACPI_TABLE_TYPE         table_type);
 108
 109
 110 /*
 111  * Top-level namespace access - nsaccess
 112  */
 113
 114
 115 ACPI_STATUS
 116 acpi_ns_root_initialize (
 117         void);
 118
 119 ACPI_STATUS
 120 acpi_ns_lookup (
 121         ACPI_GENERIC_STATE      *scope_info,
 122         char                    *name,
 123         OBJECT_TYPE_INTERNAL    type,
 124         OPERATING_MODE          interpreter_mode,
 125         u32                     flags,
 126         ACPI_WALK_STATE         *walk_state,
 127         ACPI_NAMED_OBJECT       **ret_entry);
 128
 129
 130 /*
 131  * Table allocation/deallocation - nsalloc
 132  */
 133
 134 ACPI_NAME_TABLE *
 135 acpi_ns_allocate_name_table (
 136         u32                     num_entries);
 137
 138 ACPI_STATUS
 139 acpi_ns_delete_namespace_subtree (
 140         ACPI_NAMED_OBJECT       *parent_handle);
 141
 142 void
 143 acpi_ns_detach_object (
 144         ACPI_HANDLE             object);
 145
 146 void
 147 acpi_ns_delete_name_table (
 148         ACPI_NAME_TABLE         *name_table);
 149
 150
 151 /*
 152  * Namespace modification - nsmodify
 153  */
 154
 155 ACPI_STATUS
 156 acpi_ns_unload_namespace (
 157         ACPI_HANDLE             handle);
 158
 159 ACPI_STATUS
 160 acpi_ns_delete_subtree (
 161         ACPI_HANDLE             start_handle);
 162
 163
 164 /*
 165  * Namespace dump/print utilities - nsdump
 166  */
 167
 168 void
 169 acpi_ns_dump_tables (
 170         ACPI_HANDLE             search_base,
 171         s32                     max_depth);
 172
 173 void
 174 acpi_ns_dump_entry (
 175         ACPI_HANDLE             handle,
 176         u32                     debug_level);
 177
 178 ACPI_STATUS
 179 acpi_ns_dump_pathname (
 180         ACPI_HANDLE             handle,
 181         char                    *msg,
 182         u32                     level,
 183         u32                     component);
 184
 185 void
 186 acpi_ns_dump_root_devices (
 187         void);
 188
 189 void
 190 acpi_ns_dump_objects (
 191         OBJECT_TYPE_INTERNAL    type,
 192         u32                     max_depth,
 193         u32                     ownder_id,
 194         ACPI_HANDLE             start_handle);
 195
 196
 197 /*
 198  * Namespace evaluation functions - nseval
 199  */
 200
 201 ACPI_STATUS
 202 acpi_ns_evaluate_by_handle (
 203         ACPI_NAMED_OBJECT       *object_nte,
 204         ACPI_OBJECT_INTERNAL    **params,
 205         ACPI_OBJECT_INTERNAL    **return_object);
 206
 207 ACPI_STATUS
 208 acpi_ns_evaluate_by_name (
 209         char                    *pathname,
 210         ACPI_OBJECT_INTERNAL    **params,
 211         ACPI_OBJECT_INTERNAL    **return_object);
 212
 213 ACPI_STATUS
 214 acpi_ns_evaluate_relative (
 215         ACPI_NAMED_OBJECT       *object_nte,
 216         char                    *pathname,
 217         ACPI_OBJECT_INTERNAL    **params,
 218         ACPI_OBJECT_INTERNAL    **return_object);
 219
 220 ACPI_STATUS
 221 acpi_ns_execute_control_method (
 222         ACPI_NAMED_OBJECT       *method_entry,
 223         ACPI_OBJECT_INTERNAL    **params,
 224         ACPI_OBJECT_INTERNAL    **return_obj_desc);
 225
 226 ACPI_STATUS
 227 acpi_ns_get_object_value (
 228         ACPI_NAMED_OBJECT       *object_entry,
 229         ACPI_OBJECT_INTERNAL    **return_obj_desc);
 230
 231
 232 /*
 233  * Parent/Child/Peer utility functions - nsfamily
 234  */
 235
 236 ACPI_NAME
 237 acpi_ns_find_parent_name (
 238         ACPI_NAMED_OBJECT       *entry_to_search);
 239
 240 u8
 241 acpi_ns_exist_downstream_sibling (
 242         ACPI_NAMED_OBJECT       *this_entry);
 243
 244
 245 /*
 246  * Scope manipulation - nsscope
 247  */
 248
 249 s32
 250 acpi_ns_opens_scope (
 251         OBJECT_TYPE_INTERNAL    type);
 252
 253 char *
 254 acpi_ns_name_of_scope (
 255         ACPI_NAME_TABLE         *scope);
 256
 257 char *
 258 acpi_ns_name_of_current_scope (
 259         ACPI_WALK_STATE         *walk_state);
 260
 261 ACPI_STATUS
 262 acpi_ns_handle_to_pathname (
 263         ACPI_HANDLE             obj_handle,
 264         u32                     *buf_size,
 265         char                    *user_buffer);
 266
 267 u8
 268 acpi_ns_pattern_match (
 269         ACPI_NAMED_OBJECT       *obj_entry,
 270         char                    *search_for);
 271
 272 ACPI_STATUS
 273 acpi_ns_name_compare (
 274         ACPI_HANDLE             obj_handle,
 275         u32                     level,
 276         void                    *context,
 277         void                    **return_value);
 278
 279 void
 280 acpi_ns_low_find_names (
 281         ACPI_NAMED_OBJECT       *this_entry,
 282         char                    *search_for,
 283         s32                     *count,
 284         ACPI_HANDLE             list[],
 285         s32                     max_depth);
 286
 287 ACPI_HANDLE *
 288 acpi_ns_find_names (
 289         char                    *search_for,
 290         ACPI_HANDLE             search_base,
 291         s32                     max_depth);
 292
 293 ACPI_STATUS
 294 acpi_ns_get_named_object (
 295         char                    *pathname,
 296         ACPI_NAME_TABLE         *in_scope,
 297         ACPI_NAMED_OBJECT       **out_nte);
 298
 299 /*
 300  * Object management for NTEs - nsobject
 301  */
 302
 303 ACPI_STATUS
 304 acpi_ns_attach_method (
 305         ACPI_HANDLE             obj_handle,
 306         u8                      *pcode_addr,
 307         u32                     pcode_length);
 308
 309 ACPI_STATUS
 310 acpi_ns_attach_object (
 311         ACPI_HANDLE             obj_handle,
 312         ACPI_HANDLE             value,
 313         OBJECT_TYPE_INTERNAL    type);
 314
 315
 316 void *
 317 acpi_ns_compare_value (
 318         ACPI_HANDLE             obj_handle,
 319         u32                     level,
 320         void                    *obj_desc);
 321
 322 ACPI_HANDLE
 323 acpi_ns_find_attached_object (
 324         ACPI_OBJECT_INTERNAL    *obj_desc,
 325         ACPI_HANDLE             search_base,
 326         s32                     max_depth);
 327
 328
 329 /*
 330  * Namespace searching and entry - nssearch
 331  */
 332
 333 ACPI_STATUS
 334 acpi_ns_search_and_enter (
 335         u32                     entry_name,
 336         ACPI_WALK_STATE         *walk_state,
 337         ACPI_NAME_TABLE         *name_table,
 338         OPERATING_MODE          interpreter_mode,
 339         OBJECT_TYPE_INTERNAL    type,
 340         u32                     flags,
 341         ACPI_NAMED_OBJECT       **ret_entry);
 342
 343 void
 344 acpi_ns_initialize_table (
 345         ACPI_NAME_TABLE         *new_table,
 346         ACPI_NAME_TABLE         *parent_scope,
 347         ACPI_NAMED_OBJECT       *parent_entry);
 348
 349 ACPI_STATUS
 350 acpi_ns_search_one_scope (
 351         u32                     entry_name,
 352         ACPI_NAME_TABLE         *name_table,
 353         OBJECT_TYPE_INTERNAL    type,
 354         ACPI_NAMED_OBJECT       **ret_entry,
 355         NS_SEARCH_DATA          *ret_info);
 356
 357
 358 /*
 359  * Utility functions - nsutils
 360  */
 361
 362 u8
 363 acpi_ns_valid_root_prefix (
 364         char                    prefix);
 365
 366 u8
 367 acpi_ns_valid_path_separator (
 368         char                    sep);
 369
 370 OBJECT_TYPE_INTERNAL
 371 acpi_ns_get_type (
 372         ACPI_HANDLE             obj_handle);
 373
 374 void *
 375 acpi_ns_get_attached_object (
 376         ACPI_HANDLE             obj_handle);
 377
 378 s32
 379 acpi_ns_local (
 380         OBJECT_TYPE_INTERNAL    type);
 381
 382 ACPI_STATUS
 383 acpi_ns_internalize_name (
 384         char                    *dotted_name,
 385         char                    **converted_name);
 386
 387 ACPI_STATUS
 388 acpi_ns_externalize_name (
 389         u32                     internal_name_length,
 390         char                    *internal_name,
 391         u32                     *converted_name_length,
 392         char                    **converted_name);
 393
 394 s32
 395 is_ns_object (
 396         ACPI_OBJECT_INTERNAL    *p_oD);
 397
 398 s32
 399 acpi_ns_mark_nS(
 400         void);
 401
 402 ACPI_NAMED_OBJECT*
 403 acpi_ns_convert_handle_to_entry (
 404         ACPI_HANDLE             handle);
 405
 406 ACPI_HANDLE
 407 acpi_ns_convert_entry_to_handle(
 408         ACPI_NAMED_OBJECT*nte);
 409
 410 void
 411 acpi_ns_terminate (
 412         void);
 413
 414 ACPI_NAMED_OBJECT *
 415 acpi_ns_get_parent_entry (
 416         ACPI_NAMED_OBJECT       *this_entry);
 417
 418
 419 ACPI_NAMED_OBJECT *
 420 acpi_ns_get_next_valid_entry (
 421         ACPI_NAMED_OBJECT       *this_entry);
 422
 423
 424 #endif /* __NAMESPACE_H__ */