1 /******************************************************************************
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acutils.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $ */
123 ACPI_STATUS (*ACPI_PKG_CALLBACK) (
125 ACPI_OPERAND_OBJECT *SourceObject,
126 ACPI_GENERIC_STATE *State,
131 AcpiUtWalkPackageTree (
132 ACPI_OPERAND_OBJECT *SourceObject,
134 ACPI_PKG_CALLBACK WalkCallback,
138 typedef struct acpi_pkg_info
147 #define REF_INCREMENT (UINT16) 0
148 #define REF_DECREMENT (UINT16) 1
149 #define REF_FORCE_DELETE (UINT16) 2
151 /* AcpiUtDumpBuffer */
153 #define DB_BYTE_DISPLAY 1
154 #define DB_WORD_DISPLAY 2
155 #define DB_DWORD_DISPLAY 4
156 #define DB_QWORD_DISPLAY 8
159 /* Global initialization interfaces */
171 * UtInit - miscellaneous initialization and shutdown
175 AcpiUtHardwareInitialize (
179 AcpiUtSubsystemShutdown (
187 * UtGlobal - Global data structures and procedures
190 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
200 ACPI_OBJECT_TYPE Type);
203 AcpiUtGetObjectTypeName (
204 ACPI_OPERAND_OBJECT *ObjDesc);
207 AcpiUtGetRegionName (
215 AcpiUtHexToAsciiChar (
216 ACPI_INTEGER Integer,
220 AcpiUtValidObjectType (
221 ACPI_OBJECT_TYPE Type);
224 AcpiUtAllocateOwnerId (
229 * UtClib - Local implementations of C library functions
232 #ifndef ACPI_USE_SYSTEM_CLIBRARY
241 const char *SrcString);
246 const char *SrcString,
258 const char *String2);
263 const char *SrcString);
268 const char *SrcString,
291 ACPI_NATIVE_UINT Value,
302 extern const UINT8 _acpi_ctype[];
304 #define _ACPI_XA 0x00 /* extra alphabetic - not supported */
305 #define _ACPI_XS 0x40 /* extra space */
306 #define _ACPI_BB 0x00 /* BEL, BS, etc. - not supported */
307 #define _ACPI_CN 0x20 /* CR, FF, HT, NL, VT */
308 #define _ACPI_DI 0x04 /* '0'-'9' */
309 #define _ACPI_LO 0x02 /* 'a'-'z' */
310 #define _ACPI_PU 0x10 /* punctuation */
311 #define _ACPI_SP 0x08 /* space */
312 #define _ACPI_UP 0x01 /* 'A'-'Z' */
313 #define _ACPI_XD 0x80 /* '0'-'9', 'A'-'F', 'a'-'f' */
315 #define ACPI_IS_DIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_DI))
316 #define ACPI_IS_SPACE(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_SP))
317 #define ACPI_IS_XDIGIT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_XD))
318 #define ACPI_IS_UPPER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_UP))
319 #define ACPI_IS_LOWER(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO))
320 #define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
321 #define ACPI_IS_ALPHA(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP))
322 #define ACPI_IS_ASCII(c) ((c) < 0x80)
324 #endif /* ACPI_USE_SYSTEM_CLIBRARY */
327 * UtCopy - Object construction and conversion interfaces
331 AcpiUtBuildSimpleObject(
332 ACPI_OPERAND_OBJECT *Obj,
333 ACPI_OBJECT *UserObj,
335 UINT32 *BufferSpaceUsed);
338 AcpiUtBuildPackageObject (
339 ACPI_OPERAND_OBJECT *Obj,
344 AcpiUtCopyIelementToEelement (
346 ACPI_OPERAND_OBJECT *SourceObject,
347 ACPI_GENERIC_STATE *State,
351 AcpiUtCopyIelementToIelement (
353 ACPI_OPERAND_OBJECT *SourceObject,
354 ACPI_GENERIC_STATE *State,
358 AcpiUtCopyIobjectToEobject (
359 ACPI_OPERAND_OBJECT *Obj,
360 ACPI_BUFFER *RetBuffer);
363 AcpiUtCopyEsimpleToIsimple(
364 ACPI_OBJECT *UserObj,
365 ACPI_OPERAND_OBJECT **ReturnObj);
368 AcpiUtCopyEobjectToIobject (
370 ACPI_OPERAND_OBJECT **InternalObj);
373 AcpiUtCopyISimpleToIsimple (
374 ACPI_OPERAND_OBJECT *SourceObj,
375 ACPI_OPERAND_OBJECT *DestObj);
378 AcpiUtCopyIpackageToIpackage (
379 ACPI_OPERAND_OBJECT *SourceObj,
380 ACPI_OPERAND_OBJECT *DestObj,
381 ACPI_WALK_STATE *WalkState);
384 AcpiUtCopySimpleObject (
385 ACPI_OPERAND_OBJECT *SourceDesc,
386 ACPI_OPERAND_OBJECT *DestDesc);
389 AcpiUtCopyIobjectToIobject (
390 ACPI_OPERAND_OBJECT *SourceDesc,
391 ACPI_OPERAND_OBJECT **DestDesc,
392 ACPI_WALK_STATE *WalkState);
396 * UtCreate - Object creation
400 AcpiUtUpdateObjectReference (
401 ACPI_OPERAND_OBJECT *Object,
406 * UtDebug - Debug interfaces
410 AcpiUtInitStackPtrTrace (
414 AcpiUtTrackStackPtr (
420 ACPI_DEBUG_PRINT_INFO *DbgInfo);
425 ACPI_DEBUG_PRINT_INFO *DbgInfo,
431 ACPI_DEBUG_PRINT_INFO *DbgInfo,
437 ACPI_DEBUG_PRINT_INFO *DbgInfo,
443 ACPI_DEBUG_PRINT_INFO *DbgInfo);
448 ACPI_DEBUG_PRINT_INFO *DbgInfo,
454 ACPI_DEBUG_PRINT_INFO *DbgInfo,
460 ACPI_DEBUG_PRINT_INFO *DbgInfo,
476 AcpiUtReportWarning (
488 void ACPI_INTERNAL_VAR_XFACE
490 UINT32 RequestedDebugLevel,
492 ACPI_DEBUG_PRINT_INFO *DbgInfo,
494 ...) ACPI_PRINTF_LIKE_FUNC;
496 void ACPI_INTERNAL_VAR_XFACE
497 AcpiUtDebugPrintRaw (
498 UINT32 RequestedDebugLevel,
500 ACPI_DEBUG_PRINT_INFO *DbgInfo,
502 ...) ACPI_PRINTF_LIKE_FUNC;
506 * UtDelete - Object deletion
510 AcpiUtDeleteInternalObj (
511 ACPI_OPERAND_OBJECT *Object);
514 AcpiUtDeleteInternalPackageObject (
515 ACPI_OPERAND_OBJECT *Object);
518 AcpiUtDeleteInternalSimpleObject (
519 ACPI_OPERAND_OBJECT *Object);
522 AcpiUtDeleteInternalObjectList (
523 ACPI_OPERAND_OBJECT **ObjList);
527 * UtEval - object evaluation
530 /* Method name strings */
532 #define METHOD_NAME__HID "_HID"
533 #define METHOD_NAME__CID "_CID"
534 #define METHOD_NAME__UID "_UID"
535 #define METHOD_NAME__ADR "_ADR"
536 #define METHOD_NAME__STA "_STA"
537 #define METHOD_NAME__REG "_REG"
538 #define METHOD_NAME__SEG "_SEG"
539 #define METHOD_NAME__BBN "_BBN"
540 #define METHOD_NAME__PRT "_PRT"
541 #define METHOD_NAME__CRS "_CRS"
542 #define METHOD_NAME__PRS "_PRS"
546 AcpiUtEvaluateObject (
547 ACPI_NAMESPACE_NODE *PrefixNode,
549 UINT32 ExpectedReturnBtypes,
550 ACPI_OPERAND_OBJECT **ReturnDesc);
553 AcpiUtEvaluateNumericObject (
555 ACPI_NAMESPACE_NODE *DeviceNode,
556 ACPI_INTEGER *Address);
560 ACPI_NAMESPACE_NODE *DeviceNode,
561 ACPI_DEVICE_ID *Hid);
565 ACPI_NAMESPACE_NODE *DeviceNode,
566 ACPI_DEVICE_ID *Cid);
570 ACPI_NAMESPACE_NODE *DeviceNode,
571 UINT32 *StatusFlags);
575 ACPI_NAMESPACE_NODE *DeviceNode,
576 ACPI_DEVICE_ID *Uid);
580 * UtMutex - mutual exclusion interfaces
584 AcpiUtMutexInitialize (
588 AcpiUtMutexTerminate (
593 ACPI_MUTEX_HANDLE MutexId);
597 ACPI_MUTEX_HANDLE MutexId);
601 ACPI_MUTEX_HANDLE MutexId);
605 ACPI_MUTEX_HANDLE MutexId);
609 * UtObject - internal object create/delete/cache routines
612 ACPI_OPERAND_OBJECT *
613 AcpiUtCreateInternalObjectDbg (
617 ACPI_OBJECT_TYPE Type);
620 AcpiUtAllocateObjectDescDbg (
625 #define AcpiUtCreateInternalObject(t) AcpiUtCreateInternalObjectDbg (_THIS_MODULE,__LINE__,_COMPONENT,t)
626 #define AcpiUtAllocateObjectDesc() AcpiUtAllocateObjectDescDbg (_THIS_MODULE,__LINE__,_COMPONENT)
629 AcpiUtDeleteObjectDesc (
630 ACPI_OPERAND_OBJECT *Object);
633 AcpiUtValidInternalObject (
636 ACPI_OPERAND_OBJECT *
637 AcpiUtCreateBufferObject (
638 ACPI_SIZE BufferSize);
642 * UtRefCnt - Object reference count management
647 ACPI_OPERAND_OBJECT *Object);
650 AcpiUtRemoveReference (
651 ACPI_OPERAND_OBJECT *Object);
654 * UtSize - Object size routines
658 AcpiUtGetSimpleObjectSize (
659 ACPI_OPERAND_OBJECT *Obj,
660 ACPI_SIZE *ObjLength);
663 AcpiUtGetPackageObjectSize (
664 ACPI_OPERAND_OBJECT *Obj,
665 ACPI_SIZE *ObjLength);
669 ACPI_OPERAND_OBJECT *Obj,
670 ACPI_SIZE *ObjLength);
673 AcpiUtGetElementLength (
675 ACPI_OPERAND_OBJECT *SourceObject,
676 ACPI_GENERIC_STATE *State,
681 * UtState - Generic state creation/cache routines
685 AcpiUtPushGenericState (
686 ACPI_GENERIC_STATE **ListHead,
687 ACPI_GENERIC_STATE *State);
690 AcpiUtPopGenericState (
691 ACPI_GENERIC_STATE **ListHead);
695 AcpiUtCreateGenericState (
699 AcpiUtCreateThreadState (
703 AcpiUtCreateUpdateState (
704 ACPI_OPERAND_OBJECT *Object,
708 AcpiUtCreatePkgState (
709 void *InternalObject,
710 void *ExternalObject,
714 AcpiUtCreateUpdateStateAndPush (
715 ACPI_OPERAND_OBJECT *Object,
717 ACPI_GENERIC_STATE **StateList);
720 AcpiUtCreatePkgStateAndPush (
721 void *InternalObject,
722 void *ExternalObject,
724 ACPI_GENERIC_STATE **StateList);
727 AcpiUtCreateControlState (
731 AcpiUtDeleteGenericState (
732 ACPI_GENERIC_STATE *State);
735 AcpiUtDeleteGenericStateCache (
739 AcpiUtDeleteObjectCache (
753 ACPI_INTEGER *InDividend,
754 ACPI_INTEGER *InDivisor,
755 ACPI_INTEGER *OutQuotient,
756 ACPI_INTEGER *OutRemainder);
760 ACPI_INTEGER *InDividend,
762 ACPI_INTEGER *OutQuotient,
763 UINT32 *OutRemainder);
766 AcpiUtValidAcpiName (
770 AcpiUtValidAcpiCharacter (
777 ACPI_INTEGER *RetInteger);
784 AcpiUtGetResourceEndTag (
785 ACPI_OPERAND_OBJECT *ObjDesc);
788 AcpiUtGenerateChecksum (
793 AcpiUtDwordByteSwap (
797 AcpiUtSetIntegerWidth (
800 #ifdef ACPI_DEBUG_OUTPUT
802 AcpiUtDisplayInitPathname (
804 ACPI_NAMESPACE_NODE *ObjHandle,
811 * Utalloc - memory allocation and object caching
815 AcpiUtAcquireFromCache (
819 AcpiUtReleaseToCache (
824 AcpiUtDeleteGenericCache (
828 AcpiUtValidateBuffer (
829 ACPI_BUFFER *Buffer);
832 AcpiUtInitializeBuffer (
834 ACPI_SIZE RequiredLength);
837 /* Memory allocation functions */
854 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
857 AcpiUtAllocateAndTrack (
864 AcpiUtCallocateAndTrack (
877 ACPI_DEBUG_MEM_BLOCK *
878 AcpiUtFindAllocation (
883 AcpiUtTrackAllocation (
885 ACPI_DEBUG_MEM_BLOCK *Address,
893 AcpiUtRemoveAllocation (
895 ACPI_DEBUG_MEM_BLOCK *Address,
901 AcpiUtDumpAllocationInfo (
905 AcpiUtDumpAllocations (
911 #endif /* _ACUTILS_H */