2 /******************************************************************************
4 * Name: acpixf.h - External interfaces to the ACPI subsystem
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2012, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
49 /* Current ACPICA subsystem version in YYYYMMDD format */
51 #define ACPI_CA_VERSION 0x20120518
53 #include <contrib/dev/acpica/include/acconfig.h>
54 #include <contrib/dev/acpica/include/actypes.h>
55 #include <contrib/dev/acpica/include/actbl.h>
58 * Globals that are publically available
60 extern UINT32 AcpiCurrentGpeCount;
61 extern ACPI_TABLE_FADT AcpiGbl_FADT;
62 extern BOOLEAN AcpiGbl_SystemAwakeAndRunning;
63 extern BOOLEAN AcpiGbl_ReducedHardware; /* ACPI 5.0 */
65 /* Runtime configuration of debug print levels */
67 extern UINT32 AcpiDbgLevel;
68 extern UINT32 AcpiDbgLayer;
70 /* ACPICA runtime options */
72 extern UINT8 AcpiGbl_EnableInterpreterSlack;
73 extern UINT8 AcpiGbl_AllMethodsSerialized;
74 extern UINT8 AcpiGbl_CreateOsiMethod;
75 extern UINT8 AcpiGbl_UseDefaultRegisterWidths;
76 extern ACPI_NAME AcpiGbl_TraceMethodName;
77 extern UINT32 AcpiGbl_TraceFlags;
78 extern UINT8 AcpiGbl_EnableAmlDebugObject;
79 extern UINT8 AcpiGbl_CopyDsdtLocally;
80 extern UINT8 AcpiGbl_TruncateIoAddresses;
81 extern UINT8 AcpiGbl_DisableAutoRepair;
85 * Hardware-reduced prototypes. All interfaces that use these macros will
86 * be configured out of the ACPICA build if the ACPI_REDUCED_HARDWARE flag
89 #if (!ACPI_REDUCED_HARDWARE)
90 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
93 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
96 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
100 #define ACPI_HW_DEPENDENT_RETURN_STATUS(Prototype) \
101 static ACPI_INLINE Prototype {return(AE_NOT_CONFIGURED);}
103 #define ACPI_HW_DEPENDENT_RETURN_OK(Prototype) \
104 static ACPI_INLINE Prototype {return(AE_OK);}
106 #define ACPI_HW_DEPENDENT_RETURN_VOID(Prototype) \
107 static ACPI_INLINE Prototype {}
109 #endif /* !ACPI_REDUCED_HARDWARE */
116 AcpiInitializeTables (
117 ACPI_TABLE_DESC *InitialStorage,
118 UINT32 InitialTableCount,
119 BOOLEAN AllowResize);
122 AcpiInitializeSubsystem (
126 AcpiEnableSubsystem (
130 AcpiInitializeObjects (
139 * Miscellaneous global interfaces
141 ACPI_HW_DEPENDENT_RETURN_STATUS (
146 ACPI_HW_DEPENDENT_RETURN_STATUS (
152 AcpiSubsystemStatus (
157 ACPI_BUFFER *RetBuffer);
161 ACPI_STATISTICS *Stats);
164 AcpiFormatException (
165 ACPI_STATUS Exception);
168 AcpiPurgeCachedObjects (
172 AcpiInstallInterface (
173 ACPI_STRING InterfaceName);
176 AcpiRemoveInterface (
177 ACPI_STRING InterfaceName);
180 AcpiCheckAddressRange (
181 ACPI_ADR_SPACE_TYPE SpaceId,
182 ACPI_PHYSICAL_ADDRESS Address,
188 * ACPI Memory management
204 * ACPI table manipulation interfaces
207 AcpiReallocateRootTable (
211 AcpiFindRootPointer (
212 ACPI_SIZE *RsdpAddress);
220 ACPI_STRING Signature,
222 ACPI_TABLE_HEADER *OutTableHeader);
226 ACPI_STRING Signature,
228 ACPI_TABLE_HEADER **OutTable);
231 AcpiGetTableByIndex (
233 ACPI_TABLE_HEADER **OutTable);
236 AcpiInstallTableHandler (
237 ACPI_TABLE_HANDLER Handler,
241 AcpiRemoveTableHandler (
242 ACPI_TABLE_HANDLER Handler);
246 * Namespace and name interfaces
250 ACPI_OBJECT_TYPE Type,
251 ACPI_HANDLE StartObject,
253 ACPI_WALK_CALLBACK PreOrderVisit,
254 ACPI_WALK_CALLBACK PostOrderVisit,
261 ACPI_WALK_CALLBACK UserFunction,
269 ACPI_BUFFER *RetPathPtr);
274 ACPI_STRING Pathname,
275 ACPI_HANDLE *RetHandle);
280 ACPI_OBJECT_HANDLER Handler,
286 ACPI_OBJECT_HANDLER Handler);
291 ACPI_OBJECT_HANDLER Handler,
303 * Object manipulation and enumeration
308 ACPI_STRING Pathname,
309 ACPI_OBJECT_LIST *ParameterObjects,
310 ACPI_BUFFER *ReturnObjectBuffer);
313 AcpiEvaluateObjectTyped (
315 ACPI_STRING Pathname,
316 ACPI_OBJECT_LIST *ExternalParams,
317 ACPI_BUFFER *ReturnBuffer,
318 ACPI_OBJECT_TYPE ReturnType);
323 ACPI_DEVICE_INFO **ReturnBuffer);
331 ACPI_OBJECT_TYPE Type,
334 ACPI_HANDLE *OutHandle);
339 ACPI_OBJECT_TYPE *OutType);
344 ACPI_HANDLE *OutHandle);
351 AcpiInstallInitializationHandler (
352 ACPI_INIT_HANDLER Handler,
355 ACPI_HW_DEPENDENT_RETURN_STATUS (
357 AcpiInstallGlobalEventHandler (
358 ACPI_GBL_EVENT_HANDLER Handler,
361 ACPI_HW_DEPENDENT_RETURN_STATUS (
363 AcpiInstallFixedEventHandler (
365 ACPI_EVENT_HANDLER Handler,
368 ACPI_HW_DEPENDENT_RETURN_STATUS (
370 AcpiRemoveFixedEventHandler (
372 ACPI_EVENT_HANDLER Handler))
374 ACPI_HW_DEPENDENT_RETURN_STATUS (
376 AcpiInstallGpeHandler (
377 ACPI_HANDLE GpeDevice,
380 ACPI_GPE_HANDLER Address,
383 ACPI_HW_DEPENDENT_RETURN_STATUS (
385 AcpiRemoveGpeHandler (
386 ACPI_HANDLE GpeDevice,
388 ACPI_GPE_HANDLER Address))
391 AcpiInstallNotifyHandler (
394 ACPI_NOTIFY_HANDLER Handler,
398 AcpiRemoveNotifyHandler (
401 ACPI_NOTIFY_HANDLER Handler);
404 AcpiInstallAddressSpaceHandler (
406 ACPI_ADR_SPACE_TYPE SpaceId,
407 ACPI_ADR_SPACE_HANDLER Handler,
408 ACPI_ADR_SPACE_SETUP Setup,
412 AcpiRemoveAddressSpaceHandler (
414 ACPI_ADR_SPACE_TYPE SpaceId,
415 ACPI_ADR_SPACE_HANDLER Handler);
418 AcpiInstallExceptionHandler (
419 ACPI_EXCEPTION_HANDLER Handler);
422 AcpiInstallInterfaceHandler (
423 ACPI_INTERFACE_HANDLER Handler);
427 * Global Lock interfaces
429 ACPI_HW_DEPENDENT_RETURN_STATUS (
431 AcpiAcquireGlobalLock (
435 ACPI_HW_DEPENDENT_RETURN_STATUS (
437 AcpiReleaseGlobalLock (
442 * Interfaces to AML mutex objects
447 ACPI_STRING Pathname,
453 ACPI_STRING Pathname);
457 * Fixed Event interfaces
459 ACPI_HW_DEPENDENT_RETURN_STATUS (
465 ACPI_HW_DEPENDENT_RETURN_STATUS (
471 ACPI_HW_DEPENDENT_RETURN_STATUS (
476 ACPI_HW_DEPENDENT_RETURN_STATUS (
480 ACPI_EVENT_STATUS *EventStatus))
484 * General Purpose Event (GPE) Interfaces
486 ACPI_HW_DEPENDENT_RETURN_STATUS (
491 ACPI_HW_DEPENDENT_RETURN_STATUS (
494 ACPI_HANDLE GpeDevice,
497 ACPI_HW_DEPENDENT_RETURN_STATUS (
500 ACPI_HANDLE GpeDevice,
503 ACPI_HW_DEPENDENT_RETURN_STATUS (
506 ACPI_HANDLE GpeDevice,
509 ACPI_HW_DEPENDENT_RETURN_STATUS (
512 ACPI_HANDLE GpeDevice,
516 ACPI_HW_DEPENDENT_RETURN_STATUS (
519 ACPI_HANDLE GpeDevice,
522 ACPI_HW_DEPENDENT_RETURN_STATUS (
524 AcpiSetupGpeForWake (
525 ACPI_HANDLE ParentDevice,
526 ACPI_HANDLE GpeDevice,
529 ACPI_HW_DEPENDENT_RETURN_STATUS (
532 ACPI_HANDLE GpeDevice,
536 ACPI_HW_DEPENDENT_RETURN_STATUS (
539 ACPI_HANDLE GpeDevice,
541 ACPI_EVENT_STATUS *EventStatus))
543 ACPI_HW_DEPENDENT_RETURN_STATUS (
548 ACPI_HW_DEPENDENT_RETURN_STATUS (
550 AcpiEnableAllRuntimeGpes (
553 ACPI_HW_DEPENDENT_RETURN_STATUS (
557 ACPI_HANDLE *GpeDevice))
559 ACPI_HW_DEPENDENT_RETURN_STATUS (
561 AcpiInstallGpeBlock (
562 ACPI_HANDLE GpeDevice,
563 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
564 UINT32 RegisterCount,
565 UINT32 InterruptNumber))
567 ACPI_HW_DEPENDENT_RETURN_STATUS (
570 ACPI_HANDLE GpeDevice))
574 * Resource interfaces
577 ACPI_STATUS (*ACPI_WALK_RESOURCE_CALLBACK) (
578 ACPI_RESOURCE *Resource,
582 AcpiGetVendorResource (
585 ACPI_VENDOR_UUID *Uuid,
586 ACPI_BUFFER *RetBuffer);
589 AcpiGetCurrentResources (
591 ACPI_BUFFER *RetBuffer);
594 AcpiGetPossibleResources (
596 ACPI_BUFFER *RetBuffer);
599 AcpiGetEventResources (
600 ACPI_HANDLE DeviceHandle,
601 ACPI_BUFFER *RetBuffer);
607 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
611 AcpiSetCurrentResources (
613 ACPI_BUFFER *InBuffer);
616 AcpiGetIrqRoutingTable (
618 ACPI_BUFFER *RetBuffer);
621 AcpiResourceToAddress64 (
622 ACPI_RESOURCE *Resource,
623 ACPI_RESOURCE_ADDRESS64 *Out);
626 AcpiBufferToResource (
628 UINT16 AmlBufferLength,
629 ACPI_RESOURCE **ResourcePtr);
633 * Hardware (ACPI device) interfaces
642 ACPI_GENERIC_ADDRESS *Reg);
647 ACPI_GENERIC_ADDRESS *Reg);
649 ACPI_HW_DEPENDENT_RETURN_STATUS (
651 AcpiReadBitRegister (
653 UINT32 *ReturnValue))
655 ACPI_HW_DEPENDENT_RETURN_STATUS (
657 AcpiWriteBitRegister (
663 * Sleep/Wake interfaces
666 AcpiGetSleepTypeData (
672 AcpiEnterSleepStatePrep (
676 AcpiEnterSleepState (
680 ACPI_HW_DEPENDENT_RETURN_STATUS (
682 AcpiEnterSleepStateS4bios (
686 AcpiLeaveSleepStatePrep (
691 AcpiLeaveSleepState (
694 ACPI_HW_DEPENDENT_RETURN_STATUS (
696 AcpiSetFirmwareWakingVector (
697 UINT32 PhysicalAddress))
699 #if ACPI_MACHINE_WIDTH == 64
700 ACPI_HW_DEPENDENT_RETURN_STATUS (
702 AcpiSetFirmwareWakingVector64 (
703 UINT64 PhysicalAddress))
708 * ACPI Timer interfaces
710 ACPI_HW_DEPENDENT_RETURN_STATUS (
712 AcpiGetTimerResolution (
715 ACPI_HW_DEPENDENT_RETURN_STATUS (
720 ACPI_HW_DEPENDENT_RETURN_STATUS (
722 AcpiGetTimerDuration (
725 UINT32 *TimeElapsed))
729 * Error/Warning output
731 void ACPI_INTERNAL_VAR_XFACE
733 const char *ModuleName,
736 ...) ACPI_PRINTF_LIKE(3);
738 void ACPI_INTERNAL_VAR_XFACE
740 const char *ModuleName,
744 ...) ACPI_PRINTF_LIKE(4);
746 void ACPI_INTERNAL_VAR_XFACE
748 const char *ModuleName,
751 ...) ACPI_PRINTF_LIKE(3);
753 void ACPI_INTERNAL_VAR_XFACE
755 const char *ModuleName,
758 ...) ACPI_PRINTF_LIKE(3);
764 #ifdef ACPI_DEBUG_OUTPUT
766 void ACPI_INTERNAL_VAR_XFACE
768 UINT32 RequestedDebugLevel,
770 const char *FunctionName,
771 const char *ModuleName,
774 ...) ACPI_PRINTF_LIKE(6);
776 void ACPI_INTERNAL_VAR_XFACE
778 UINT32 RequestedDebugLevel,
780 const char *FunctionName,
781 const char *ModuleName,
784 ...) ACPI_PRINTF_LIKE(6);
787 #endif /* __ACXFACE_H__ */