reactos/drivers/bus/acpi/include/acnamesp.h

   1 /******************************************************************************
   2  *
   3  * Name: acnamesp.h - Namespace subcomponent prototypes and defines
   4  *       $Revision: 1.1 $
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  *  Copyright (C) 2000, 2001 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 __ACNAMESP_H__
  27 #define __ACNAMESP_H__
  28
  29
  30 /* To search the entire name space, pass this as Search_base */
  31
  32 #define NS_ALL                  ((ACPI_HANDLE)0)
  33
  34 /*
  35  * Elements of Acpi_ns_properties are bit significant
  36  * and should be one-to-one with values of ACPI_OBJECT_TYPE
  37  */
  38 #define NSP_NORMAL              0
  39 #define NSP_NEWSCOPE            1   /* a definition of this type opens a name scope */
  40 #define NSP_LOCAL               2   /* suppress search of enclosing scopes */
  41
  42
  43 /* Definitions of the predefined namespace names  */
  44
  45 #define ACPI_UNKNOWN_NAME       (u32) 0x3F3F3F3F     /* Unknown name is  "????" */
  46 #define ACPI_ROOT_NAME          (u32) 0x2F202020     /* Root name is     "/   " */
  47 #define ACPI_SYS_BUS_NAME       (u32) 0x5F53425F     /* Sys bus name is  "_SB_" */
  48
  49 #define NS_ROOT_PATH            "/"
  50 #define NS_SYSTEM_BUS           "_SB_"
  51
  52
  53 /* Flags for Acpi_ns_lookup, Acpi_ns_search_and_enter */
  54
  55 #define NS_NO_UPSEARCH          0
  56 #define NS_SEARCH_PARENT        0x01
  57 #define NS_DONT_OPEN_SCOPE      0x02
  58 #define NS_NO_PEER_SEARCH       0x04
  59 #define NS_ERROR_IF_FOUND       0x08
  60
  61 #define NS_WALK_UNLOCK          TRUE
  62 #define NS_WALK_NO_UNLOCK       FALSE
  63
  64
  65 ACPI_STATUS
  66 acpi_ns_load_namespace (
  67         void);
  68
  69 ACPI_STATUS
  70 acpi_ns_initialize_objects (
  71         void);
  72
  73 ACPI_STATUS
  74 acpi_ns_initialize_devices (
  75         void);
  76
  77
  78 /* Namespace init - nsxfinit */
  79
  80 ACPI_STATUS
  81 acpi_ns_init_one_device (
  82         ACPI_HANDLE             obj_handle,
  83         u32                     nesting_level,
  84         void                    *context,
  85         void                    **return_value);
  86
  87 ACPI_STATUS
  88 acpi_ns_init_one_object (
  89         ACPI_HANDLE             obj_handle,
  90         u32                     level,
  91         void                    *context,
  92         void                    **return_value);
  93
  94
  95 ACPI_STATUS
  96 acpi_ns_walk_namespace (
  97         OBJECT_TYPE_INTERNAL    type,
  98         ACPI_HANDLE             start_object,
  99         u32                     max_depth,
 100         u8                      unlock_before_callback,
 101         WALK_CALLBACK           user_function,
 102         void                    *context,
 103         void                    **return_value);
 104
 105
 106 ACPI_NAMESPACE_NODE *
 107 acpi_ns_get_next_object (
 108         OBJECT_TYPE_INTERNAL    type,
 109         ACPI_NAMESPACE_NODE     *parent,
 110         ACPI_NAMESPACE_NODE     *child);
 111
 112
 113 ACPI_STATUS
 114 acpi_ns_delete_namespace_by_owner (
 115         u16                     table_id);
 116
 117
 118 /* Namespace loading - nsload */
 119
 120 ACPI_STATUS
 121 acpi_ns_one_complete_parse (
 122         u32                     pass_number,
 123         ACPI_TABLE_DESC         *table_desc);
 124
 125 ACPI_STATUS
 126 acpi_ns_parse_table (
 127         ACPI_TABLE_DESC         *table_desc,
 128         ACPI_NAMESPACE_NODE     *scope);
 129
 130 ACPI_STATUS
 131 acpi_ns_load_table (
 132         ACPI_TABLE_DESC         *table_desc,
 133         ACPI_NAMESPACE_NODE     *node);
 134
 135 ACPI_STATUS
 136 acpi_ns_load_table_by_type (
 137         ACPI_TABLE_TYPE         table_type);
 138
 139
 140 /*
 141  * Top-level namespace access - nsaccess
 142  */
 143
 144
 145 ACPI_STATUS
 146 acpi_ns_root_initialize (
 147         void);
 148
 149 ACPI_STATUS
 150 acpi_ns_lookup (
 151         ACPI_GENERIC_STATE      *scope_info,
 152         NATIVE_CHAR             *name,
 153         OBJECT_TYPE_INTERNAL    type,
 154         OPERATING_MODE          interpreter_mode,
 155         u32                     flags,
 156         ACPI_WALK_STATE         *walk_state,
 157         ACPI_NAMESPACE_NODE     **ret_node);
 158
 159
 160 /*
 161  * Named object allocation/deallocation - nsalloc
 162  */
 163
 164
 165 ACPI_NAMESPACE_NODE *
 166 acpi_ns_create_node (
 167         u32                     acpi_name);
 168
 169 void
 170 acpi_ns_delete_node (
 171         ACPI_NAMESPACE_NODE     *node);
 172
 173 ACPI_STATUS
 174 acpi_ns_delete_namespace_subtree (
 175         ACPI_NAMESPACE_NODE     *parent_handle);
 176
 177 void
 178 acpi_ns_detach_object (
 179         ACPI_NAMESPACE_NODE     *node);
 180
 181 void
 182 acpi_ns_delete_children (
 183         ACPI_NAMESPACE_NODE     *parent);
 184
 185
 186 /*
 187  * Namespace modification - nsmodify
 188  */
 189
 190 ACPI_STATUS
 191 acpi_ns_unload_namespace (
 192         ACPI_HANDLE             handle);
 193
 194 ACPI_STATUS
 195 acpi_ns_delete_subtree (
 196         ACPI_HANDLE             start_handle);
 197
 198
 199 /*
 200  * Namespace dump/print utilities - nsdump
 201  */
 202
 203 void
 204 acpi_ns_dump_tables (
 205         ACPI_HANDLE             search_base,
 206         u32                     max_depth);
 207
 208 void
 209 acpi_ns_dump_entry (
 210         ACPI_HANDLE             handle,
 211         u32                     debug_level);
 212
 213 ACPI_STATUS
 214 acpi_ns_dump_pathname (
 215         ACPI_HANDLE             handle,
 216         NATIVE_CHAR             *msg,
 217         u32                     level,
 218         u32                     component);
 219
 220 void
 221 acpi_ns_dump_root_devices (
 222         void);
 223
 224 void
 225 acpi_ns_dump_objects (
 226         OBJECT_TYPE_INTERNAL    type,
 227         u32                     max_depth,
 228         u32                     ownder_id,
 229         ACPI_HANDLE             start_handle);
 230
 231
 232 /*
 233  * Namespace evaluation functions - nseval
 234  */
 235
 236 ACPI_STATUS
 237 acpi_ns_evaluate_by_handle (
 238         ACPI_NAMESPACE_NODE     *prefix_node,
 239         ACPI_OPERAND_OBJECT     **params,
 240         ACPI_OPERAND_OBJECT     **return_object);
 241
 242 ACPI_STATUS
 243 acpi_ns_evaluate_by_name (
 244         NATIVE_CHAR             *pathname,
 245         ACPI_OPERAND_OBJECT     **params,
 246         ACPI_OPERAND_OBJECT     **return_object);
 247
 248 ACPI_STATUS
 249 acpi_ns_evaluate_relative (
 250         ACPI_NAMESPACE_NODE     *prefix_node,
 251         NATIVE_CHAR             *pathname,
 252         ACPI_OPERAND_OBJECT     **params,
 253         ACPI_OPERAND_OBJECT     **return_object);
 254
 255 ACPI_STATUS
 256 acpi_ns_execute_control_method (
 257         ACPI_NAMESPACE_NODE     *method_node,
 258         ACPI_OPERAND_OBJECT     **params,
 259         ACPI_OPERAND_OBJECT     **return_obj_desc);
 260
 261 ACPI_STATUS
 262 acpi_ns_get_object_value (
 263         ACPI_NAMESPACE_NODE     *object_node,
 264         ACPI_OPERAND_OBJECT     **return_obj_desc);
 265
 266
 267 /*
 268  * Parent/Child/Peer utility functions - nsfamily
 269  */
 270
 271 ACPI_NAME
 272 acpi_ns_find_parent_name (
 273         ACPI_NAMESPACE_NODE     *node_to_search);
 274
 275 u8
 276 acpi_ns_exist_downstream_sibling (
 277         ACPI_NAMESPACE_NODE     *this_node);
 278
 279
 280 /*
 281  * Scope manipulation - nsscope
 282  */
 283
 284 u32
 285 acpi_ns_opens_scope (
 286         OBJECT_TYPE_INTERNAL    type);
 287
 288 NATIVE_CHAR *
 289 acpi_ns_get_table_pathname (
 290         ACPI_NAMESPACE_NODE     *node);
 291
 292 NATIVE_CHAR *
 293 acpi_ns_name_of_current_scope (
 294         ACPI_WALK_STATE         *walk_state);
 295
 296 ACPI_STATUS
 297 acpi_ns_handle_to_pathname (
 298         ACPI_HANDLE             obj_handle,
 299         u32                     *buf_size,
 300         NATIVE_CHAR             *user_buffer);
 301
 302 u8
 303 acpi_ns_pattern_match (
 304         ACPI_NAMESPACE_NODE     *obj_node,
 305         NATIVE_CHAR             *search_for);
 306
 307 ACPI_STATUS
 308 acpi_ns_name_compare (
 309         ACPI_HANDLE             obj_handle,
 310         u32                     level,
 311         void                    *context,
 312         void                    **return_value);
 313
 314 ACPI_STATUS
 315 acpi_ns_get_node (
 316         NATIVE_CHAR             *pathname,
 317         ACPI_NAMESPACE_NODE     *in_prefix_node,
 318         ACPI_NAMESPACE_NODE     **out_node);
 319
 320 u32
 321 acpi_ns_get_pathname_length (
 322         ACPI_NAMESPACE_NODE     *node);
 323
 324
 325 /*
 326  * Object management for NTEs - nsobject
 327  */
 328
 329 ACPI_STATUS
 330 acpi_ns_attach_object (
 331         ACPI_NAMESPACE_NODE     *node,
 332         ACPI_OPERAND_OBJECT     *object,
 333         OBJECT_TYPE_INTERNAL    type);
 334
 335
 336 void *
 337 acpi_ns_compare_value (
 338         ACPI_HANDLE             obj_handle,
 339         u32                     level,
 340         void                    *obj_desc);
 341
 342
 343 /*
 344  * Namespace searching and entry - nssearch
 345  */
 346
 347 ACPI_STATUS
 348 acpi_ns_search_and_enter (
 349         u32                     entry_name,
 350         ACPI_WALK_STATE         *walk_state,
 351         ACPI_NAMESPACE_NODE     *node,
 352         OPERATING_MODE          interpreter_mode,
 353         OBJECT_TYPE_INTERNAL    type,
 354         u32                     flags,
 355         ACPI_NAMESPACE_NODE     **ret_node);
 356
 357 ACPI_STATUS
 358 acpi_ns_search_node (
 359         u32                     entry_name,
 360         ACPI_NAMESPACE_NODE     *node,
 361         OBJECT_TYPE_INTERNAL    type,
 362         ACPI_NAMESPACE_NODE     **ret_node);
 363
 364 void
 365 acpi_ns_install_node (
 366         ACPI_WALK_STATE         *walk_state,
 367         ACPI_NAMESPACE_NODE     *parent_node,   /* Parent */
 368         ACPI_NAMESPACE_NODE     *node,      /* New Child*/
 369         OBJECT_TYPE_INTERNAL    type);
 370
 371
 372 /*
 373  * Utility functions - nsutils
 374  */
 375
 376 u8
 377 acpi_ns_valid_root_prefix (
 378         NATIVE_CHAR             prefix);
 379
 380 u8
 381 acpi_ns_valid_path_separator (
 382         NATIVE_CHAR             sep);
 383
 384 OBJECT_TYPE_INTERNAL
 385 acpi_ns_get_type (
 386         ACPI_HANDLE             obj_handle);
 387
 388 void *
 389 acpi_ns_get_attached_object (
 390         ACPI_HANDLE             obj_handle);
 391
 392 u32
 393 acpi_ns_local (
 394         OBJECT_TYPE_INTERNAL    type);
 395
 396 ACPI_STATUS
 397 acpi_ns_internalize_name (
 398         NATIVE_CHAR             *dotted_name,
 399         NATIVE_CHAR             **converted_name);
 400
 401 ACPI_STATUS
 402 acpi_ns_externalize_name (
 403         u32                     internal_name_length,
 404         NATIVE_CHAR             *internal_name,
 405         u32                     *converted_name_length,
 406         NATIVE_CHAR             **converted_name);
 407
 408 ACPI_NAMESPACE_NODE *
 409 acpi_ns_convert_handle_to_entry (
 410         ACPI_HANDLE             handle);
 411
 412 ACPI_HANDLE
 413 acpi_ns_convert_entry_to_handle(
 414         ACPI_NAMESPACE_NODE     *node);
 415
 416 void
 417 acpi_ns_terminate (
 418         void);
 419
 420 ACPI_NAMESPACE_NODE *
 421 acpi_ns_get_parent_object (
 422         ACPI_NAMESPACE_NODE     *node);
 423
 424
 425 ACPI_NAMESPACE_NODE *
 426 acpi_ns_get_next_valid_object (
 427         ACPI_NAMESPACE_NODE     *node);
 428
 429
 430 #endif /* __ACNAMESP_H__ */