1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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[];
50 /* Strings used by the disassembler and debugger resource dump routines */
52 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
54 extern const char *AcpiGbl_BmDecode[];
55 extern const char *AcpiGbl_ConfigDecode[];
56 extern const char *AcpiGbl_ConsumeDecode[];
57 extern const char *AcpiGbl_DecDecode[];
58 extern const char *AcpiGbl_HeDecode[];
59 extern const char *AcpiGbl_IoDecode[];
60 extern const char *AcpiGbl_LlDecode[];
61 extern const char *AcpiGbl_MaxDecode[];
62 extern const char *AcpiGbl_MemDecode[];
63 extern const char *AcpiGbl_MinDecode[];
64 extern const char *AcpiGbl_MtpDecode[];
65 extern const char *AcpiGbl_RngDecode[];
66 extern const char *AcpiGbl_RwDecode[];
67 extern const char *AcpiGbl_ShrDecode[];
68 extern const char *AcpiGbl_SizDecode[];
69 extern const char *AcpiGbl_TrsDecode[];
70 extern const char *AcpiGbl_TtpDecode[];
71 extern const char *AcpiGbl_TypDecode[];
74 /* Types for Resource descriptor entries */
76 #define ACPI_INVALID_RESOURCE 0
77 #define ACPI_FIXED_LENGTH 1
78 #define ACPI_VARIABLE_LENGTH 2
79 #define ACPI_SMALL_VARIABLE_LENGTH 3
82 ACPI_STATUS (*ACPI_WALK_AML_CALLBACK) (
90 ACPI_STATUS (*ACPI_PKG_CALLBACK) (
92 ACPI_OPERAND_OBJECT *SourceObject,
93 ACPI_GENERIC_STATE *State,
96 typedef struct acpi_pkg_info
105 #define REF_INCREMENT (UINT16) 0
106 #define REF_DECREMENT (UINT16) 1
107 #define REF_FORCE_DELETE (UINT16) 2
109 /* AcpiUtDumpBuffer */
111 #define DB_BYTE_DISPLAY 1
112 #define DB_WORD_DISPLAY 2
113 #define DB_DWORD_DISPLAY 4
114 #define DB_QWORD_DISPLAY 8
118 * utglobal - Global data structures and procedures
124 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
131 AcpiUtGetNotifyName (
138 ACPI_OBJECT_TYPE Type);
145 AcpiUtGetDescriptorName (
149 AcpiUtGetReferenceName (
150 ACPI_OPERAND_OBJECT *Object);
153 AcpiUtGetObjectTypeName (
154 ACPI_OPERAND_OBJECT *ObjDesc);
157 AcpiUtGetRegionName (
165 AcpiUtHexToAsciiChar (
170 AcpiUtValidObjectType (
171 ACPI_OBJECT_TYPE Type);
175 * utinit - miscellaneous initialization and shutdown
178 AcpiUtHardwareInitialize (
182 AcpiUtSubsystemShutdown (
187 * utclib - Local implementations of C library functions
189 #ifndef ACPI_USE_SYSTEM_CLIBRARY
198 const char *SrcString);
203 const char *SrcString,
221 const char *String2);
226 const char *SrcString);
231 const char *SrcString,
265 extern const UINT8 _acpi_ctype[];
267 #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
268 #define _ACPI_XS 0x40 /* extra space */
269 #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
270 #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
271 #define _ACPI_DI 0x04 /* '0'-'9' */
272 #define _ACPI_LO 0x02 /* 'a'-'z' */
273 #define _ACPI_PU 0x10 /* punctuation */
274 #define _ACPI_SP 0x08 /* space */
275 #define _ACPI_UP 0x01 /* 'A'-'Z' */
276 #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
278 #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
279 #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
280 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
281 #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
282 #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
283 #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
284 #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
286 #endif /* !ACPI_USE_SYSTEM_CLIBRARY */
288 #define ACPI_IS_ASCII(c) ((c) < 0x80)
292 * utcopy - Object construction and conversion interfaces
295 AcpiUtBuildSimpleObject(
296 ACPI_OPERAND_OBJECT *Obj,
297 ACPI_OBJECT *UserObj,
299 UINT32 *BufferSpaceUsed);
302 AcpiUtBuildPackageObject (
303 ACPI_OPERAND_OBJECT *Obj,
308 AcpiUtCopyIobjectToEobject (
309 ACPI_OPERAND_OBJECT *Obj,
310 ACPI_BUFFER *RetBuffer);
313 AcpiUtCopyEobjectToIobject (
315 ACPI_OPERAND_OBJECT **InternalObj);
318 AcpiUtCopyISimpleToIsimple (
319 ACPI_OPERAND_OBJECT *SourceObj,
320 ACPI_OPERAND_OBJECT *DestObj);
323 AcpiUtCopyIobjectToIobject (
324 ACPI_OPERAND_OBJECT *SourceDesc,
325 ACPI_OPERAND_OBJECT **DestDesc,
326 ACPI_WALK_STATE *WalkState);
330 * utcreate - Object creation
333 AcpiUtUpdateObjectReference (
334 ACPI_OPERAND_OBJECT *Object,
339 * utdebug - Debug interfaces
342 AcpiUtInitStackPtrTrace (
346 AcpiUtTrackStackPtr (
352 const char *FunctionName,
353 const char *ModuleName,
359 const char *FunctionName,
360 const char *ModuleName,
367 const char *FunctionName,
368 const char *ModuleName,
375 const char *FunctionName,
376 const char *ModuleName,
383 const char *FunctionName,
384 const char *ModuleName,
390 const char *FunctionName,
391 const char *ModuleName,
398 const char *FunctionName,
399 const char *ModuleName,
406 const char *FunctionName,
407 const char *ModuleName,
435 AcpiUtReportWarning (
440 * utdelete - Object deletion and reference counts
444 ACPI_OPERAND_OBJECT *Object);
447 AcpiUtRemoveReference (
448 ACPI_OPERAND_OBJECT *Object);
451 AcpiUtDeleteInternalPackageObject (
452 ACPI_OPERAND_OBJECT *Object);
455 AcpiUtDeleteInternalSimpleObject (
456 ACPI_OPERAND_OBJECT *Object);
459 AcpiUtDeleteInternalObjectList (
460 ACPI_OPERAND_OBJECT **ObjList);
464 * uteval - object evaluation
467 AcpiUtEvaluateObject (
468 ACPI_NAMESPACE_NODE *PrefixNode,
470 UINT32 ExpectedReturnBtypes,
471 ACPI_OPERAND_OBJECT **ReturnDesc);
474 AcpiUtEvaluateNumericObject (
476 ACPI_NAMESPACE_NODE *DeviceNode,
481 ACPI_NAMESPACE_NODE *DeviceNode,
482 UINT32 *StatusFlags);
485 AcpiUtExecutePowerMethods (
486 ACPI_NAMESPACE_NODE *DeviceNode,
487 const char **MethodNames,
493 * utids - device ID support
497 ACPI_NAMESPACE_NODE *DeviceNode,
498 ACPI_DEVICE_ID **ReturnId);
502 ACPI_NAMESPACE_NODE *DeviceNode,
503 ACPI_DEVICE_ID **ReturnId);
507 ACPI_NAMESPACE_NODE *DeviceNode,
508 ACPI_DEVICE_ID_LIST **ReturnCidList);
512 * utlock - reader/writer locks
523 AcpiUtAcquireReadLock (
527 AcpiUtReleaseReadLock (
531 AcpiUtAcquireWriteLock (
535 AcpiUtReleaseWriteLock (
540 * utobject - internal object create/delete/cache routines
542 ACPI_OPERAND_OBJECT *
543 AcpiUtCreateInternalObjectDbg (
544 const char *ModuleName,
547 ACPI_OBJECT_TYPE Type);
550 AcpiUtAllocateObjectDescDbg (
551 const char *ModuleName,
555 #define AcpiUtCreateInternalObject(t) AcpiUtCreateInternalObjectDbg (_AcpiModuleName,__LINE__,_COMPONENT,t)
556 #define AcpiUtAllocateObjectDesc() AcpiUtAllocateObjectDescDbg (_AcpiModuleName,__LINE__,_COMPONENT)
559 AcpiUtDeleteObjectDesc (
560 ACPI_OPERAND_OBJECT *Object);
563 AcpiUtValidInternalObject (
566 ACPI_OPERAND_OBJECT *
567 AcpiUtCreatePackageObject (
570 ACPI_OPERAND_OBJECT *
571 AcpiUtCreateIntegerObject (
574 ACPI_OPERAND_OBJECT *
575 AcpiUtCreateBufferObject (
576 ACPI_SIZE BufferSize);
578 ACPI_OPERAND_OBJECT *
579 AcpiUtCreateStringObject (
580 ACPI_SIZE StringSize);
584 ACPI_OPERAND_OBJECT *Obj,
585 ACPI_SIZE *ObjLength);
589 * utosi - Support for the _OSI predefined control method
592 AcpiUtInitializeInterfaces (
596 AcpiUtInterfaceTerminate (
600 AcpiUtInstallInterface (
601 ACPI_STRING InterfaceName);
604 AcpiUtRemoveInterface (
605 ACPI_STRING InterfaceName);
607 ACPI_INTERFACE_INFO *
609 ACPI_STRING InterfaceName);
612 AcpiUtOsiImplementation (
613 ACPI_WALK_STATE *WalkState);
617 * utstate - Generic state creation/cache routines
620 AcpiUtPushGenericState (
621 ACPI_GENERIC_STATE **ListHead,
622 ACPI_GENERIC_STATE *State);
625 AcpiUtPopGenericState (
626 ACPI_GENERIC_STATE **ListHead);
630 AcpiUtCreateGenericState (
634 AcpiUtCreateThreadState (
638 AcpiUtCreateUpdateState (
639 ACPI_OPERAND_OBJECT *Object,
643 AcpiUtCreatePkgState (
644 void *InternalObject,
645 void *ExternalObject,
649 AcpiUtCreateUpdateStateAndPush (
650 ACPI_OPERAND_OBJECT *Object,
652 ACPI_GENERIC_STATE **StateList);
655 AcpiUtCreatePkgStateAndPush (
656 void *InternalObject,
657 void *ExternalObject,
659 ACPI_GENERIC_STATE **StateList);
662 AcpiUtCreateControlState (
666 AcpiUtDeleteGenericState (
667 ACPI_GENERIC_STATE *State);
678 UINT64 *OutRemainder);
685 UINT32 *OutRemainder);
691 AcpiUtValidateException (
695 AcpiUtIsPciRootBridge (
700 ACPI_TABLE_HEADER *Table);
703 AcpiUtAllocateOwnerId (
704 ACPI_OWNER_ID *OwnerId);
707 AcpiUtReleaseOwnerId (
708 ACPI_OWNER_ID *OwnerId);
711 AcpiUtWalkPackageTree (
712 ACPI_OPERAND_OBJECT *SourceObject,
714 ACPI_PKG_CALLBACK WalkCallback,
731 AcpiUtValidAcpiName (
739 AcpiUtValidAcpiChar (
749 /* Values for Base above (16=Hex, 10=Decimal) */
751 #define ACPI_ANY_BASE 0
754 AcpiUtDwordByteSwap (
758 AcpiUtSetIntegerWidth (
761 #ifdef ACPI_DEBUG_OUTPUT
763 AcpiUtDisplayInitPathname (
765 ACPI_NAMESPACE_NODE *ObjHandle,
774 AcpiUtWalkAmlResources (
777 ACPI_WALK_AML_CALLBACK UserFunction,
781 AcpiUtValidateResource (
786 AcpiUtGetDescriptorLength (
790 AcpiUtGetResourceLength (
794 AcpiUtGetResourceHeaderLength (
798 AcpiUtGetResourceType (
802 AcpiUtGetResourceEndTag (
803 ACPI_OPERAND_OBJECT *ObjDesc,
808 * utmutex - mutex support
811 AcpiUtMutexInitialize (
815 AcpiUtMutexTerminate (
820 ACPI_MUTEX_HANDLE MutexId);
824 ACPI_MUTEX_HANDLE MutexId);
828 * utalloc - memory allocation and object caching
839 AcpiUtValidateBuffer (
840 ACPI_BUFFER *Buffer);
843 AcpiUtInitializeBuffer (
845 ACPI_SIZE RequiredLength);
855 AcpiUtAllocateZeroed (
861 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
863 AcpiUtAllocateAndTrack (
870 AcpiUtAllocateZeroedAndTrack (
884 AcpiUtDumpAllocationInfo (
888 AcpiUtDumpAllocations (
896 ACPI_MEMORY_LIST **ReturnCache);
898 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
902 * utxferror - various error/warning output functions
904 void ACPI_INTERNAL_VAR_XFACE
905 AcpiUtPredefinedWarning (
906 const char *ModuleName,
913 void ACPI_INTERNAL_VAR_XFACE
914 AcpiUtPredefinedInfo (
915 const char *ModuleName,
923 AcpiUtNamespaceError (
924 const char *ModuleName,
926 const char *InternalName,
927 ACPI_STATUS LookupStatus);
931 const char *ModuleName,
934 ACPI_NAMESPACE_NODE *Node,
936 ACPI_STATUS LookupStatus);
938 #endif /* _ACUTILS_H */