LXR linux/include/acpi/acpixf.h

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