include/acpi/acpixf.h

   1 /******************************************************************************
   2  *
   3  * Name: acpixf.h - External interfaces to the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2015, 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 __ACXFACE_H__
  45 #define __ACXFACE_H__
  46
  47 /* Current ACPICA subsystem version in YYYYMMDD format */
  48
  49 #define ACPI_CA_VERSION                 0x20150930
  50
  51 #include <acpi/acconfig.h>
  52 #include <acpi/actypes.h>
  53 #include <acpi/actbl.h>
  54 #include <acpi/acbuffer.h>
  55
  56 /*****************************************************************************
  57  *
  58  * Macros used for ACPICA globals and configuration
  59  *
  60  ****************************************************************************/
  61
  62 /*
  63  * Ensure that global variables are defined and initialized only once.
  64  *
  65  * The use of these macros allows for a single list of globals (here)
  66  * in order to simplify maintenance of the code.
  67  */
  68 #ifdef DEFINE_ACPI_GLOBALS
  69 #define ACPI_GLOBAL(type,name) \
  70         extern type name; \
  71         type name
  72
  73 #define ACPI_INIT_GLOBAL(type,name,value) \
  74         type name=value
  75
  76 #else
  77 #ifndef ACPI_GLOBAL
  78 #define ACPI_GLOBAL(type,name) \
  79         extern type name
  80 #endif
  81
  82 #ifndef ACPI_INIT_GLOBAL
  83 #define ACPI_INIT_GLOBAL(type,name,value) \
  84         extern type name
  85 #endif
  86 #endif
  87
  88 /*
  89  * These macros configure the various ACPICA interfaces. They are
  90  * useful for generating stub inline functions for features that are
  91  * configured out of the current kernel or ACPICA application.
  92  */
  93 #ifndef ACPI_EXTERNAL_RETURN_STATUS
  94 #define ACPI_EXTERNAL_RETURN_STATUS(prototype) \
  95         prototype;
  96 #endif
  97
  98 #ifndef ACPI_EXTERNAL_RETURN_OK
  99 #define ACPI_EXTERNAL_RETURN_OK(prototype) \
 100         prototype;
 101 #endif
 102
 103 #ifndef ACPI_EXTERNAL_RETURN_VOID
 104 #define ACPI_EXTERNAL_RETURN_VOID(prototype) \
 105         prototype;
 106 #endif
 107
 108 #ifndef ACPI_EXTERNAL_RETURN_UINT32
 109 #define ACPI_EXTERNAL_RETURN_UINT32(prototype) \
 110         prototype;
 111 #endif
 112
 113 #ifndef ACPI_EXTERNAL_RETURN_PTR
 114 #define ACPI_EXTERNAL_RETURN_PTR(prototype) \
 115         prototype;
 116 #endif
 117
 118 /*****************************************************************************
 119  *
 120  * Public globals and runtime configuration options
 121  *
 122  ****************************************************************************/
 123
 124 /*
 125  * Enable "slack mode" of the AML interpreter?  Default is FALSE, and the
 126  * interpreter strictly follows the ACPI specification. Setting to TRUE
 127  * allows the interpreter to ignore certain errors and/or bad AML constructs.
 128  *
 129  * Currently, these features are enabled by this flag:
 130  *
 131  * 1) Allow "implicit return" of last value in a control method
 132  * 2) Allow access beyond the end of an operation region
 133  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
 134  * 4) Allow ANY object type to be a source operand for the Store() operator
 135  * 5) Allow unresolved references (invalid target name) in package objects
 136  * 6) Enable warning messages for behavior that is not ACPI spec compliant
 137  */
 138 ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_interpreter_slack, FALSE);
 139
 140 /*
 141  * Automatically serialize all methods that create named objects? Default
 142  * is TRUE, meaning that all non_serialized methods are scanned once at
 143  * table load time to determine those that create named objects. Methods
 144  * that create named objects are marked Serialized in order to prevent
 145  * possible run-time problems if they are entered by more than one thread.
 146  */
 147 ACPI_INIT_GLOBAL(u8, acpi_gbl_auto_serialize_methods, TRUE);
 148
 149 /*
 150  * Create the predefined _OSI method in the namespace? Default is TRUE
 151  * because ACPICA is fully compatible with other ACPI implementations.
 152  * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
 153  */
 154 ACPI_INIT_GLOBAL(u8, acpi_gbl_create_osi_method, TRUE);
 155
 156 /*
 157  * Optionally use default values for the ACPI register widths. Set this to
 158  * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
 159  */
 160 ACPI_INIT_GLOBAL(u8, acpi_gbl_use_default_register_widths, TRUE);
 161
 162 /*
 163  * Whether or not to verify the table checksum before installation. Set
 164  * this to TRUE to verify the table checksum before install it to the table
 165  * manager. Note that enabling this option causes errors to happen in some
 166  * OSPMs during early initialization stages. Default behavior is to do such
 167  * verification.
 168  */
 169 ACPI_INIT_GLOBAL(u8, acpi_gbl_verify_table_checksum, TRUE);
 170
 171 /*
 172  * Optionally enable output from the AML Debug Object.
 173  */
 174 ACPI_INIT_GLOBAL(u8, acpi_gbl_enable_aml_debug_object, FALSE);
 175
 176 /*
 177  * Optionally copy the entire DSDT to local memory (instead of simply
 178  * mapping it.) There are some BIOSs that corrupt or replace the original
 179  * DSDT, creating the need for this option. Default is FALSE, do not copy
 180  * the DSDT.
 181  */
 182 ACPI_INIT_GLOBAL(u8, acpi_gbl_copy_dsdt_locally, FALSE);
 183
 184 /*
 185  * Optionally ignore an XSDT if present and use the RSDT instead.
 186  * Although the ACPI specification requires that an XSDT be used instead
 187  * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
 188  * some machines. Default behavior is to use the XSDT if present.
 189  */
 190 ACPI_INIT_GLOBAL(u8, acpi_gbl_do_not_use_xsdt, FALSE);
 191
 192 /*
 193  * Optionally use 32-bit FADT addresses if and when there is a conflict
 194  * (address mismatch) between the 32-bit and 64-bit versions of the
 195  * address. Although ACPICA adheres to the ACPI specification which
 196  * requires the use of the corresponding 64-bit address if it is non-zero,
 197  * some machines have been found to have a corrupted non-zero 64-bit
 198  * address. Default is FALSE, do not favor the 32-bit addresses.
 199  */
 200 ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, FALSE);
 201
 202 /*
 203  * Optionally use 32-bit FACS table addresses.
 204  * It is reported that some platforms fail to resume from system suspending
 205  * if 64-bit FACS table address is selected:
 206  * https://bugzilla.kernel.org/show_bug.cgi?id=74021
 207  * Default is TRUE, favor the 32-bit addresses.
 208  */
 209 ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_facs_addresses, TRUE);
 210
 211 /*
 212  * Optionally truncate I/O addresses to 16 bits. Provides compatibility
 213  * with other ACPI implementations. NOTE: During ACPICA initialization,
 214  * this value is set to TRUE if any Windows OSI strings have been
 215  * requested by the BIOS.
 216  */
 217 ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
 218
 219 /*
 220  * Disable runtime checking and repair of values returned by control methods.
 221  * Use only if the repair is causing a problem on a particular machine.
 222  */
 223 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
 224
 225 /*
 226  * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
 227  * This can be useful for debugging ACPI problems on some machines.
 228  */
 229 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
 230
 231 /*
 232  * Optionally enable runtime namespace override.
 233  */
 234 ACPI_INIT_GLOBAL(u8, acpi_gbl_runtime_namespace_override, TRUE);
 235
 236 /*
 237  * We keep track of the latest version of Windows that has been requested by
 238  * the BIOS. ACPI 5.0.
 239  */
 240 ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
 241
 242 /*
 243  * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
 244  * that the ACPI hardware is no longer required. A flag in the FADT indicates
 245  * a reduced HW machine, and that flag is duplicated here for convenience.
 246  */
 247 ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
 248
 249 /*
 250  * This mechanism is used to trace a specified AML method. The method is
 251  * traced each time it is executed.
 252  */
 253 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
 254 ACPI_INIT_GLOBAL(const char *, acpi_gbl_trace_method_name, NULL);
 255 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_dbg_level, ACPI_TRACE_LEVEL_DEFAULT);
 256 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_dbg_layer, ACPI_TRACE_LAYER_DEFAULT);
 257
 258 /*
 259  * Runtime configuration of debug output control masks. We want the debug
 260  * switches statically initialized so they are already set when the debugger
 261  * is entered.
 262  */
 263 ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
 264 ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
 265
 266 /* Optionally enable timer output with Debug Object output */
 267
 268 ACPI_INIT_GLOBAL(u8, acpi_gbl_display_debug_timer, FALSE);
 269
 270 /*
 271  * Debugger command handshake globals. Host OSes need to access these
 272  * variables to implement their own command handshake mechanism.
 273  */
 274 #ifdef ACPI_DEBUGGER
 275 ACPI_INIT_GLOBAL(u8, acpi_gbl_method_executing, FALSE);
 276 ACPI_GLOBAL(char, acpi_gbl_db_line_buf[ACPI_DB_LINE_BUFFER_SIZE]);
 277 #endif
 278
 279 /*
 280  * Other miscellaneous globals
 281  */
 282 ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
 283 ACPI_GLOBAL(u32, acpi_current_gpe_count);
 284 ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
 285
 286 /*****************************************************************************
 287  *
 288  * ACPICA public interface configuration.
 289  *
 290  * Interfaces that are configured out of the ACPICA build are replaced
 291  * by inlined stubs by default.
 292  *
 293  ****************************************************************************/
 294
 295 /*
 296  * Hardware-reduced prototypes (default: Not hardware reduced).
 297  *
 298  * All ACPICA hardware-related interfaces that use these macros will be
 299  * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
 300  * is set to TRUE.
 301  *
 302  * Note: This static build option for reduced hardware is intended to
 303  * reduce ACPICA code size if desired or necessary. However, even if this
 304  * option is not specified, the runtime behavior of ACPICA is dependent
 305  * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
 306  * the flag will enable similar behavior -- ACPICA will not attempt
 307  * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
 308  */
 309 #if (!ACPI_REDUCED_HARDWARE)
 310 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
 311         ACPI_EXTERNAL_RETURN_STATUS(prototype)
 312
 313 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
 314         ACPI_EXTERNAL_RETURN_OK(prototype)
 315
 316 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
 317         ACPI_EXTERNAL_RETURN_VOID(prototype)
 318
 319 #else
 320 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
 321         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
 322
 323 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
 324         static ACPI_INLINE prototype {return(AE_OK);}
 325
 326 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
 327         static ACPI_INLINE prototype {return;}
 328
 329 #endif                          /* !ACPI_REDUCED_HARDWARE */
 330
 331 /*
 332  * Error message prototypes (default: error messages enabled).
 333  *
 334  * All interfaces related to error and warning messages
 335  * will be configured out of the ACPICA build if the
 336  * ACPI_NO_ERROR_MESSAGE flag is defined.
 337  */
 338 #ifndef ACPI_NO_ERROR_MESSAGES
 339 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
 340         prototype;
 341
 342 #else
 343 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
 344         static ACPI_INLINE prototype {return;}
 345
 346 #endif                          /* ACPI_NO_ERROR_MESSAGES */
 347
 348 /*
 349  * Debugging output prototypes (default: no debug output).
 350  *
 351  * All interfaces related to debug output messages
 352  * will be configured out of the ACPICA build unless the
 353  * ACPI_DEBUG_OUTPUT flag is defined.
 354  */
 355 #ifdef ACPI_DEBUG_OUTPUT
 356 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
 357         prototype;
 358
 359 #else
 360 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
 361         static ACPI_INLINE prototype {return;}
 362
 363 #endif                          /* ACPI_DEBUG_OUTPUT */
 364
 365 /*
 366  * Application prototypes
 367  *
 368  * All interfaces used by application will be configured
 369  * out of the ACPICA build unless the ACPI_APPLICATION
 370  * flag is defined.
 371  */
 372 #ifdef ACPI_APPLICATION
 373 #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
 374         prototype;
 375
 376 #else
 377 #define ACPI_APP_DEPENDENT_RETURN_VOID(prototype) \
 378         static ACPI_INLINE prototype {return;}
 379
 380 #endif                          /* ACPI_APPLICATION */
 381
 382 /*
 383  * Debugger prototypes
 384  *
 385  * All interfaces used by debugger will be configured
 386  * out of the ACPICA build unless the ACPI_DEBUGGER
 387  * flag is defined.
 388  */
 389 #ifdef ACPI_DEBUGGER
 390 #define ACPI_DBR_DEPENDENT_RETURN_OK(prototype) \
 391         ACPI_EXTERNAL_RETURN_OK(prototype)
 392
 393 #define ACPI_DBR_DEPENDENT_RETURN_VOID(prototype) \
 394         ACPI_EXTERNAL_RETURN_VOID(prototype)
 395
 396 #else
 397 #define ACPI_DBR_DEPENDENT_RETURN_OK(prototype) \
 398         static ACPI_INLINE prototype {return(AE_OK);}
 399
 400 #define ACPI_DBR_DEPENDENT_RETURN_VOID(prototype) \
 401         static ACPI_INLINE prototype {return;}
 402
 403 #endif                          /* ACPI_DEBUGGER */
 404
 405 /*****************************************************************************
 406  *
 407  * ACPICA public interface prototypes
 408  *
 409  ****************************************************************************/
 410
 411 /*
 412  * Initialization
 413  */
 414 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 415                             acpi_initialize_tables(struct acpi_table_desc
 416                                                    *initial_storage,
 417                                                    u32 initial_table_count,
 418                                                    u8 allow_resize))
 419 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_initialize_subsystem(void))
 420
 421 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_enable_subsystem(u32 flags))
 422
 423 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 424                             acpi_initialize_objects(u32 flags))
 425 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_terminate(void))
 426
 427 /*
 428  * Miscellaneous global interfaces
 429  */
 430 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
 431 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
 432 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
 433
 434 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 435                             acpi_get_system_info(struct acpi_buffer
 436                                                  *ret_buffer))
 437 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 438                              acpi_get_statistics(struct acpi_statistics *stats))
 439 ACPI_EXTERNAL_RETURN_PTR(const char
 440                           *acpi_format_exception(acpi_status exception))
 441 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
 442
 443 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 444                             acpi_install_interface(acpi_string interface_name))
 445
 446 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 447                             acpi_remove_interface(acpi_string interface_name))
 448 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
 449
 450 ACPI_EXTERNAL_RETURN_UINT32(u32
 451                             acpi_check_address_range(acpi_adr_space_type
 452                                                      space_id,
 453                                                      acpi_physical_address
 454                                                      address, acpi_size length,
 455                                                      u8 warn))
 456 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 457                              acpi_decode_pld_buffer(u8 *in_buffer,
 458                                                     acpi_size length,
 459                                                     struct acpi_pld_info
 460                                                     **return_buffer))
 461
 462 /*
 463  * ACPI table load/unload interfaces
 464  */
 465 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 466                             acpi_install_table(acpi_physical_address address,
 467                                                u8 physical))
 468
 469 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 470                             acpi_load_table(struct acpi_table_header *table))
 471
 472 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 473                             acpi_unload_parent_table(acpi_handle object))
 474 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_load_tables(void))
 475
 476 /*
 477  * ACPI table manipulation interfaces
 478  */
 479 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_reallocate_root_table(void))
 480
 481 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 482                             acpi_find_root_pointer(acpi_physical_address *
 483                                                    rsdp_address))
 484 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 485                              acpi_get_table_header(acpi_string signature,
 486                                                    u32 instance,
 487                                                    struct acpi_table_header
 488                                                    *out_table_header))
 489 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 490                              acpi_get_table(acpi_string signature, u32 instance,
 491                                             struct acpi_table_header
 492                                             **out_table))
 493 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 494                              acpi_get_table_by_index(u32 table_index,
 495                                                      struct acpi_table_header
 496                                                      **out_table))
 497 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 498                              acpi_install_table_handler(acpi_table_handler
 499                                                         handler, void *context))
 500 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 501                              acpi_remove_table_handler(acpi_table_handler
 502                                                        handler))
 503
 504 /*
 505  * Namespace and name interfaces
 506  */
 507 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 508                             acpi_walk_namespace(acpi_object_type type,
 509                                                 acpi_handle start_object,
 510                                                 u32 max_depth,
 511                                                 acpi_walk_callback
 512                                                 descending_callback,
 513                                                 acpi_walk_callback
 514                                                 ascending_callback,
 515                                                 void *context,
 516                                                 void **return_value))
 517 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 518                              acpi_get_devices(const char *HID,
 519                                               acpi_walk_callback user_function,
 520                                               void *context,
 521                                               void **return_value))
 522 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 523                              acpi_get_name(acpi_handle object, u32 name_type,
 524                                            struct acpi_buffer *ret_path_ptr))
 525 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 526                              acpi_get_handle(acpi_handle parent,
 527                                              acpi_string pathname,
 528                                              acpi_handle * ret_handle))
 529 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 530                              acpi_attach_data(acpi_handle object,
 531                                               acpi_object_handler handler,
 532                                               void *data))
 533 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 534                              acpi_detach_data(acpi_handle object,
 535                                               acpi_object_handler handler))
 536 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 537                              acpi_get_data(acpi_handle object,
 538                                            acpi_object_handler handler,
 539                                            void **data))
 540 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 541                              acpi_debug_trace(const char *name, u32 debug_level,
 542                                               u32 debug_layer, u32 flags))
 543
 544 /*
 545  * Object manipulation and enumeration
 546  */
 547 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 548                             acpi_evaluate_object(acpi_handle object,
 549                                                  acpi_string pathname,
 550                                                  struct acpi_object_list
 551                                                  *parameter_objects,
 552                                                  struct acpi_buffer
 553                                                  *return_object_buffer))
 554 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 555                              acpi_evaluate_object_typed(acpi_handle object,
 556                                                         acpi_string pathname,
 557                                                         struct acpi_object_list
 558                                                         *external_params,
 559                                                         struct acpi_buffer
 560                                                         *return_buffer,
 561                                                         acpi_object_type
 562                                                         return_type))
 563 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 564                              acpi_get_object_info(acpi_handle object,
 565                                                   struct acpi_device_info
 566                                                   **return_buffer))
 567 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
 568
 569 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 570                             acpi_get_next_object(acpi_object_type type,
 571                                                  acpi_handle parent,
 572                                                  acpi_handle child,
 573                                                  acpi_handle * out_handle))
 574
 575 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 576                             acpi_get_type(acpi_handle object,
 577                                           acpi_object_type * out_type))
 578
 579 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 580                             acpi_get_parent(acpi_handle object,
 581                                             acpi_handle * out_handle))
 582
 583 /*
 584  * Handler interfaces
 585  */
 586 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 587                             acpi_install_initialization_handler
 588                             (acpi_init_handler handler, u32 function))
 589 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 590                                  acpi_install_sci_handler(acpi_sci_handler
 591                                                           address,
 592                                                           void *context))
 593 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 594                                  acpi_remove_sci_handler(acpi_sci_handler
 595                                                          address))
 596 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 597                                  acpi_install_global_event_handler
 598                                  (acpi_gbl_event_handler handler,
 599                                   void *context))
 600 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 601                                  acpi_install_fixed_event_handler(u32
 602                                                                   acpi_event,
 603                                                                   acpi_event_handler
 604                                                                   handler,
 605                                                                   void
 606                                                                   *context))
 607 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 608                                  acpi_remove_fixed_event_handler(u32 acpi_event,
 609                                                                  acpi_event_handler
 610                                                                  handler))
 611 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 612                                  acpi_install_gpe_handler(acpi_handle
 613                                                           gpe_device,
 614                                                           u32 gpe_number,
 615                                                           u32 type,
 616                                                           acpi_gpe_handler
 617                                                           address,
 618                                                           void *context))
 619 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 620                                  acpi_install_gpe_raw_handler(acpi_handle
 621                                                               gpe_device,
 622                                                               u32 gpe_number,
 623                                                               u32 type,
 624                                                               acpi_gpe_handler
 625                                                               address,
 626                                                               void *context))
 627 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 628                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
 629                                                          u32 gpe_number,
 630                                                          acpi_gpe_handler
 631                                                          address))
 632 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 633                              acpi_install_notify_handler(acpi_handle device,
 634                                                          u32 handler_type,
 635                                                          acpi_notify_handler
 636                                                          handler,
 637                                                          void *context))
 638 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 639                              acpi_remove_notify_handler(acpi_handle device,
 640                                                         u32 handler_type,
 641                                                         acpi_notify_handler
 642                                                         handler))
 643 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 644                              acpi_install_address_space_handler(acpi_handle
 645                                                                 device,
 646                                                                 acpi_adr_space_type
 647                                                                 space_id,
 648                                                                 acpi_adr_space_handler
 649                                                                 handler,
 650                                                                 acpi_adr_space_setup
 651                                                                 setup,
 652                                                                 void *context))
 653 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 654                              acpi_remove_address_space_handler(acpi_handle
 655                                                                device,
 656                                                                acpi_adr_space_type
 657                                                                space_id,
 658                                                                acpi_adr_space_handler
 659                                                                handler))
 660 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 661                              acpi_install_exception_handler
 662                              (acpi_exception_handler handler))
 663 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 664                              acpi_install_interface_handler
 665                              (acpi_interface_handler handler))
 666
 667 /*
 668  * Global Lock interfaces
 669  */
 670 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 671                                 acpi_acquire_global_lock(u16 timeout,
 672                                                          u32 *handle))
 673
 674 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 675                                 acpi_release_global_lock(u32 handle))
 676
 677 /*
 678  * Interfaces to AML mutex objects
 679  */
 680 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 681                             acpi_acquire_mutex(acpi_handle handle,
 682                                                acpi_string pathname,
 683                                                u16 timeout))
 684
 685 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 686                             acpi_release_mutex(acpi_handle handle,
 687                                                acpi_string pathname))
 688
 689 /*
 690  * Fixed Event interfaces
 691  */
 692 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 693                                 acpi_enable_event(u32 event, u32 flags))
 694
 695 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 696                                 acpi_disable_event(u32 event, u32 flags))
 697 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
 698
 699 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 700                                 acpi_get_event_status(u32 event,
 701                                                       acpi_event_status
 702                                                       *event_status))
 703
 704 /*
 705  * General Purpose Event (GPE) Interfaces
 706  */
 707 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
 708
 709 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 710                                 acpi_enable_gpe(acpi_handle gpe_device,
 711                                                 u32 gpe_number))
 712
 713 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 714                                 acpi_disable_gpe(acpi_handle gpe_device,
 715                                                  u32 gpe_number))
 716
 717 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 718                                 acpi_clear_gpe(acpi_handle gpe_device,
 719                                                u32 gpe_number))
 720
 721 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 722                                 acpi_set_gpe(acpi_handle gpe_device,
 723                                              u32 gpe_number, u8 action))
 724
 725 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 726                                 acpi_finish_gpe(acpi_handle gpe_device,
 727                                                 u32 gpe_number))
 728
 729 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 730                                 acpi_mark_gpe_for_wake(acpi_handle gpe_device,
 731                                                        u32 gpe_number))
 732
 733 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 734                                 acpi_setup_gpe_for_wake(acpi_handle
 735                                                         parent_device,
 736                                                         acpi_handle gpe_device,
 737                                                         u32 gpe_number))
 738 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 739                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
 740                                                         u32 gpe_number,
 741                                                         u8 action))
 742 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 743                                  acpi_get_gpe_status(acpi_handle gpe_device,
 744                                                      u32 gpe_number,
 745                                                      acpi_event_status
 746                                                      *event_status))
 747 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
 748 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
 749 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_wakeup_gpes(void))
 750
 751 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 752                                 acpi_get_gpe_device(u32 gpe_index,
 753                                                     acpi_handle * gpe_device))
 754
 755 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 756                                 acpi_install_gpe_block(acpi_handle gpe_device,
 757                                                        struct
 758                                                        acpi_generic_address
 759                                                        *gpe_block_address,
 760                                                        u32 register_count,
 761                                                        u32 interrupt_number))
 762 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 763                                  acpi_remove_gpe_block(acpi_handle gpe_device))
 764
 765 /*
 766  * Resource interfaces
 767  */
 768 typedef
 769 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
 770                                            void *context);
 771
 772 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 773                             acpi_get_vendor_resource(acpi_handle device,
 774                                                      char *name,
 775                                                      struct acpi_vendor_uuid
 776                                                      *uuid,
 777                                                      struct acpi_buffer
 778                                                      *ret_buffer))
 779 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 780                              acpi_get_current_resources(acpi_handle device,
 781                                                         struct acpi_buffer
 782                                                         *ret_buffer))
 783 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 784                              acpi_get_possible_resources(acpi_handle device,
 785                                                          struct acpi_buffer
 786                                                          *ret_buffer))
 787 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 788                              acpi_get_event_resources(acpi_handle device_handle,
 789                                                       struct acpi_buffer
 790                                                       *ret_buffer))
 791 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 792                              acpi_walk_resource_buffer(struct acpi_buffer
 793                                                        *buffer,
 794                                                        acpi_walk_resource_callback
 795                                                        user_function,
 796                                                        void *context))
 797 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 798                              acpi_walk_resources(acpi_handle device, char *name,
 799                                                  acpi_walk_resource_callback
 800                                                  user_function, void *context))
 801 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 802                              acpi_set_current_resources(acpi_handle device,
 803                                                         struct acpi_buffer
 804                                                         *in_buffer))
 805 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 806                              acpi_get_irq_routing_table(acpi_handle device,
 807                                                         struct acpi_buffer
 808                                                         *ret_buffer))
 809 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 810                              acpi_resource_to_address64(struct acpi_resource
 811                                                         *resource,
 812                                                         struct
 813                                                         acpi_resource_address64
 814                                                         *out))
 815 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 816                              acpi_buffer_to_resource(u8 *aml_buffer,
 817                                                      u16 aml_buffer_length,
 818                                                      struct acpi_resource
 819                                                      **resource_ptr))
 820
 821 /*
 822  * Hardware (ACPI device) interfaces
 823  */
 824 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
 825
 826 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 827                             acpi_read(u64 *value,
 828                                       struct acpi_generic_address *reg))
 829
 830 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 831                             acpi_write(u64 value,
 832                                        struct acpi_generic_address *reg))
 833
 834 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 835                                 acpi_read_bit_register(u32 register_id,
 836                                                        u32 *return_value))
 837
 838 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 839                                 acpi_write_bit_register(u32 register_id,
 840                                                         u32 value))
 841
 842 /*
 843  * Sleep/Wake interfaces
 844  */
 845 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 846                             acpi_get_sleep_type_data(u8 sleep_state,
 847                                                      u8 *slp_typ_a,
 848                                                      u8 *slp_typ_b))
 849
 850 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 851                             acpi_enter_sleep_state_prep(u8 sleep_state))
 852 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
 853
 854 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
 855
 856 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 857                             acpi_leave_sleep_state_prep(u8 sleep_state))
 858 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
 859
 860 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 861                                 acpi_set_firmware_waking_vectors
 862                                 (acpi_physical_address physical_address,
 863                                  acpi_physical_address physical_address64))
 864 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 865                                  acpi_set_firmware_waking_vector(u32
 866                                                                  physical_address))
 867 #if ACPI_MACHINE_WIDTH == 64
 868 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 869                                 acpi_set_firmware_waking_vector64(u64
 870                                                                   physical_address))
 871 #endif
 872 /*
 873  * ACPI Timer interfaces
 874  */
 875 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 876                                 acpi_get_timer_resolution(u32 *resolution))
 877 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
 878
 879 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 880                                 acpi_get_timer_duration(u32 start_ticks,
 881                                                         u32 end_ticks,
 882                                                         u32 *time_elapsed))
 883
 884 /*
 885  * Error/Warning output
 886  */
 887 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 888                                void ACPI_INTERNAL_VAR_XFACE
 889                                acpi_error(const char *module_name,
 890                                           u32 line_number,
 891                                           const char *format, ...))
 892 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
 893                                 void ACPI_INTERNAL_VAR_XFACE
 894                                 acpi_exception(const char *module_name,
 895                                                u32 line_number,
 896                                                acpi_status status,
 897                                                const char *format, ...))
 898 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 899                                 void ACPI_INTERNAL_VAR_XFACE
 900                                 acpi_warning(const char *module_name,
 901                                              u32 line_number,
 902                                              const char *format, ...))
 903 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 904                                 void ACPI_INTERNAL_VAR_XFACE
 905                                 acpi_info(const char *module_name,
 906                                           u32 line_number,
 907                                           const char *format, ...))
 908 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 909                                 void ACPI_INTERNAL_VAR_XFACE
 910                                 acpi_bios_error(const char *module_name,
 911                                                 u32 line_number,
 912                                                 const char *format, ...))
 913 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 914                                 void ACPI_INTERNAL_VAR_XFACE
 915                                 acpi_bios_warning(const char *module_name,
 916                                                   u32 line_number,
 917                                                   const char *format, ...))
 918
 919 /*
 920  * Debug output
 921  */
 922 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
 923                                void ACPI_INTERNAL_VAR_XFACE
 924                                acpi_debug_print(u32 requested_debug_level,
 925                                                 u32 line_number,
 926                                                 const char *function_name,
 927                                                 const char *module_name,
 928                                                 u32 component_id,
 929                                                 const char *format, ...))
 930 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
 931                                 void ACPI_INTERNAL_VAR_XFACE
 932                                 acpi_debug_print_raw(u32 requested_debug_level,
 933                                                      u32 line_number,
 934                                                      const char *function_name,
 935                                                      const char *module_name,
 936                                                      u32 component_id,
 937                                                      const char *format, ...))
 938
 939 ACPI_DBG_DEPENDENT_RETURN_VOID(void
 940                                acpi_trace_point(acpi_trace_event_type type,
 941                                                 u8 begin,
 942                                                 u8 *aml, char *pathname))
 943 ACPI_APP_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(1)
 944                                 void ACPI_INTERNAL_VAR_XFACE
 945                                 acpi_log_error(const char *format, ...))
 946  acpi_status acpi_initialize_debugger(void);
 947
 948 void acpi_terminate_debugger(void);
 949
 950 /*
 951  * Divergences
 952  */
 953 ACPI_GLOBAL(u8, acpi_gbl_permanent_mmap);
 954
 955 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 956                             acpi_get_table_with_size(acpi_string signature,
 957                                                      u32 instance,
 958                                                      struct acpi_table_header
 959                                                      **out_table,
 960                                                      acpi_size *tbl_size))
 961
 962 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 963                             acpi_get_data_full(acpi_handle object,
 964                                                acpi_object_handler handler,
 965                                                void **data,
 966                                                void (*callback)(void *)))
 967
 968 void acpi_run_debugger(char *batch_buffer);
 969
 970 void acpi_set_debugger_thread_id(acpi_thread_id thread_id);
 971
 972 #endif                          /* __ACXFACE_H__ */