1 /******************************************************************************
3 * Name: acpixf.h - External interfaces to the ACPI subsystem
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
150 *****************************************************************************/
152 #ifndef __ACXFACE_H__
153 #define __ACXFACE_H__
155 /* Current ACPICA subsystem version in YYYYMMDD format */
157 #define ACPI_CA_VERSION 0x20180927
159 #include "acconfig.h"
162 #include "acbuffer.h"
165 /*****************************************************************************
167 * Macros used for ACPICA globals and configuration
169 ****************************************************************************/
172 * Ensure that global variables are defined and initialized only once.
174 * The use of these macros allows for a single list of globals (here)
175 * in order to simplify maintenance of the code.
177 #ifdef DEFINE_ACPI_GLOBALS
178 #define ACPI_GLOBAL(type,name) \
182 #define ACPI_INIT_GLOBAL(type,name,value) \
187 #define ACPI_GLOBAL(type,name) \
191 #ifndef ACPI_INIT_GLOBAL
192 #define ACPI_INIT_GLOBAL(type,name,value) \
198 * These macros configure the various ACPICA interfaces. They are
199 * useful for generating stub inline functions for features that are
200 * configured out of the current kernel or ACPICA application.
202 #ifndef ACPI_EXTERNAL_RETURN_STATUS
203 #define ACPI_EXTERNAL_RETURN_STATUS(Prototype) \
207 #ifndef ACPI_EXTERNAL_RETURN_OK
208 #define ACPI_EXTERNAL_RETURN_OK(Prototype) \
212 #ifndef ACPI_EXTERNAL_RETURN_VOID
213 #define ACPI_EXTERNAL_RETURN_VOID(Prototype) \
217 #ifndef ACPI_EXTERNAL_RETURN_UINT32
218 #define ACPI_EXTERNAL_RETURN_UINT32(Prototype) \
222 #ifndef ACPI_EXTERNAL_RETURN_PTR
223 #define ACPI_EXTERNAL_RETURN_PTR(Prototype) \
228 /*****************************************************************************
230 * Public globals and runtime configuration options
232 ****************************************************************************/
235 * Enable "slack mode" of the AML interpreter? Default is FALSE, and the
236 * interpreter strictly follows the ACPI specification. Setting to TRUE
237 * allows the interpreter to ignore certain errors and/or bad AML constructs.
239 * Currently, these features are enabled by this flag:
241 * 1) Allow "implicit return" of last value in a control method
242 * 2) Allow access beyond the end of an operation region
243 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
244 * 4) Allow ANY object type to be a source operand for the Store() operator
245 * 5) Allow unresolved references (invalid target name) in package objects
246 * 6) Enable warning messages for behavior that is not ACPI spec compliant
248 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_EnableInterpreterSlack
, FALSE
);
251 * Automatically serialize all methods that create named objects? Default
252 * is TRUE, meaning that all NonSerialized methods are scanned once at
253 * table load time to determine those that create named objects. Methods
254 * that create named objects are marked Serialized in order to prevent
255 * possible run-time problems if they are entered by more than one thread.
257 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_AutoSerializeMethods
, TRUE
);
260 * Create the predefined _OSI method in the namespace? Default is TRUE
261 * because ACPICA is fully compatible with other ACPI implementations.
262 * Changing this will revert ACPICA (and machine ASL) to pre-OSI behavior.
264 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_CreateOsiMethod
, TRUE
);
267 * Optionally use default values for the ACPI register widths. Set this to
268 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
270 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_UseDefaultRegisterWidths
, TRUE
);
273 * Whether or not to validate (map) an entire table to verify
274 * checksum/duplication in early stage before install. Set this to TRUE to
275 * allow early table validation before install it to the table manager.
276 * Note that enabling this option causes errors to happen in some OSPMs
277 * during early initialization stages. Default behavior is to allow such
280 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_EnableTableValidation
, TRUE
);
283 * Optionally enable output from the AML Debug Object.
285 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_EnableAmlDebugObject
, FALSE
);
288 * Optionally copy the entire DSDT to local memory (instead of simply
289 * mapping it.) There are some BIOSs that corrupt or replace the original
290 * DSDT, creating the need for this option. Default is FALSE, do not copy
293 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_CopyDsdtLocally
, FALSE
);
296 * Optionally ignore an XSDT if present and use the RSDT instead.
297 * Although the ACPI specification requires that an XSDT be used instead
298 * of the RSDT, the XSDT has been found to be corrupt or ill-formed on
299 * some machines. Default behavior is to use the XSDT if present.
301 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_DoNotUseXsdt
, FALSE
);
304 * Optionally support group module level code.
305 * NOTE, this is essentially obsolete and will be removed soon
308 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_GroupModuleLevelCode
, FALSE
);
311 * Optionally support module level code by parsing an entire table as
312 * a method as it is loaded. Default is TRUE.
313 * NOTE, this is essentially obsolete and will be removed soon
316 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_ExecuteTablesAsMethods
, TRUE
);
319 * Optionally use 32-bit FADT addresses if and when there is a conflict
320 * (address mismatch) between the 32-bit and 64-bit versions of the
321 * address. Although ACPICA adheres to the ACPI specification which
322 * requires the use of the corresponding 64-bit address if it is non-zero,
323 * some machines have been found to have a corrupted non-zero 64-bit
324 * address. Default is FALSE, do not favor the 32-bit addresses.
326 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_Use32BitFadtAddresses
, FALSE
);
329 * Optionally use 32-bit FACS table addresses.
330 * It is reported that some platforms fail to resume from system suspending
331 * if 64-bit FACS table address is selected:
332 * https://bugzilla.kernel.org/show_bug.cgi?id=74021
333 * Default is TRUE, favor the 32-bit addresses.
335 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_Use32BitFacsAddresses
, TRUE
);
338 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
339 * with other ACPI implementations. NOTE: During ACPICA initialization,
340 * this value is set to TRUE if any Windows OSI strings have been
341 * requested by the BIOS.
343 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_TruncateIoAddresses
, FALSE
);
346 * Disable runtime checking and repair of values returned by control methods.
347 * Use only if the repair is causing a problem on a particular machine.
349 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_DisableAutoRepair
, FALSE
);
352 * Optionally do not install any SSDTs from the RSDT/XSDT during initialization.
353 * This can be useful for debugging ACPI problems on some machines.
355 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_DisableSsdtTableInstall
, FALSE
);
358 * Optionally enable runtime namespace override.
360 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_RuntimeNamespaceOverride
, TRUE
);
363 * We keep track of the latest version of Windows that has been requested by
364 * the BIOS. ACPI 5.0.
366 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_OsiData
, 0);
369 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
370 * that the ACPI hardware is no longer required. A flag in the FADT indicates
371 * a reduced HW machine, and that flag is duplicated here for convenience.
373 ACPI_INIT_GLOBAL (BOOLEAN
, AcpiGbl_ReducedHardware
, FALSE
);
376 * Maximum timeout for While() loop iterations before forced method abort.
377 * This mechanism is intended to prevent infinite loops during interpreter
378 * execution within a host kernel.
380 ACPI_INIT_GLOBAL (UINT32
, AcpiGbl_MaxLoopIterations
, ACPI_MAX_LOOP_TIMEOUT
);
383 * Optionally ignore AE_NOT_FOUND errors from named reference package elements
384 * during DSDT/SSDT table loading. This reduces error "noise" in platforms
385 * whose firmware is carrying around a bunch of unused package objects that
386 * refer to non-existent named objects. However, If the AML actually tries to
387 * use such a package, the unresolved element(s) will be replaced with NULL
390 ACPI_INIT_GLOBAL (BOOLEAN
, AcpiGbl_IgnorePackageResolutionErrors
, FALSE
);
393 * This mechanism is used to trace a specified AML method. The method is
394 * traced each time it is executed.
396 ACPI_INIT_GLOBAL (UINT32
, AcpiGbl_TraceFlags
, 0);
397 ACPI_INIT_GLOBAL (const char *, AcpiGbl_TraceMethodName
, NULL
);
398 ACPI_INIT_GLOBAL (UINT32
, AcpiGbl_TraceDbgLevel
, ACPI_TRACE_LEVEL_DEFAULT
);
399 ACPI_INIT_GLOBAL (UINT32
, AcpiGbl_TraceDbgLayer
, ACPI_TRACE_LAYER_DEFAULT
);
402 * Runtime configuration of debug output control masks. We want the debug
403 * switches statically initialized so they are already set when the debugger
406 #ifdef ACPI_DEBUG_OUTPUT
407 ACPI_INIT_GLOBAL (UINT32
, AcpiDbgLevel
, ACPI_DEBUG_DEFAULT
);
409 ACPI_INIT_GLOBAL (UINT32
, AcpiDbgLevel
, ACPI_NORMAL_DEFAULT
);
411 ACPI_INIT_GLOBAL (UINT32
, AcpiDbgLayer
, ACPI_COMPONENT_DEFAULT
);
413 /* Optionally enable timer output with Debug Object output */
415 ACPI_INIT_GLOBAL (UINT8
, AcpiGbl_DisplayDebugTimer
, FALSE
);
418 * Debugger command handshake globals. Host OSes need to access these
419 * variables to implement their own command handshake mechanism.
422 ACPI_INIT_GLOBAL (BOOLEAN
, AcpiGbl_MethodExecuting
, FALSE
);
423 ACPI_GLOBAL (char, AcpiGbl_DbLineBuf
[ACPI_DB_LINE_BUFFER_SIZE
]);
427 * Other miscellaneous globals
429 ACPI_GLOBAL (ACPI_TABLE_FADT
, AcpiGbl_FADT
);
430 ACPI_GLOBAL (UINT32
, AcpiCurrentGpeCount
);
431 ACPI_GLOBAL (BOOLEAN
, AcpiGbl_SystemAwakeAndRunning
);
434 /*****************************************************************************
436 * ACPICA public interface configuration.
438 * Interfaces that are configured out of the ACPICA build are replaced
439 * by inlined stubs by default.
441 ****************************************************************************/
444 * Hardware-reduced prototypes (default: Not hardware reduced).
446 * All ACPICA hardware-related interfaces that use these macros will be
447 * configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
450 * Note: This static build option for reduced hardware is intended to
451 * reduce ACPICA code size if desired or necessary. However, even if this
452 * option is not specified, the runtime behavior of ACPICA is dependent
453 * on the actual FADT reduced hardware flag (HW_REDUCED_ACPI). If set,
454 * the flag will enable similar behavior -- ACPICA will not attempt
455 * to access any ACPI-relate hardware (SCI, GPEs, Fixed Events, etc.)
457 #if (!ACPI_REDUCED_HARDWARE)
458 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
459 ACPI_EXTERNAL_RETURN_STATUS(Prototype)
461 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
462 ACPI_EXTERNAL_RETURN_OK(Prototype)
464 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
465 ACPI_EXTERNAL_RETURN_VOID(Prototype)
468 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
469 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
471 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
472 static ACPI_INLINE Prototype {return(AE_OK);}
474 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
475 static ACPI_INLINE Prototype {return;}
477 #endif /* !ACPI_REDUCED_HARDWARE */
481 * Error message prototypes (default: error messages enabled).
483 * All interfaces related to error and warning messages
484 * will be configured out of the ACPICA build if the
485 * ACPI_NO_ERROR_MESSAGE flag is defined.
487 #ifndef ACPI_NO_ERROR_MESSAGES
488 #define ACPI_MSG_DEPENDENT_RETURN_VOID(Prototype) \
492 #define ACPI_MSG_DEPENDENT_RETURN_VOID(Prototype) \
493 static ACPI_INLINE Prototype {return;}
495 #endif /* ACPI_NO_ERROR_MESSAGES */
499 * Debugging output prototypes (default: no debug output).
501 * All interfaces related to debug output messages
502 * will be configured out of the ACPICA build unless the
503 * ACPI_DEBUG_OUTPUT flag is defined.
505 #ifdef ACPI_DEBUG_OUTPUT
506 #define ACPI_DBG_DEPENDENT_RETURN_VOID(Prototype) \
510 #define ACPI_DBG_DEPENDENT_RETURN_VOID(Prototype) \
511 static ACPI_INLINE Prototype {return;}
513 #endif /* ACPI_DEBUG_OUTPUT */
517 * Application prototypes
519 * All interfaces used by application will be configured
520 * out of the ACPICA build unless the ACPI_APPLICATION
523 #ifdef ACPI_APPLICATION
524 #define ACPI_APP_DEPENDENT_RETURN_VOID(Prototype) \
528 #define ACPI_APP_DEPENDENT_RETURN_VOID(Prototype) \
529 static ACPI_INLINE Prototype {return;}
531 #endif /* ACPI_APPLICATION */
535 * Debugger prototypes
537 * All interfaces used by debugger will be configured
538 * out of the ACPICA build unless the ACPI_DEBUGGER
542 #define ACPI_DBR_DEPENDENT_RETURN_OK(Prototype) \
543 ACPI_EXTERNAL_RETURN_OK(Prototype)
545 #define ACPI_DBR_DEPENDENT_RETURN_VOID(Prototype) \
546 ACPI_EXTERNAL_RETURN_VOID(Prototype)
549 #define ACPI_DBR_DEPENDENT_RETURN_OK(Prototype) \
550 static ACPI_INLINE Prototype {return(AE_OK);}
552 #define ACPI_DBR_DEPENDENT_RETURN_VOID(Prototype) \
553 static ACPI_INLINE Prototype {return;}
555 #endif /* ACPI_DEBUGGER */
558 /*****************************************************************************
560 * ACPICA public interface prototypes
562 ****************************************************************************/
567 ACPI_EXTERNAL_RETURN_STATUS (
568 ACPI_STATUS ACPI_INIT_FUNCTION
569 AcpiInitializeTables (
570 ACPI_TABLE_DESC
*InitialStorage
,
571 UINT32 InitialTableCount
,
572 BOOLEAN AllowResize
))
574 ACPI_EXTERNAL_RETURN_STATUS (
575 ACPI_STATUS ACPI_INIT_FUNCTION
576 AcpiInitializeSubsystem (
579 ACPI_EXTERNAL_RETURN_STATUS (
580 ACPI_STATUS ACPI_INIT_FUNCTION
581 AcpiEnableSubsystem (
584 ACPI_EXTERNAL_RETURN_STATUS (
585 ACPI_STATUS ACPI_INIT_FUNCTION
586 AcpiInitializeObjects (
589 ACPI_EXTERNAL_RETURN_STATUS (
590 ACPI_STATUS ACPI_INIT_FUNCTION
596 * Miscellaneous global interfaces
598 ACPI_HW_DEPENDENT_RETURN_STATUS (
603 ACPI_HW_DEPENDENT_RETURN_STATUS (
608 ACPI_EXTERNAL_RETURN_STATUS (
610 AcpiSubsystemStatus (
613 ACPI_EXTERNAL_RETURN_STATUS (
616 ACPI_BUFFER
*RetBuffer
))
618 ACPI_EXTERNAL_RETURN_STATUS (
621 ACPI_STATISTICS
*Stats
))
623 ACPI_EXTERNAL_RETURN_PTR (
625 AcpiFormatException (
626 ACPI_STATUS Exception
))
628 ACPI_EXTERNAL_RETURN_STATUS (
630 AcpiPurgeCachedObjects (
633 ACPI_EXTERNAL_RETURN_STATUS (
635 AcpiInstallInterface (
636 ACPI_STRING InterfaceName
))
638 ACPI_EXTERNAL_RETURN_STATUS (
640 AcpiRemoveInterface (
641 ACPI_STRING InterfaceName
))
643 ACPI_EXTERNAL_RETURN_STATUS (
645 AcpiUpdateInterfaces (
648 ACPI_EXTERNAL_RETURN_UINT32 (
650 AcpiCheckAddressRange (
651 ACPI_ADR_SPACE_TYPE SpaceId
,
652 ACPI_PHYSICAL_ADDRESS Address
,
656 ACPI_EXTERNAL_RETURN_STATUS (
658 AcpiDecodePldBuffer (
661 ACPI_PLD_INFO
**ReturnBuffer
))
665 * ACPI table load/unload interfaces
667 ACPI_EXTERNAL_RETURN_STATUS (
668 ACPI_STATUS ACPI_INIT_FUNCTION
670 ACPI_PHYSICAL_ADDRESS Address
,
673 ACPI_EXTERNAL_RETURN_STATUS (
676 ACPI_TABLE_HEADER
*Table
))
678 ACPI_EXTERNAL_RETURN_STATUS (
680 AcpiUnloadParentTable (
683 ACPI_EXTERNAL_RETURN_STATUS (
684 ACPI_STATUS ACPI_INIT_FUNCTION
690 * ACPI table manipulation interfaces
692 ACPI_EXTERNAL_RETURN_STATUS (
693 ACPI_STATUS ACPI_INIT_FUNCTION
694 AcpiReallocateRootTable (
697 ACPI_EXTERNAL_RETURN_STATUS (
698 ACPI_STATUS ACPI_INIT_FUNCTION
699 AcpiFindRootPointer (
700 ACPI_PHYSICAL_ADDRESS
*RsdpAddress
))
702 ACPI_EXTERNAL_RETURN_STATUS (
705 ACPI_STRING Signature
,
707 ACPI_TABLE_HEADER
*OutTableHeader
))
709 ACPI_EXTERNAL_RETURN_STATUS (
712 ACPI_STRING Signature
,
714 ACPI_TABLE_HEADER
**OutTable
))
716 ACPI_EXTERNAL_RETURN_VOID (
719 ACPI_TABLE_HEADER
*Table
))
721 ACPI_EXTERNAL_RETURN_STATUS (
723 AcpiGetTableByIndex (
725 ACPI_TABLE_HEADER
**OutTable
))
727 ACPI_EXTERNAL_RETURN_STATUS (
729 AcpiInstallTableHandler (
730 ACPI_TABLE_HANDLER Handler
,
733 ACPI_EXTERNAL_RETURN_STATUS (
735 AcpiRemoveTableHandler (
736 ACPI_TABLE_HANDLER Handler
))
740 * Namespace and name interfaces
742 ACPI_EXTERNAL_RETURN_STATUS (
745 ACPI_OBJECT_TYPE Type
,
746 ACPI_HANDLE StartObject
,
748 ACPI_WALK_CALLBACK DescendingCallback
,
749 ACPI_WALK_CALLBACK AscendingCallback
,
753 ACPI_EXTERNAL_RETURN_STATUS (
757 ACPI_WALK_CALLBACK UserFunction
,
761 ACPI_EXTERNAL_RETURN_STATUS (
766 ACPI_BUFFER
*RetPathPtr
))
768 ACPI_EXTERNAL_RETURN_STATUS (
772 ACPI_STRING Pathname
,
773 ACPI_HANDLE
*RetHandle
))
775 ACPI_EXTERNAL_RETURN_STATUS (
779 ACPI_OBJECT_HANDLER Handler
,
782 ACPI_EXTERNAL_RETURN_STATUS (
786 ACPI_OBJECT_HANDLER Handler
))
788 ACPI_EXTERNAL_RETURN_STATUS (
792 ACPI_OBJECT_HANDLER Handler
,
795 ACPI_EXTERNAL_RETURN_STATUS (
805 * Object manipulation and enumeration
807 ACPI_EXTERNAL_RETURN_STATUS (
811 ACPI_STRING Pathname
,
812 ACPI_OBJECT_LIST
*ParameterObjects
,
813 ACPI_BUFFER
*ReturnObjectBuffer
))
815 ACPI_EXTERNAL_RETURN_STATUS (
817 AcpiEvaluateObjectTyped (
819 ACPI_STRING Pathname
,
820 ACPI_OBJECT_LIST
*ExternalParams
,
821 ACPI_BUFFER
*ReturnBuffer
,
822 ACPI_OBJECT_TYPE ReturnType
))
824 ACPI_EXTERNAL_RETURN_STATUS (
828 ACPI_DEVICE_INFO
**ReturnBuffer
))
830 ACPI_EXTERNAL_RETURN_STATUS (
835 ACPI_EXTERNAL_RETURN_STATUS (
838 ACPI_OBJECT_TYPE Type
,
841 ACPI_HANDLE
*OutHandle
))
843 ACPI_EXTERNAL_RETURN_STATUS (
847 ACPI_OBJECT_TYPE
*OutType
))
849 ACPI_EXTERNAL_RETURN_STATUS (
853 ACPI_HANDLE
*OutHandle
))
859 ACPI_EXTERNAL_RETURN_STATUS (
861 AcpiInstallInitializationHandler (
862 ACPI_INIT_HANDLER Handler
,
865 ACPI_HW_DEPENDENT_RETURN_STATUS (
867 AcpiInstallSciHandler (
868 ACPI_SCI_HANDLER Address
,
871 ACPI_HW_DEPENDENT_RETURN_STATUS (
873 AcpiRemoveSciHandler (
874 ACPI_SCI_HANDLER Address
))
876 ACPI_HW_DEPENDENT_RETURN_STATUS (
878 AcpiInstallGlobalEventHandler (
879 ACPI_GBL_EVENT_HANDLER Handler
,
882 ACPI_HW_DEPENDENT_RETURN_STATUS (
884 AcpiInstallFixedEventHandler (
886 ACPI_EVENT_HANDLER Handler
,
889 ACPI_HW_DEPENDENT_RETURN_STATUS (
891 AcpiRemoveFixedEventHandler (
893 ACPI_EVENT_HANDLER Handler
))
895 ACPI_HW_DEPENDENT_RETURN_STATUS (
897 AcpiInstallGpeHandler (
898 ACPI_HANDLE GpeDevice
,
901 ACPI_GPE_HANDLER Address
,
904 ACPI_HW_DEPENDENT_RETURN_STATUS (
906 AcpiInstallGpeRawHandler (
907 ACPI_HANDLE GpeDevice
,
910 ACPI_GPE_HANDLER Address
,
913 ACPI_HW_DEPENDENT_RETURN_STATUS (
915 AcpiRemoveGpeHandler (
916 ACPI_HANDLE GpeDevice
,
918 ACPI_GPE_HANDLER Address
))
920 ACPI_EXTERNAL_RETURN_STATUS (
922 AcpiInstallNotifyHandler (
925 ACPI_NOTIFY_HANDLER Handler
,
928 ACPI_EXTERNAL_RETURN_STATUS (
930 AcpiRemoveNotifyHandler (
933 ACPI_NOTIFY_HANDLER Handler
))
935 ACPI_EXTERNAL_RETURN_STATUS (
937 AcpiInstallAddressSpaceHandler (
939 ACPI_ADR_SPACE_TYPE SpaceId
,
940 ACPI_ADR_SPACE_HANDLER Handler
,
941 ACPI_ADR_SPACE_SETUP Setup
,
944 ACPI_EXTERNAL_RETURN_STATUS (
946 AcpiRemoveAddressSpaceHandler (
948 ACPI_ADR_SPACE_TYPE SpaceId
,
949 ACPI_ADR_SPACE_HANDLER Handler
))
951 ACPI_EXTERNAL_RETURN_STATUS (
953 AcpiInstallExceptionHandler (
954 ACPI_EXCEPTION_HANDLER Handler
))
956 ACPI_EXTERNAL_RETURN_STATUS (
958 AcpiInstallInterfaceHandler (
959 ACPI_INTERFACE_HANDLER Handler
))
963 * Global Lock interfaces
965 ACPI_HW_DEPENDENT_RETURN_STATUS (
967 AcpiAcquireGlobalLock (
971 ACPI_HW_DEPENDENT_RETURN_STATUS (
973 AcpiReleaseGlobalLock (
978 * Interfaces to AML mutex objects
980 ACPI_EXTERNAL_RETURN_STATUS (
984 ACPI_STRING Pathname
,
987 ACPI_EXTERNAL_RETURN_STATUS (
991 ACPI_STRING Pathname
))
995 * Fixed Event interfaces
997 ACPI_HW_DEPENDENT_RETURN_STATUS (
1003 ACPI_HW_DEPENDENT_RETURN_STATUS (
1009 ACPI_HW_DEPENDENT_RETURN_STATUS (
1014 ACPI_HW_DEPENDENT_RETURN_STATUS (
1016 AcpiGetEventStatus (
1018 ACPI_EVENT_STATUS
*EventStatus
))
1022 * General Purpose Event (GPE) Interfaces
1024 ACPI_HW_DEPENDENT_RETURN_STATUS (
1029 ACPI_HW_DEPENDENT_RETURN_STATUS (
1032 ACPI_HANDLE GpeDevice
,
1035 ACPI_HW_DEPENDENT_RETURN_STATUS (
1038 ACPI_HANDLE GpeDevice
,
1041 ACPI_HW_DEPENDENT_RETURN_STATUS (
1044 ACPI_HANDLE GpeDevice
,
1047 ACPI_HW_DEPENDENT_RETURN_STATUS (
1050 ACPI_HANDLE GpeDevice
,
1054 ACPI_HW_DEPENDENT_RETURN_STATUS (
1057 ACPI_HANDLE GpeDevice
,
1060 ACPI_HW_DEPENDENT_RETURN_STATUS (
1063 ACPI_HANDLE GpeDevice
,
1067 ACPI_HW_DEPENDENT_RETURN_STATUS (
1069 AcpiMarkGpeForWake (
1070 ACPI_HANDLE GpeDevice
,
1073 ACPI_HW_DEPENDENT_RETURN_STATUS (
1075 AcpiSetupGpeForWake (
1076 ACPI_HANDLE ParentDevice
,
1077 ACPI_HANDLE GpeDevice
,
1080 ACPI_HW_DEPENDENT_RETURN_STATUS (
1082 AcpiSetGpeWakeMask (
1083 ACPI_HANDLE GpeDevice
,
1087 ACPI_HW_DEPENDENT_RETURN_STATUS (
1090 ACPI_HANDLE GpeDevice
,
1092 ACPI_EVENT_STATUS
*EventStatus
))
1094 ACPI_HW_DEPENDENT_RETURN_STATUS (
1096 AcpiDisableAllGpes (
1099 ACPI_HW_DEPENDENT_RETURN_STATUS (
1101 AcpiEnableAllRuntimeGpes (
1104 ACPI_HW_DEPENDENT_RETURN_STATUS (
1106 AcpiEnableAllWakeupGpes (
1109 ACPI_HW_DEPENDENT_RETURN_STATUS (
1113 ACPI_HANDLE
*GpeDevice
))
1115 ACPI_HW_DEPENDENT_RETURN_STATUS (
1117 AcpiInstallGpeBlock (
1118 ACPI_HANDLE GpeDevice
,
1119 ACPI_GENERIC_ADDRESS
*GpeBlockAddress
,
1120 UINT32 RegisterCount
,
1121 UINT32 InterruptNumber
))
1123 ACPI_HW_DEPENDENT_RETURN_STATUS (
1125 AcpiRemoveGpeBlock (
1126 ACPI_HANDLE GpeDevice
))
1130 * Resource interfaces
1133 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK
) (
1134 ACPI_RESOURCE
*Resource
,
1137 ACPI_EXTERNAL_RETURN_STATUS (
1139 AcpiGetVendorResource (
1142 ACPI_VENDOR_UUID
*Uuid
,
1143 ACPI_BUFFER
*RetBuffer
))
1145 ACPI_EXTERNAL_RETURN_STATUS (
1147 AcpiGetCurrentResources (
1149 ACPI_BUFFER
*RetBuffer
))
1151 ACPI_EXTERNAL_RETURN_STATUS (
1153 AcpiGetPossibleResources (
1155 ACPI_BUFFER
*RetBuffer
))
1157 ACPI_EXTERNAL_RETURN_STATUS (
1159 AcpiGetEventResources (
1160 ACPI_HANDLE DeviceHandle
,
1161 ACPI_BUFFER
*RetBuffer
))
1163 ACPI_EXTERNAL_RETURN_STATUS (
1165 AcpiWalkResourceBuffer (
1166 ACPI_BUFFER
*Buffer
,
1167 ACPI_WALK_RESOURCE_CALLBACK UserFunction
,
1170 ACPI_EXTERNAL_RETURN_STATUS (
1175 ACPI_WALK_RESOURCE_CALLBACK UserFunction
,
1178 ACPI_EXTERNAL_RETURN_STATUS (
1180 AcpiSetCurrentResources (
1182 ACPI_BUFFER
*InBuffer
))
1184 ACPI_EXTERNAL_RETURN_STATUS (
1186 AcpiGetIrqRoutingTable (
1188 ACPI_BUFFER
*RetBuffer
))
1190 ACPI_EXTERNAL_RETURN_STATUS (
1192 AcpiResourceToAddress64 (
1193 ACPI_RESOURCE
*Resource
,
1194 ACPI_RESOURCE_ADDRESS64
*Out
))
1196 ACPI_EXTERNAL_RETURN_STATUS (
1198 AcpiBufferToResource (
1200 UINT16 AmlBufferLength
,
1201 ACPI_RESOURCE
**ResourcePtr
))
1205 * Hardware (ACPI device) interfaces
1207 ACPI_EXTERNAL_RETURN_STATUS (
1212 ACPI_EXTERNAL_RETURN_STATUS (
1216 ACPI_GENERIC_ADDRESS
*Reg
))
1218 ACPI_EXTERNAL_RETURN_STATUS (
1222 ACPI_GENERIC_ADDRESS
*Reg
))
1224 ACPI_HW_DEPENDENT_RETURN_STATUS (
1226 AcpiReadBitRegister (
1228 UINT32
*ReturnValue
))
1230 ACPI_HW_DEPENDENT_RETURN_STATUS (
1232 AcpiWriteBitRegister (
1238 * Sleep/Wake interfaces
1240 ACPI_EXTERNAL_RETURN_STATUS (
1242 AcpiGetSleepTypeData (
1247 ACPI_EXTERNAL_RETURN_STATUS (
1249 AcpiEnterSleepStatePrep (
1252 ACPI_EXTERNAL_RETURN_STATUS (
1254 AcpiEnterSleepState (
1257 ACPI_HW_DEPENDENT_RETURN_STATUS (
1259 AcpiEnterSleepStateS4bios (
1262 ACPI_EXTERNAL_RETURN_STATUS (
1264 AcpiLeaveSleepStatePrep (
1267 ACPI_EXTERNAL_RETURN_STATUS (
1269 AcpiLeaveSleepState (
1272 ACPI_HW_DEPENDENT_RETURN_STATUS (
1274 AcpiSetFirmwareWakingVector (
1275 ACPI_PHYSICAL_ADDRESS PhysicalAddress
,
1276 ACPI_PHYSICAL_ADDRESS PhysicalAddress64
))
1280 * ACPI Timer interfaces
1282 ACPI_HW_DEPENDENT_RETURN_STATUS (
1284 AcpiGetTimerResolution (
1285 UINT32
*Resolution
))
1287 ACPI_HW_DEPENDENT_RETURN_STATUS (
1292 ACPI_HW_DEPENDENT_RETURN_STATUS (
1294 AcpiGetTimerDuration (
1297 UINT32
*TimeElapsed
))
1301 * Error/Warning output
1303 ACPI_MSG_DEPENDENT_RETURN_VOID (
1305 void ACPI_INTERNAL_VAR_XFACE
1307 const char *ModuleName
,
1312 ACPI_MSG_DEPENDENT_RETURN_VOID (
1314 void ACPI_INTERNAL_VAR_XFACE
1316 const char *ModuleName
,
1322 ACPI_MSG_DEPENDENT_RETURN_VOID (
1324 void ACPI_INTERNAL_VAR_XFACE
1326 const char *ModuleName
,
1331 ACPI_MSG_DEPENDENT_RETURN_VOID (
1333 void ACPI_INTERNAL_VAR_XFACE
1338 ACPI_MSG_DEPENDENT_RETURN_VOID (
1340 void ACPI_INTERNAL_VAR_XFACE
1342 const char *ModuleName
,
1347 ACPI_MSG_DEPENDENT_RETURN_VOID (
1349 void ACPI_INTERNAL_VAR_XFACE
1351 const char *ModuleName
,
1360 ACPI_DBG_DEPENDENT_RETURN_VOID (
1362 void ACPI_INTERNAL_VAR_XFACE
1364 UINT32 RequestedDebugLevel
,
1366 const char *FunctionName
,
1367 const char *ModuleName
,
1372 ACPI_DBG_DEPENDENT_RETURN_VOID (
1374 void ACPI_INTERNAL_VAR_XFACE
1376 UINT32 RequestedDebugLevel
,
1378 const char *FunctionName
,
1379 const char *ModuleName
,
1384 ACPI_DBG_DEPENDENT_RETURN_VOID (
1387 ACPI_TRACE_EVENT_TYPE Type
,
1393 AcpiInitializeDebugger (
1397 AcpiTerminateDebugger (
1405 AcpiSetDebuggerThreadId (
1406 ACPI_THREAD_ID ThreadId
);
1408 #endif /* __ACXFACE_H__ */