1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
48 extern const UINT8 AcpiGbl_ResourceAmlSizes[];
49 extern const UINT8 AcpiGbl_ResourceAmlSerialBusSizes[];
51 /* Strings used by the disassembler and debugger resource dump routines */
53 #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
55 extern const char *AcpiGbl_BmDecode[];
56 extern const char *AcpiGbl_ConfigDecode[];
57 extern const char *AcpiGbl_ConsumeDecode[];
58 extern const char *AcpiGbl_DecDecode[];
59 extern const char *AcpiGbl_HeDecode[];
60 extern const char *AcpiGbl_IoDecode[];
61 extern const char *AcpiGbl_LlDecode[];
62 extern const char *AcpiGbl_MaxDecode[];
63 extern const char *AcpiGbl_MemDecode[];
64 extern const char *AcpiGbl_MinDecode[];
65 extern const char *AcpiGbl_MtpDecode[];
66 extern const char *AcpiGbl_RngDecode[];
67 extern const char *AcpiGbl_RwDecode[];
68 extern const char *AcpiGbl_ShrDecode[];
69 extern const char *AcpiGbl_SizDecode[];
70 extern const char *AcpiGbl_TrsDecode[];
71 extern const char *AcpiGbl_TtpDecode[];
72 extern const char *AcpiGbl_TypDecode[];
73 extern const char *AcpiGbl_PpcDecode[];
74 extern const char *AcpiGbl_IorDecode[];
75 extern const char *AcpiGbl_DtsDecode[];
76 extern const char *AcpiGbl_CtDecode[];
77 extern const char *AcpiGbl_SbtDecode[];
78 extern const char *AcpiGbl_AmDecode[];
79 extern const char *AcpiGbl_SmDecode[];
80 extern const char *AcpiGbl_WmDecode[];
81 extern const char *AcpiGbl_CphDecode[];
82 extern const char *AcpiGbl_CpoDecode[];
83 extern const char *AcpiGbl_DpDecode[];
84 extern const char *AcpiGbl_EdDecode[];
85 extern const char *AcpiGbl_BpbDecode[];
86 extern const char *AcpiGbl_SbDecode[];
87 extern const char *AcpiGbl_FcDecode[];
88 extern const char *AcpiGbl_PtDecode[];
92 * For the iASL compiler case, the output is redirected to stderr so that
93 * any of the various ACPI errors and warnings do not appear in the output
94 * files, for either the compiler or disassembler portions of the tool.
96 #ifdef ACPI_ASL_COMPILER
100 #define ACPI_MSG_REDIRECT_BEGIN \
101 FILE *OutputFile = AcpiGbl_OutputFile; \
102 AcpiOsRedirectOutput (stderr);
104 #define ACPI_MSG_REDIRECT_END \
105 AcpiOsRedirectOutput (OutputFile);
109 * non-iASL case - no redirection, nothing to do
111 #define ACPI_MSG_REDIRECT_BEGIN
112 #define ACPI_MSG_REDIRECT_END
116 * Common error message prefixes
118 #ifndef ACPI_MSG_ERROR
119 #define ACPI_MSG_ERROR "ACPI Error: "
121 #ifndef ACPI_MSG_EXCEPTION
122 #define ACPI_MSG_EXCEPTION "ACPI Exception: "
124 #ifndef ACPI_MSG_WARNING
125 #define ACPI_MSG_WARNING "ACPI Warning: "
127 #ifndef ACPI_MSG_INFO
128 #define ACPI_MSG_INFO "ACPI: "
131 #ifndef ACPI_MSG_BIOS_ERROR
132 #define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
134 #ifndef ACPI_MSG_BIOS_WARNING
135 #define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
139 * Common message suffix
141 #define ACPI_MSG_SUFFIX \
142 AcpiOsPrintf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, ModuleName, LineNumber)
145 /* Types for Resource descriptor entries */
147 #define ACPI_INVALID_RESOURCE 0
148 #define ACPI_FIXED_LENGTH 1
149 #define ACPI_VARIABLE_LENGTH 2
150 #define ACPI_SMALL_VARIABLE_LENGTH 3
153 ACPI_STATUS (*ACPI_WALK_AML_CALLBACK) (
161 ACPI_STATUS (*ACPI_PKG_CALLBACK) (
163 ACPI_OPERAND_OBJECT *SourceObject,
164 ACPI_GENERIC_STATE *State,
167 typedef struct acpi_pkg_info
176 /* Object reference counts */
178 #define REF_INCREMENT (UINT16) 0
179 #define REF_DECREMENT (UINT16) 1
181 /* AcpiUtDumpBuffer */
183 #define DB_BYTE_DISPLAY 1
184 #define DB_WORD_DISPLAY 2
185 #define DB_DWORD_DISPLAY 4
186 #define DB_QWORD_DISPLAY 8
190 * utascii - ASCII utilities
197 AcpiUtValidNameChar (
202 AcpiUtCheckAndRepairAscii (
209 * utnonansi - Non-ANSI C library functions
231 * Values for Flags above
232 * Note: LIMIT values correspond to AcpiGbl_IntegerByteWidth values (4/8)
234 #define ACPI_STRTOUL_32BIT 0x04 /* 4 bytes */
235 #define ACPI_STRTOUL_64BIT 0x08 /* 8 bytes */
236 #define ACPI_STRTOUL_BASE16 0x10 /* Default: Base10/16 */
240 * utglobal - Global data structures and procedures
246 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
253 AcpiUtGetNotifyName (
255 ACPI_OBJECT_TYPE Type);
260 ACPI_OBJECT_TYPE Type);
267 AcpiUtGetDescriptorName (
271 AcpiUtGetReferenceName (
272 ACPI_OPERAND_OBJECT *Object);
275 AcpiUtGetObjectTypeName (
276 ACPI_OPERAND_OBJECT *ObjDesc);
279 AcpiUtGetRegionName (
287 AcpiUtHexToAsciiChar (
292 AcpiUtAsciiToHexByte (
297 AcpiUtAsciiCharToHex (
301 AcpiUtValidObjectType (
302 ACPI_OBJECT_TYPE Type);
306 * utinit - miscellaneous initialization and shutdown
309 AcpiUtHardwareInitialize (
313 AcpiUtSubsystemShutdown (
318 * utcopy - Object construction and conversion interfaces
321 AcpiUtBuildSimpleObject(
322 ACPI_OPERAND_OBJECT *Obj,
323 ACPI_OBJECT *UserObj,
325 UINT32 *BufferSpaceUsed);
328 AcpiUtBuildPackageObject (
329 ACPI_OPERAND_OBJECT *Obj,
334 AcpiUtCopyIobjectToEobject (
335 ACPI_OPERAND_OBJECT *Obj,
336 ACPI_BUFFER *RetBuffer);
339 AcpiUtCopyEobjectToIobject (
341 ACPI_OPERAND_OBJECT **InternalObj);
344 AcpiUtCopyISimpleToIsimple (
345 ACPI_OPERAND_OBJECT *SourceObj,
346 ACPI_OPERAND_OBJECT *DestObj);
349 AcpiUtCopyIobjectToIobject (
350 ACPI_OPERAND_OBJECT *SourceDesc,
351 ACPI_OPERAND_OBJECT **DestDesc,
352 ACPI_WALK_STATE *WalkState);
356 * utcreate - Object creation
359 AcpiUtUpdateObjectReference (
360 ACPI_OPERAND_OBJECT *Object,
365 * utdebug - Debug interfaces
368 AcpiUtInitStackPtrTrace (
372 AcpiUtTrackStackPtr (
378 const char *FunctionName,
379 const char *ModuleName,
385 const char *FunctionName,
386 const char *ModuleName,
388 const void *Pointer);
393 const char *FunctionName,
394 const char *ModuleName,
401 const char *FunctionName,
402 const char *ModuleName,
409 const char *FunctionName,
410 const char *ModuleName,
416 const char *FunctionName,
417 const char *ModuleName,
424 const char *FunctionName,
425 const char *ModuleName,
432 const char *FunctionName,
433 const char *ModuleName,
440 const char *FunctionName,
441 const char *ModuleName,
446 AcpiUtDebugDumpBuffer (
459 #ifdef ACPI_APPLICATION
461 AcpiUtDumpBufferToFile (
480 AcpiUtReportWarning (
486 * utdelete - Object deletion and reference counts
490 ACPI_OPERAND_OBJECT *Object);
493 AcpiUtRemoveReference (
494 ACPI_OPERAND_OBJECT *Object);
497 AcpiUtDeleteInternalPackageObject (
498 ACPI_OPERAND_OBJECT *Object);
501 AcpiUtDeleteInternalSimpleObject (
502 ACPI_OPERAND_OBJECT *Object);
505 AcpiUtDeleteInternalObjectList (
506 ACPI_OPERAND_OBJECT **ObjList);
510 * uteval - object evaluation
513 AcpiUtEvaluateObject (
514 ACPI_NAMESPACE_NODE *PrefixNode,
516 UINT32 ExpectedReturnBtypes,
517 ACPI_OPERAND_OBJECT **ReturnDesc);
520 AcpiUtEvaluateNumericObject (
521 const char *ObjectName,
522 ACPI_NAMESPACE_NODE *DeviceNode,
527 ACPI_NAMESPACE_NODE *DeviceNode,
528 UINT32 *StatusFlags);
531 AcpiUtExecutePowerMethods (
532 ACPI_NAMESPACE_NODE *DeviceNode,
533 const char **MethodNames,
539 * utids - device ID support
543 ACPI_NAMESPACE_NODE *DeviceNode,
544 ACPI_PNP_DEVICE_ID **ReturnId);
548 ACPI_NAMESPACE_NODE *DeviceNode,
549 ACPI_PNP_DEVICE_ID **ReturnId);
553 ACPI_NAMESPACE_NODE *DeviceNode,
554 ACPI_PNP_DEVICE_ID_LIST **ReturnCidList);
558 ACPI_NAMESPACE_NODE *DeviceNode,
559 ACPI_PNP_DEVICE_ID **ReturnId);
563 * utlock - reader/writer locks
574 AcpiUtAcquireReadLock (
578 AcpiUtReleaseReadLock (
582 AcpiUtAcquireWriteLock (
586 AcpiUtReleaseWriteLock (
591 * utobject - internal object create/delete/cache routines
593 ACPI_OPERAND_OBJECT *
594 AcpiUtCreateInternalObjectDbg (
595 const char *ModuleName,
598 ACPI_OBJECT_TYPE Type);
601 AcpiUtAllocateObjectDescDbg (
602 const char *ModuleName,
606 #define AcpiUtCreateInternalObject(t) AcpiUtCreateInternalObjectDbg (_AcpiModuleName,__LINE__,_COMPONENT,t)
607 #define AcpiUtAllocateObjectDesc() AcpiUtAllocateObjectDescDbg (_AcpiModuleName,__LINE__,_COMPONENT)
610 AcpiUtDeleteObjectDesc (
611 ACPI_OPERAND_OBJECT *Object);
614 AcpiUtValidInternalObject (
617 ACPI_OPERAND_OBJECT *
618 AcpiUtCreatePackageObject (
621 ACPI_OPERAND_OBJECT *
622 AcpiUtCreateIntegerObject (
625 ACPI_OPERAND_OBJECT *
626 AcpiUtCreateBufferObject (
627 ACPI_SIZE BufferSize);
629 ACPI_OPERAND_OBJECT *
630 AcpiUtCreateStringObject (
631 ACPI_SIZE StringSize);
635 ACPI_OPERAND_OBJECT *Obj,
636 ACPI_SIZE *ObjLength);
640 * utosi - Support for the _OSI predefined control method
643 AcpiUtInitializeInterfaces (
647 AcpiUtInterfaceTerminate (
651 AcpiUtInstallInterface (
652 ACPI_STRING InterfaceName);
655 AcpiUtRemoveInterface (
656 ACPI_STRING InterfaceName);
659 AcpiUtUpdateInterfaces (
662 ACPI_INTERFACE_INFO *
664 ACPI_STRING InterfaceName);
667 AcpiUtOsiImplementation (
668 ACPI_WALK_STATE *WalkState);
672 * utpredef - support for predefined names
674 const ACPI_PREDEFINED_INFO *
675 AcpiUtGetNextPredefinedMethod (
676 const ACPI_PREDEFINED_INFO *ThisName);
678 const ACPI_PREDEFINED_INFO *
679 AcpiUtMatchPredefinedMethod (
683 AcpiUtGetExpectedReturnTypes (
685 UINT32 ExpectedBtypes);
687 #if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
688 const ACPI_PREDEFINED_INFO *
689 AcpiUtMatchResourceName (
693 AcpiUtDisplayPredefinedMethod (
695 const ACPI_PREDEFINED_INFO *ThisName,
699 AcpiUtGetResourceBitWidth (
706 * utstate - Generic state creation/cache routines
709 AcpiUtPushGenericState (
710 ACPI_GENERIC_STATE **ListHead,
711 ACPI_GENERIC_STATE *State);
714 AcpiUtPopGenericState (
715 ACPI_GENERIC_STATE **ListHead);
719 AcpiUtCreateGenericState (
723 AcpiUtCreateThreadState (
727 AcpiUtCreateUpdateState (
728 ACPI_OPERAND_OBJECT *Object,
732 AcpiUtCreatePkgState (
733 void *InternalObject,
734 void *ExternalObject,
738 AcpiUtCreateUpdateStateAndPush (
739 ACPI_OPERAND_OBJECT *Object,
741 ACPI_GENERIC_STATE **StateList);
744 AcpiUtCreateControlState (
748 AcpiUtDeleteGenericState (
749 ACPI_GENERIC_STATE *State);
760 UINT64 *OutRemainder);
767 UINT32 *OutRemainder);
773 const ACPI_EXCEPTION_INFO *
774 AcpiUtValidateException (
778 AcpiUtIsPciRootBridge (
781 #if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
784 ACPI_TABLE_HEADER *Table);
788 AcpiUtWalkPackageTree (
789 ACPI_OPERAND_OBJECT *SourceObject,
791 ACPI_PKG_CALLBACK WalkCallback,
794 /* Values for Base above (16=Hex, 10=Decimal) */
796 #define ACPI_ANY_BASE 0
800 AcpiUtDwordByteSwap (
804 AcpiUtSetIntegerWidth (
807 #ifdef ACPI_DEBUG_OUTPUT
809 AcpiUtDisplayInitPathname (
811 ACPI_NAMESPACE_NODE *ObjHandle,
817 * utownerid - Support for Table/Method Owner IDs
820 AcpiUtAllocateOwnerId (
821 ACPI_OWNER_ID *OwnerId);
824 AcpiUtReleaseOwnerId (
825 ACPI_OWNER_ID *OwnerId);
832 AcpiUtWalkAmlResources (
833 ACPI_WALK_STATE *WalkState,
836 ACPI_WALK_AML_CALLBACK UserFunction,
840 AcpiUtValidateResource (
841 ACPI_WALK_STATE *WalkState,
846 AcpiUtGetDescriptorLength (
850 AcpiUtGetResourceLength (
854 AcpiUtGetResourceHeaderLength (
858 AcpiUtGetResourceType (
862 AcpiUtGetResourceEndTag (
863 ACPI_OPERAND_OBJECT *ObjDesc,
868 * utstring - String and character utilities
875 #if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
877 UtConvertBackslashes (
885 #if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
903 ACPI_SIZE MaxTransferLength);
908 * utmutex - mutex support
911 AcpiUtMutexInitialize (
915 AcpiUtMutexTerminate (
920 ACPI_MUTEX_HANDLE MutexId);
924 ACPI_MUTEX_HANDLE MutexId);
928 * utalloc - memory allocation and object caching
939 AcpiUtValidateBuffer (
940 ACPI_BUFFER *Buffer);
943 AcpiUtInitializeBuffer (
945 ACPI_SIZE RequiredLength);
947 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
949 AcpiUtAllocateAndTrack (
956 AcpiUtAllocateZeroedAndTrack (
970 AcpiUtDumpAllocationInfo (
974 AcpiUtDumpAllocations (
980 const char *ListName,
982 ACPI_MEMORY_LIST **ReturnCache);
984 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
988 * utaddress - address range check
991 AcpiUtAddAddressRange (
992 ACPI_ADR_SPACE_TYPE SpaceId,
993 ACPI_PHYSICAL_ADDRESS Address,
995 ACPI_NAMESPACE_NODE *RegionNode);
998 AcpiUtRemoveAddressRange (
999 ACPI_ADR_SPACE_TYPE SpaceId,
1000 ACPI_NAMESPACE_NODE *RegionNode);
1003 AcpiUtCheckAddressRange (
1004 ACPI_ADR_SPACE_TYPE SpaceId,
1005 ACPI_PHYSICAL_ADDRESS Address,
1010 AcpiUtDeleteAddressLists (
1015 * utxferror - various error/warning output functions
1017 void ACPI_INTERNAL_VAR_XFACE
1018 AcpiUtPredefinedWarning (
1019 const char *ModuleName,
1026 void ACPI_INTERNAL_VAR_XFACE
1027 AcpiUtPredefinedInfo (
1028 const char *ModuleName,
1035 void ACPI_INTERNAL_VAR_XFACE
1036 AcpiUtPredefinedBiosError (
1037 const char *ModuleName,
1045 AcpiUtNamespaceError (
1046 const char *ModuleName,
1048 const char *InternalName,
1049 ACPI_STATUS LookupStatus);
1053 const char *ModuleName,
1055 const char *Message,
1056 ACPI_NAMESPACE_NODE *Node,
1058 ACPI_STATUS LookupStatus);
1062 * Utility functions for ACPI names and IDs
1064 const AH_PREDEFINED_NAME *
1065 AcpiAhMatchPredefinedName (
1068 const AH_DEVICE_ID *
1069 AcpiAhMatchHardwareId (
1078 * utuuid -- UUID support functions
1080 #if (defined ACPI_ASL_COMPILER || defined ACPI_DISASSEMBLER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP)
1082 AcpiUtConvertStringToUuid (
1087 #endif /* _ACUTILS_H */