include/acpi/acpixf.h

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