include/acpi/acpixf.h

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