include/acpi/acpixf.h

   1 /******************************************************************************
   2  *
   3  * Name: acpixf.h - External interfaces to the ACPI subsystem
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2014, 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                 0x20140424
  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 TRUE, favor the 32-bit addresses.
 199  */
 200 ACPI_INIT_GLOBAL(u8, acpi_gbl_use32_bit_fadt_addresses, TRUE);
 201
 202 /*
 203  * Optionally truncate I/O addresses to 16 bits. Provides compatibility
 204  * with other ACPI implementations. NOTE: During ACPICA initialization,
 205  * this value is set to TRUE if any Windows OSI strings have been
 206  * requested by the BIOS.
 207  */
 208 ACPI_INIT_GLOBAL(u8, acpi_gbl_truncate_io_addresses, FALSE);
 209
 210 /*
 211  * Disable runtime checking and repair of values returned by control methods.
 212  * Use only if the repair is causing a problem on a particular machine.
 213  */
 214 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_auto_repair, FALSE);
 215
 216 /*
 217  * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
 218  * This can be useful for debugging ACPI problems on some machines.
 219  */
 220 ACPI_INIT_GLOBAL(u8, acpi_gbl_disable_ssdt_table_install, FALSE);
 221
 222 /*
 223  * We keep track of the latest version of Windows that has been requested by
 224  * the BIOS. ACPI 5.0.
 225  */
 226 ACPI_INIT_GLOBAL(u8, acpi_gbl_osi_data, 0);
 227
 228 /*
 229  * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
 230  * that the ACPI hardware is no longer required. A flag in the FADT indicates
 231  * a reduced HW machine, and that flag is duplicated here for convenience.
 232  */
 233 ACPI_INIT_GLOBAL(u8, acpi_gbl_reduced_hardware, FALSE);
 234
 235 /*
 236  * This mechanism is used to trace a specified AML method. The method is
 237  * traced each time it is executed.
 238  */
 239 ACPI_INIT_GLOBAL(u32, acpi_gbl_trace_flags, 0);
 240 ACPI_INIT_GLOBAL(acpi_name, acpi_gbl_trace_method_name, 0);
 241
 242 /*
 243  * Runtime configuration of debug output control masks. We want the debug
 244  * switches statically initialized so they are already set when the debugger
 245  * is entered.
 246  */
 247 ACPI_INIT_GLOBAL(u32, acpi_dbg_level, ACPI_DEBUG_DEFAULT);
 248 ACPI_INIT_GLOBAL(u32, acpi_dbg_layer, 0);
 249
 250 /*
 251  * Other miscellaneous globals
 252  */
 253 ACPI_GLOBAL(struct acpi_table_fadt, acpi_gbl_FADT);
 254 ACPI_GLOBAL(u32, acpi_current_gpe_count);
 255 ACPI_GLOBAL(u8, acpi_gbl_system_awake_and_running);
 256
 257 /*****************************************************************************
 258  *
 259  * ACPICA public interface configuration.
 260  *
 261  * Interfaces that are configured out of the ACPICA build are replaced
 262  * by inlined stubs by default.
 263  *
 264  ****************************************************************************/
 265
 266 /*
 267  * Hardware-reduced prototypes (default: Not hardware reduced).
 268  *
 269  * All ACPICA hardware-related interfaces that use these macros will be
 270  * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
 271  * is set to TRUE.
 272  *
 273  * Note: This static build option for reduced hardware is intended to
 274  * reduce ACPICA code size if desired or necessary. However, even if this
 275  * option is not specified, the runtime behavior of ACPICA is dependent
 276  * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
 277  * the flag will enable similar behavior -- ACPICA will not attempt
 278  * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
 279  */
 280 #if (!ACPI_REDUCED_HARDWARE)
 281 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
 282         ACPI_EXTERNAL_RETURN_STATUS(prototype)
 283
 284 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
 285         ACPI_EXTERNAL_RETURN_OK(prototype)
 286
 287 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
 288         ACPI_EXTERNAL_RETURN_VOID(prototype)
 289
 290 #else
 291 #define ACPI_HW_DEPENDENT_RETURN_STATUS(prototype) \
 292         static ACPI_INLINE prototype {return(AE_NOT_CONFIGURED);}
 293
 294 #define ACPI_HW_DEPENDENT_RETURN_OK(prototype) \
 295         static ACPI_INLINE prototype {return(AE_OK);}
 296
 297 #define ACPI_HW_DEPENDENT_RETURN_VOID(prototype) \
 298         static ACPI_INLINE prototype {return;}
 299
 300 #endif                          /* !ACPI_REDUCED_HARDWARE */
 301
 302 /*
 303  * Error message prototypes (default: error messages enabled).
 304  *
 305  * All interfaces related to error and warning messages
 306  * will be configured out of the ACPICA build if the
 307  * ACPI_NO_ERROR_MESSAGE flag is defined.
 308  */
 309 #ifndef ACPI_NO_ERROR_MESSAGES
 310 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
 311         prototype;
 312
 313 #else
 314 #define ACPI_MSG_DEPENDENT_RETURN_VOID(prototype) \
 315         static ACPI_INLINE prototype {return;}
 316
 317 #endif                          /* ACPI_NO_ERROR_MESSAGES */
 318
 319 /*
 320  * Debugging output prototypes (default: no debug output).
 321  *
 322  * All interfaces related to debug output messages
 323  * will be configured out of the ACPICA build unless the
 324  * ACPI_DEBUG_OUTPUT flag is defined.
 325  */
 326 #ifdef ACPI_DEBUG_OUTPUT
 327 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
 328         prototype;
 329
 330 #else
 331 #define ACPI_DBG_DEPENDENT_RETURN_VOID(prototype) \
 332         static ACPI_INLINE prototype {return;}
 333
 334 #endif                          /* ACPI_DEBUG_OUTPUT */
 335
 336 /*****************************************************************************
 337  *
 338  * ACPICA public interface prototypes
 339  *
 340  ****************************************************************************/
 341
 342 /*
 343  * Initialization
 344  */
 345 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 346                             acpi_initialize_tables(struct acpi_table_desc
 347                                                    *initial_storage,
 348                                                    u32 initial_table_count,
 349                                                    u8 allow_resize))
 350 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_initialize_subsystem(void))
 351
 352 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_enable_subsystem(u32 flags))
 353
 354 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 355                             acpi_initialize_objects(u32 flags))
 356 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_terminate(void))
 357
 358 /*
 359  * Miscellaneous global interfaces
 360  */
 361 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable(void))
 362 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable(void))
 363 #ifdef ACPI_FUTURE_USAGE
 364 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_subsystem_status(void))
 365 #endif
 366
 367 #ifdef ACPI_FUTURE_USAGE
 368 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 369                             acpi_get_system_info(struct acpi_buffer
 370                                                  *ret_buffer))
 371 #endif
 372 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 373                              acpi_get_statistics(struct acpi_statistics *stats))
 374 ACPI_EXTERNAL_RETURN_PTR(const char
 375                           *acpi_format_exception(acpi_status exception))
 376 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_purge_cached_objects(void))
 377
 378 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 379                             acpi_install_interface(acpi_string interface_name))
 380
 381 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 382                             acpi_remove_interface(acpi_string interface_name))
 383 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_update_interfaces(u8 action))
 384
 385 ACPI_EXTERNAL_RETURN_UINT32(u32
 386                             acpi_check_address_range(acpi_adr_space_type
 387                                                      space_id,
 388                                                      acpi_physical_address
 389                                                      address, acpi_size length,
 390                                                      u8 warn))
 391 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 392                              acpi_decode_pld_buffer(u8 *in_buffer,
 393                                                     acpi_size length,
 394                                                     struct acpi_pld_info
 395                                                     **return_buffer))
 396
 397 /*
 398  * ACPI table load/unload interfaces
 399  */
 400 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 401                             acpi_install_table(acpi_physical_address address,
 402                                                u8 physical))
 403
 404 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 405                             acpi_load_table(struct acpi_table_header *table))
 406
 407 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 408                             acpi_unload_parent_table(acpi_handle object))
 409 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_load_tables(void))
 410
 411 /*
 412  * ACPI table manipulation interfaces
 413  */
 414 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init acpi_reallocate_root_table(void))
 415
 416 ACPI_EXTERNAL_RETURN_STATUS(acpi_status __init
 417                             acpi_find_root_pointer(acpi_size * rsdp_address))
 418
 419 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 420                             acpi_get_table_header(acpi_string signature,
 421                                                   u32 instance,
 422                                                   struct acpi_table_header
 423                                                   *out_table_header))
 424 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 425                              acpi_get_table(acpi_string signature, u32 instance,
 426                                             struct acpi_table_header
 427                                             **out_table))
 428 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 429                              acpi_get_table_by_index(u32 table_index,
 430                                                      struct acpi_table_header
 431                                                      **out_table))
 432 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 433                              acpi_install_table_handler(acpi_table_handler
 434                                                         handler, void *context))
 435 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 436                              acpi_remove_table_handler(acpi_table_handler
 437                                                        handler))
 438
 439 /*
 440  * Namespace and name interfaces
 441  */
 442 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 443                             acpi_walk_namespace(acpi_object_type type,
 444                                                 acpi_handle start_object,
 445                                                 u32 max_depth,
 446                                                 acpi_walk_callback
 447                                                 descending_callback,
 448                                                 acpi_walk_callback
 449                                                 ascending_callback,
 450                                                 void *context,
 451                                                 void **return_value))
 452 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 453                              acpi_get_devices(const char *HID,
 454                                               acpi_walk_callback user_function,
 455                                               void *context,
 456                                               void **return_value))
 457 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 458                              acpi_get_name(acpi_handle object, u32 name_type,
 459                                            struct acpi_buffer *ret_path_ptr))
 460 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 461                              acpi_get_handle(acpi_handle parent,
 462                                              acpi_string pathname,
 463                                              acpi_handle * ret_handle))
 464 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 465                              acpi_attach_data(acpi_handle object,
 466                                               acpi_object_handler handler,
 467                                               void *data))
 468 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 469                              acpi_detach_data(acpi_handle object,
 470                                               acpi_object_handler handler))
 471 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 472                              acpi_get_data(acpi_handle object,
 473                                            acpi_object_handler handler,
 474                                            void **data))
 475 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 476                              acpi_debug_trace(char *name, u32 debug_level,
 477                                               u32 debug_layer, u32 flags))
 478
 479 /*
 480  * Object manipulation and enumeration
 481  */
 482 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 483                             acpi_evaluate_object(acpi_handle object,
 484                                                  acpi_string pathname,
 485                                                  struct acpi_object_list
 486                                                  *parameter_objects,
 487                                                  struct acpi_buffer
 488                                                  *return_object_buffer))
 489 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 490                              acpi_evaluate_object_typed(acpi_handle object,
 491                                                         acpi_string pathname,
 492                                                         struct acpi_object_list
 493                                                         *external_params,
 494                                                         struct acpi_buffer
 495                                                         *return_buffer,
 496                                                         acpi_object_type
 497                                                         return_type))
 498 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 499                              acpi_get_object_info(acpi_handle object,
 500                                                   struct acpi_device_info
 501                                                   **return_buffer))
 502 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_install_method(u8 *buffer))
 503
 504 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 505                             acpi_get_next_object(acpi_object_type type,
 506                                                  acpi_handle parent,
 507                                                  acpi_handle child,
 508                                                  acpi_handle * out_handle))
 509
 510 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 511                             acpi_get_type(acpi_handle object,
 512                                           acpi_object_type * out_type))
 513
 514 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 515                             acpi_get_parent(acpi_handle object,
 516                                             acpi_handle * out_handle))
 517
 518 /*
 519  * Handler interfaces
 520  */
 521 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 522                             acpi_install_initialization_handler
 523                             (acpi_init_handler handler, u32 function))
 524 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 525                                  acpi_install_sci_handler(acpi_sci_handler
 526                                                           address,
 527                                                           void *context))
 528 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 529                                  acpi_remove_sci_handler(acpi_sci_handler
 530                                                          address))
 531 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 532                                  acpi_install_global_event_handler
 533                                  (acpi_gbl_event_handler handler,
 534                                   void *context))
 535 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 536                                  acpi_install_fixed_event_handler(u32
 537                                                                   acpi_event,
 538                                                                   acpi_event_handler
 539                                                                   handler,
 540                                                                   void
 541                                                                   *context))
 542 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 543                                  acpi_remove_fixed_event_handler(u32 acpi_event,
 544                                                                  acpi_event_handler
 545                                                                  handler))
 546 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 547                                  acpi_install_gpe_handler(acpi_handle
 548                                                           gpe_device,
 549                                                           u32 gpe_number,
 550                                                           u32 type,
 551                                                           acpi_gpe_handler
 552                                                           address,
 553                                                           void *context))
 554 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 555                                  acpi_remove_gpe_handler(acpi_handle gpe_device,
 556                                                          u32 gpe_number,
 557                                                          acpi_gpe_handler
 558                                                          address))
 559 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 560                              acpi_install_notify_handler(acpi_handle device,
 561                                                          u32 handler_type,
 562                                                          acpi_notify_handler
 563                                                          handler,
 564                                                          void *context))
 565 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 566                              acpi_remove_notify_handler(acpi_handle device,
 567                                                         u32 handler_type,
 568                                                         acpi_notify_handler
 569                                                         handler))
 570 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 571                              acpi_install_address_space_handler(acpi_handle
 572                                                                 device,
 573                                                                 acpi_adr_space_type
 574                                                                 space_id,
 575                                                                 acpi_adr_space_handler
 576                                                                 handler,
 577                                                                 acpi_adr_space_setup
 578                                                                 setup,
 579                                                                 void *context))
 580 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 581                              acpi_remove_address_space_handler(acpi_handle
 582                                                                device,
 583                                                                acpi_adr_space_type
 584                                                                space_id,
 585                                                                acpi_adr_space_handler
 586                                                                handler))
 587 #ifdef ACPI_FUTURE_USAGE
 588 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 589                              acpi_install_exception_handler
 590                              (acpi_exception_handler handler))
 591 #endif
 592 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 593                              acpi_install_interface_handler
 594                              (acpi_interface_handler handler))
 595
 596 /*
 597  * Global Lock interfaces
 598  */
 599 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 600                                 acpi_acquire_global_lock(u16 timeout,
 601                                                          u32 *handle))
 602
 603 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 604                                 acpi_release_global_lock(u32 handle))
 605
 606 /*
 607  * Interfaces to AML mutex objects
 608  */
 609 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 610                             acpi_acquire_mutex(acpi_handle handle,
 611                                                acpi_string pathname,
 612                                                u16 timeout))
 613
 614 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 615                             acpi_release_mutex(acpi_handle handle,
 616                                                acpi_string pathname))
 617
 618 /*
 619  * Fixed Event interfaces
 620  */
 621 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 622                                 acpi_enable_event(u32 event, u32 flags))
 623
 624 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 625                                 acpi_disable_event(u32 event, u32 flags))
 626 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_clear_event(u32 event))
 627
 628 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 629                                 acpi_get_event_status(u32 event,
 630                                                       acpi_event_status
 631                                                       *event_status))
 632
 633 /*
 634  * General Purpose Event (GPE) Interfaces
 635  */
 636 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_update_all_gpes(void))
 637
 638 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 639                                 acpi_enable_gpe(acpi_handle gpe_device,
 640                                                 u32 gpe_number))
 641
 642 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 643                                 acpi_disable_gpe(acpi_handle gpe_device,
 644                                                  u32 gpe_number))
 645
 646 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 647                                 acpi_clear_gpe(acpi_handle gpe_device,
 648                                                u32 gpe_number))
 649
 650 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 651                                 acpi_set_gpe(acpi_handle gpe_device,
 652                                              u32 gpe_number, u8 action))
 653
 654 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 655                                 acpi_finish_gpe(acpi_handle gpe_device,
 656                                                 u32 gpe_number))
 657
 658 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 659                                 acpi_setup_gpe_for_wake(acpi_handle
 660                                                         parent_device,
 661                                                         acpi_handle gpe_device,
 662                                                         u32 gpe_number))
 663 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 664                                  acpi_set_gpe_wake_mask(acpi_handle gpe_device,
 665                                                         u32 gpe_number,
 666                                                         u8 action))
 667 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 668                                  acpi_get_gpe_status(acpi_handle gpe_device,
 669                                                      u32 gpe_number,
 670                                                      acpi_event_status
 671                                                      *event_status))
 672 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_disable_all_gpes(void))
 673 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enable_all_runtime_gpes(void))
 674
 675 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 676                                 acpi_get_gpe_device(u32 gpe_index,
 677                                                     acpi_handle * gpe_device))
 678
 679 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 680                                 acpi_install_gpe_block(acpi_handle gpe_device,
 681                                                        struct
 682                                                        acpi_generic_address
 683                                                        *gpe_block_address,
 684                                                        u32 register_count,
 685                                                        u32 interrupt_number))
 686 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 687                                  acpi_remove_gpe_block(acpi_handle gpe_device))
 688
 689 /*
 690  * Resource interfaces
 691  */
 692 typedef
 693 acpi_status(*acpi_walk_resource_callback) (struct acpi_resource * resource,
 694                                            void *context);
 695
 696 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 697                             acpi_get_vendor_resource(acpi_handle device,
 698                                                      char *name,
 699                                                      struct acpi_vendor_uuid
 700                                                      *uuid,
 701                                                      struct acpi_buffer
 702                                                      *ret_buffer))
 703 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 704                              acpi_get_current_resources(acpi_handle device,
 705                                                         struct acpi_buffer
 706                                                         *ret_buffer))
 707 #ifdef ACPI_FUTURE_USAGE
 708 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 709                              acpi_get_possible_resources(acpi_handle device,
 710                                                          struct acpi_buffer
 711                                                          *ret_buffer))
 712 #endif
 713 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 714                              acpi_get_event_resources(acpi_handle device_handle,
 715                                                       struct acpi_buffer
 716                                                       *ret_buffer))
 717 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 718                              acpi_walk_resource_buffer(struct acpi_buffer
 719                                                        *buffer,
 720                                                        acpi_walk_resource_callback
 721                                                        user_function,
 722                                                        void *context))
 723 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 724                              acpi_walk_resources(acpi_handle device, char *name,
 725                                                  acpi_walk_resource_callback
 726                                                  user_function, void *context))
 727 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 728                              acpi_set_current_resources(acpi_handle device,
 729                                                         struct acpi_buffer
 730                                                         *in_buffer))
 731 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 732                              acpi_get_irq_routing_table(acpi_handle device,
 733                                                         struct acpi_buffer
 734                                                         *ret_buffer))
 735 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 736                              acpi_resource_to_address64(struct acpi_resource
 737                                                         *resource,
 738                                                         struct
 739                                                         acpi_resource_address64
 740                                                         *out))
 741 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 742                              acpi_buffer_to_resource(u8 *aml_buffer,
 743                                                      u16 aml_buffer_length,
 744                                                      struct acpi_resource
 745                                                      **resource_ptr))
 746
 747 /*
 748  * Hardware (ACPI device) interfaces
 749  */
 750 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_reset(void))
 751
 752 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 753                             acpi_read(u64 *value,
 754                                       struct acpi_generic_address *reg))
 755
 756 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 757                             acpi_write(u64 value,
 758                                        struct acpi_generic_address *reg))
 759
 760 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 761                                 acpi_read_bit_register(u32 register_id,
 762                                                        u32 *return_value))
 763
 764 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 765                                 acpi_write_bit_register(u32 register_id,
 766                                                         u32 value))
 767
 768 /*
 769  * Sleep/Wake interfaces
 770  */
 771 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 772                             acpi_get_sleep_type_data(u8 sleep_state,
 773                                                      u8 *slp_typ_a,
 774                                                      u8 *slp_typ_b))
 775
 776 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 777                             acpi_enter_sleep_state_prep(u8 sleep_state))
 778 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_enter_sleep_state(u8 sleep_state))
 779
 780 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_enter_sleep_state_s4bios(void))
 781
 782 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 783                             acpi_leave_sleep_state_prep(u8 sleep_state))
 784 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_leave_sleep_state(u8 sleep_state))
 785
 786 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 787                                 acpi_set_firmware_waking_vector(u32
 788                                                                 physical_address))
 789 #if ACPI_MACHINE_WIDTH == 64
 790 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 791                                 acpi_set_firmware_waking_vector64(u64
 792                                                                   physical_address))
 793 #endif
 794 /*
 795  * ACPI Timer interfaces
 796  */
 797 #ifdef ACPI_FUTURE_USAGE
 798 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 799                                 acpi_get_timer_resolution(u32 *resolution))
 800 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status acpi_get_timer(u32 *ticks))
 801
 802 ACPI_HW_DEPENDENT_RETURN_STATUS(acpi_status
 803                                 acpi_get_timer_duration(u32 start_ticks,
 804                                                         u32 end_ticks,
 805                                                         u32 *time_elapsed))
 806 #endif                          /* ACPI_FUTURE_USAGE */
 807
 808 /*
 809  * Error/Warning output
 810  */
 811 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 812                                void ACPI_INTERNAL_VAR_XFACE
 813                                acpi_error(const char *module_name,
 814                                           u32 line_number,
 815                                           const char *format, ...))
 816 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(4)
 817                                 void ACPI_INTERNAL_VAR_XFACE
 818                                 acpi_exception(const char *module_name,
 819                                                u32 line_number,
 820                                                acpi_status status,
 821                                                const char *format, ...))
 822 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 823                                 void ACPI_INTERNAL_VAR_XFACE
 824                                 acpi_warning(const char *module_name,
 825                                              u32 line_number,
 826                                              const char *format, ...))
 827 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 828                                 void ACPI_INTERNAL_VAR_XFACE
 829                                 acpi_info(const char *module_name,
 830                                           u32 line_number,
 831                                           const char *format, ...))
 832 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 833                                 void ACPI_INTERNAL_VAR_XFACE
 834                                 acpi_bios_error(const char *module_name,
 835                                                 u32 line_number,
 836                                                 const char *format, ...))
 837 ACPI_MSG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(3)
 838                                 void ACPI_INTERNAL_VAR_XFACE
 839                                 acpi_bios_warning(const char *module_name,
 840                                                   u32 line_number,
 841                                                   const char *format, ...))
 842
 843 /*
 844  * Debug output
 845  */
 846 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
 847                                void ACPI_INTERNAL_VAR_XFACE
 848                                acpi_debug_print(u32 requested_debug_level,
 849                                                 u32 line_number,
 850                                                 const char *function_name,
 851                                                 const char *module_name,
 852                                                 u32 component_id,
 853                                                 const char *format, ...))
 854 ACPI_DBG_DEPENDENT_RETURN_VOID(ACPI_PRINTF_LIKE(6)
 855                                 void ACPI_INTERNAL_VAR_XFACE
 856                                 acpi_debug_print_raw(u32 requested_debug_level,
 857                                                      u32 line_number,
 858                                                      const char *function_name,
 859                                                      const char *module_name,
 860                                                      u32 component_id,
 861                                                      const char *format, ...))
 862
 863 /*
 864  * Divergences
 865  */
 866 ACPI_GLOBAL(u8, acpi_gbl_permanent_mmap);
 867
 868 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 869                             acpi_get_id(acpi_handle object,
 870                                         acpi_owner_id * out_type))
 871
 872 ACPI_EXTERNAL_RETURN_STATUS(acpi_status acpi_unload_table_id(acpi_owner_id id))
 873
 874 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 875                             acpi_get_table_with_size(acpi_string signature,
 876                                                      u32 instance,
 877                                                      struct acpi_table_header
 878                                                      **out_table,
 879                                                      acpi_size *tbl_size))
 880
 881 ACPI_EXTERNAL_RETURN_STATUS(acpi_status
 882                             acpi_get_data_full(acpi_handle object,
 883                                                acpi_object_handler handler,
 884                                                void **data,
 885                                                void (*callback)(void *)))
 886
 887 #endif                          /* __ACXFACE_H__ */