1/******************************************************************************
2 *
3 * Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44#ifndef _ACUTILS_H
45#define _ACUTILS_H
46
47
48extern const UINT8 AcpiGbl_ResourceAmlSizes[];
49extern const UINT8 AcpiGbl_ResourceAmlSerialBusSizes[];
50
51/* Strings used by the disassembler and debugger resource dump routines */
52
53#if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
54
55extern const char *AcpiGbl_BmDecode[];
56extern const char *AcpiGbl_ConfigDecode[];
57extern const char *AcpiGbl_ConsumeDecode[];
58extern const char *AcpiGbl_DecDecode[];
59extern const char *AcpiGbl_HeDecode[];
60extern const char *AcpiGbl_IoDecode[];
61extern const char *AcpiGbl_LlDecode[];
62extern const char *AcpiGbl_MaxDecode[];
63extern const char *AcpiGbl_MemDecode[];
64extern const char *AcpiGbl_MinDecode[];
65extern const char *AcpiGbl_MtpDecode[];
66extern const char *AcpiGbl_RngDecode[];
67extern const char *AcpiGbl_RwDecode[];
68extern const char *AcpiGbl_ShrDecode[];
69extern const char *AcpiGbl_SizDecode[];
70extern const char *AcpiGbl_TrsDecode[];
71extern const char *AcpiGbl_TtpDecode[];
72extern const char *AcpiGbl_TypDecode[];
73extern const char *AcpiGbl_PpcDecode[];
74extern const char *AcpiGbl_IorDecode[];
75extern const char *AcpiGbl_DtsDecode[];
76extern const char *AcpiGbl_CtDecode[];
77extern const char *AcpiGbl_SbtDecode[];
78extern const char *AcpiGbl_AmDecode[];
79extern const char *AcpiGbl_SmDecode[];
80extern const char *AcpiGbl_WmDecode[];
81extern const char *AcpiGbl_CphDecode[];
82extern const char *AcpiGbl_CpoDecode[];
83extern const char *AcpiGbl_DpDecode[];
84extern const char *AcpiGbl_EdDecode[];
85extern const char *AcpiGbl_BpbDecode[];
86extern const char *AcpiGbl_SbDecode[];
87extern const char *AcpiGbl_FcDecode[];
88extern const char *AcpiGbl_PtDecode[];
89#endif
90
91/*
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.
95 */
96#ifdef ACPI_ASL_COMPILER
97
98#include <stdio.h>
99
100#define ACPI_MSG_REDIRECT_BEGIN \
101 FILE *OutputFile = AcpiGbl_OutputFile; \
102 AcpiOsRedirectOutput (stderr);
103
104#define ACPI_MSG_REDIRECT_END \
105 AcpiOsRedirectOutput (OutputFile);
106
107#else
108/*
109 * non-iASL case - no redirection, nothing to do
110 */
111#define ACPI_MSG_REDIRECT_BEGIN
112#define ACPI_MSG_REDIRECT_END
113#endif
114
115/*
116 * Common error message prefixes
117 */
118#ifndef ACPI_MSG_ERROR
119#define ACPI_MSG_ERROR "ACPI Error: "
120#endif
121#ifndef ACPI_MSG_EXCEPTION
122#define ACPI_MSG_EXCEPTION "ACPI Exception: "
123#endif
124#ifndef ACPI_MSG_WARNING
125#define ACPI_MSG_WARNING "ACPI Warning: "
126#endif
127#ifndef ACPI_MSG_INFO
128#define ACPI_MSG_INFO "ACPI: "
129#endif
130
131#ifndef ACPI_MSG_BIOS_ERROR
132#define ACPI_MSG_BIOS_ERROR "ACPI BIOS Error (bug): "
133#endif
134#ifndef ACPI_MSG_BIOS_WARNING
135#define ACPI_MSG_BIOS_WARNING "ACPI BIOS Warning (bug): "
136#endif
137
138/*
139 * Common message suffix
140 */
141#define ACPI_MSG_SUFFIX \
142 AcpiOsPrintf (" (%8.8X/%s-%u)\n", ACPI_CA_VERSION, ModuleName, LineNumber)
143
144
145/* Types for Resource descriptor entries */
146
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
151
152typedef
153ACPI_STATUS (*ACPI_WALK_AML_CALLBACK) (
154 UINT8 *Aml,
155 UINT32 Length,
156 UINT32 Offset,
157 UINT8 ResourceIndex,
158 void **Context);
159
160typedef
161ACPI_STATUS (*ACPI_PKG_CALLBACK) (
162 UINT8 ObjectType,
163 ACPI_OPERAND_OBJECT *SourceObject,
164 ACPI_GENERIC_STATE *State,
165 void *Context);
166
167typedef struct acpi_pkg_info
168{
169 UINT8 *FreeSpace;
170 ACPI_SIZE Length;
171 UINT32 ObjectSpace;
172 UINT32 NumPackages;
173
174} ACPI_PKG_INFO;
175
176/* Object reference counts */
177
178#define REF_INCREMENT (UINT16) 0
179#define REF_DECREMENT (UINT16) 1
180
181/* AcpiUtDumpBuffer */
182
183#define DB_BYTE_DISPLAY 1
184#define DB_WORD_DISPLAY 2
185#define DB_DWORD_DISPLAY 4
186#define DB_QWORD_DISPLAY 8
187
188
189/*
190 * utascii - ASCII utilities
191 */
192BOOLEAN
193AcpiUtValidNameseg (
194 char *Signature);
195
196BOOLEAN
197AcpiUtValidNameChar (
198 char Character,
199 UINT32 Position);
200
201void
202AcpiUtCheckAndRepairAscii (
203 UINT8 *Name,
204 char *RepairedName,
205 UINT32 Count);
206
207
208/*
209 * utnonansi - Non-ANSI C library functions
210 */
211void
212AcpiUtStrupr (
213 char *SrcString);
214
215void
216AcpiUtStrlwr (
217 char *SrcString);
218
219int
220AcpiUtStricmp (
221 char *String1,
222 char *String2);
223
224ACPI_STATUS
225AcpiUtStrtoul64 (
226 char *String,
227 UINT32 Flags,
228 UINT64 *RetInteger);
229
230/*
231 * Values for Flags above
232 * Note: LIMIT values correspond to AcpiGbl_IntegerByteWidth values (4/8)
233 */
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 */
237
238
239/*
240 * utglobal - Global data structures and procedures
241 */
242ACPI_STATUS
243AcpiUtInitGlobals (
244 void);
245
246#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
247
248const char *
249AcpiUtGetMutexName (
250 UINT32 MutexId);
251
252const char *
253AcpiUtGetNotifyName (
254 UINT32 NotifyValue,
255 ACPI_OBJECT_TYPE Type);
256#endif
257
258const char *
259AcpiUtGetTypeName (
260 ACPI_OBJECT_TYPE Type);
261
262const char *
263AcpiUtGetNodeName (
264 void *Object);
265
266const char *
267AcpiUtGetDescriptorName (
268 void *Object);
269
270const char *
271AcpiUtGetReferenceName (
272 ACPI_OPERAND_OBJECT *Object);
273
274const char *
275AcpiUtGetObjectTypeName (
276 ACPI_OPERAND_OBJECT *ObjDesc);
277
278const char *
279AcpiUtGetRegionName (
280 UINT8 SpaceId);
281
282const char *
283AcpiUtGetEventName (
284 UINT32 EventId);
285
286char
287AcpiUtHexToAsciiChar (
288 UINT64 Integer,
289 UINT32 Position);
290
291ACPI_STATUS
292AcpiUtAsciiToHexByte (
293 char *TwoAsciiChars,
294 UINT8 *ReturnByte);
295
296UINT8
297AcpiUtAsciiCharToHex (
298 int HexChar);
299
300BOOLEAN
301AcpiUtValidObjectType (
302 ACPI_OBJECT_TYPE Type);
303
304
305/*
306 * utinit - miscellaneous initialization and shutdown
307 */
308ACPI_STATUS
309AcpiUtHardwareInitialize (
310 void);
311
312void
313AcpiUtSubsystemShutdown (
314 void);
315
316
317/*
318 * utcopy - Object construction and conversion interfaces
319 */
320ACPI_STATUS
321AcpiUtBuildSimpleObject(
322 ACPI_OPERAND_OBJECT *Obj,
323 ACPI_OBJECT *UserObj,
324 UINT8 *DataSpace,
325 UINT32 *BufferSpaceUsed);
326
327ACPI_STATUS
328AcpiUtBuildPackageObject (
329 ACPI_OPERAND_OBJECT *Obj,
330 UINT8 *Buffer,
331 UINT32 *SpaceUsed);
332
333ACPI_STATUS
334AcpiUtCopyIobjectToEobject (
335 ACPI_OPERAND_OBJECT *Obj,
336 ACPI_BUFFER *RetBuffer);
337
338ACPI_STATUS
339AcpiUtCopyEobjectToIobject (
340 ACPI_OBJECT *Obj,
341 ACPI_OPERAND_OBJECT **InternalObj);
342
343ACPI_STATUS
344AcpiUtCopyISimpleToIsimple (
345 ACPI_OPERAND_OBJECT *SourceObj,
346 ACPI_OPERAND_OBJECT *DestObj);
347
348ACPI_STATUS
349AcpiUtCopyIobjectToIobject (
350 ACPI_OPERAND_OBJECT *SourceDesc,
351 ACPI_OPERAND_OBJECT **DestDesc,
352 ACPI_WALK_STATE *WalkState);
353
354
355/*
356 * utcreate - Object creation
357 */
358ACPI_STATUS
359AcpiUtUpdateObjectReference (
360 ACPI_OPERAND_OBJECT *Object,
361 UINT16 Action);
362
363
364/*
365 * utdebug - Debug interfaces
366 */
367void
368AcpiUtInitStackPtrTrace (
369 void);
370
371void
372AcpiUtTrackStackPtr (
373 void);
374
375void
376AcpiUtTrace (
377 UINT32 LineNumber,
378 const char *FunctionName,
379 const char *ModuleName,
380 UINT32 ComponentId);
381
382void
383AcpiUtTracePtr (
384 UINT32 LineNumber,
385 const char *FunctionName,
386 const char *ModuleName,
387 UINT32 ComponentId,
388 const void *Pointer);
389
390void
391AcpiUtTraceU32 (
392 UINT32 LineNumber,
393 const char *FunctionName,
394 const char *ModuleName,
395 UINT32 ComponentId,
396 UINT32 Integer);
397
398void
399AcpiUtTraceStr (
400 UINT32 LineNumber,
401 const char *FunctionName,
402 const char *ModuleName,
403 UINT32 ComponentId,
404 const char *String);
405
406void
407AcpiUtExit (
408 UINT32 LineNumber,
409 const char *FunctionName,
410 const char *ModuleName,
411 UINT32 ComponentId);
412
413void
414AcpiUtStatusExit (
415 UINT32 LineNumber,
416 const char *FunctionName,
417 const char *ModuleName,
418 UINT32 ComponentId,
419 ACPI_STATUS Status);
420
421void
422AcpiUtValueExit (
423 UINT32 LineNumber,
424 const char *FunctionName,
425 const char *ModuleName,
426 UINT32 ComponentId,
427 UINT64 Value);
428
429void
430AcpiUtPtrExit (
431 UINT32 LineNumber,
432 const char *FunctionName,
433 const char *ModuleName,
434 UINT32 ComponentId,
435 UINT8 *Ptr);
436
437void
438AcpiUtStrExit (
439 UINT32 LineNumber,
440 const char *FunctionName,
441 const char *ModuleName,
442 UINT32 ComponentId,
443 const char *String);
444
445void
446AcpiUtDebugDumpBuffer (
447 UINT8 *Buffer,
448 UINT32 Count,
449 UINT32 Display,
450 UINT32 ComponentId);
451
452void
453AcpiUtDumpBuffer (
454 UINT8 *Buffer,
455 UINT32 Count,
456 UINT32 Display,
457 UINT32 Offset);
458
459#ifdef ACPI_APPLICATION
460void
461AcpiUtDumpBufferToFile (
462 ACPI_FILE File,
463 UINT8 *Buffer,
464 UINT32 Count,
465 UINT32 Display,
466 UINT32 BaseOffset);
467#endif
468
469void
470AcpiUtReportError (
471 char *ModuleName,
472 UINT32 LineNumber);
473
474void
475AcpiUtReportInfo (
476 char *ModuleName,
477 UINT32 LineNumber);
478
479void
480AcpiUtReportWarning (
481 char *ModuleName,
482 UINT32 LineNumber);
483
484
485/*
486 * utdelete - Object deletion and reference counts
487 */
488void
489AcpiUtAddReference (
490 ACPI_OPERAND_OBJECT *Object);
491
492void
493AcpiUtRemoveReference (
494 ACPI_OPERAND_OBJECT *Object);
495
496void
497AcpiUtDeleteInternalPackageObject (
498 ACPI_OPERAND_OBJECT *Object);
499
500void
501AcpiUtDeleteInternalSimpleObject (
502 ACPI_OPERAND_OBJECT *Object);
503
504void
505AcpiUtDeleteInternalObjectList (
506 ACPI_OPERAND_OBJECT **ObjList);
507
508
509/*
510 * uteval - object evaluation
511 */
512ACPI_STATUS
513AcpiUtEvaluateObject (
514 ACPI_NAMESPACE_NODE *PrefixNode,
515 const char *Path,
516 UINT32 ExpectedReturnBtypes,
517 ACPI_OPERAND_OBJECT **ReturnDesc);
518
519ACPI_STATUS
520AcpiUtEvaluateNumericObject (
521 const char *ObjectName,
522 ACPI_NAMESPACE_NODE *DeviceNode,
523 UINT64 *Value);
524
525ACPI_STATUS
526AcpiUtExecute_STA (
527 ACPI_NAMESPACE_NODE *DeviceNode,
528 UINT32 *StatusFlags);
529
530ACPI_STATUS
531AcpiUtExecutePowerMethods (
532 ACPI_NAMESPACE_NODE *DeviceNode,
533 const char **MethodNames,
534 UINT8 MethodCount,
535 UINT8 *OutValues);
536
537
538/*
539 * utids - device ID support
540 */
541ACPI_STATUS
542AcpiUtExecute_HID (
543 ACPI_NAMESPACE_NODE *DeviceNode,
544 ACPI_PNP_DEVICE_ID **ReturnId);
545
546ACPI_STATUS
547AcpiUtExecute_UID (
548 ACPI_NAMESPACE_NODE *DeviceNode,
549 ACPI_PNP_DEVICE_ID **ReturnId);
550
551ACPI_STATUS
552AcpiUtExecute_CID (
553 ACPI_NAMESPACE_NODE *DeviceNode,
554 ACPI_PNP_DEVICE_ID_LIST **ReturnCidList);
555
556ACPI_STATUS
557AcpiUtExecute_CLS (
558 ACPI_NAMESPACE_NODE *DeviceNode,
559 ACPI_PNP_DEVICE_ID **ReturnId);
560
561
562/*
563 * utlock - reader/writer locks
564 */
565ACPI_STATUS
566AcpiUtCreateRwLock (
567 ACPI_RW_LOCK *Lock);
568
569void
570AcpiUtDeleteRwLock (
571 ACPI_RW_LOCK *Lock);
572
573ACPI_STATUS
574AcpiUtAcquireReadLock (
575 ACPI_RW_LOCK *Lock);
576
577ACPI_STATUS
578AcpiUtReleaseReadLock (
579 ACPI_RW_LOCK *Lock);
580
581ACPI_STATUS
582AcpiUtAcquireWriteLock (
583 ACPI_RW_LOCK *Lock);
584
585void
586AcpiUtReleaseWriteLock (
587 ACPI_RW_LOCK *Lock);
588
589
590/*
591 * utobject - internal object create/delete/cache routines
592 */
593ACPI_OPERAND_OBJECT *
594AcpiUtCreateInternalObjectDbg (
595 const char *ModuleName,
596 UINT32 LineNumber,
597 UINT32 ComponentId,
598 ACPI_OBJECT_TYPE Type);
599
600void *
601AcpiUtAllocateObjectDescDbg (
602 const char *ModuleName,
603 UINT32 LineNumber,
604 UINT32 ComponentId);
605
606#define AcpiUtCreateInternalObject(t) AcpiUtCreateInternalObjectDbg (_AcpiModuleName,__LINE__,_COMPONENT,t)
607#define AcpiUtAllocateObjectDesc() AcpiUtAllocateObjectDescDbg (_AcpiModuleName,__LINE__,_COMPONENT)
608
609void
610AcpiUtDeleteObjectDesc (
611 ACPI_OPERAND_OBJECT *Object);
612
613BOOLEAN
614AcpiUtValidInternalObject (
615 void *Object);
616
617ACPI_OPERAND_OBJECT *
618AcpiUtCreatePackageObject (
619 UINT32 Count);
620
621ACPI_OPERAND_OBJECT *
622AcpiUtCreateIntegerObject (
623 UINT64 Value);
624
625ACPI_OPERAND_OBJECT *
626AcpiUtCreateBufferObject (
627 ACPI_SIZE BufferSize);
628
629ACPI_OPERAND_OBJECT *
630AcpiUtCreateStringObject (
631 ACPI_SIZE StringSize);
632
633ACPI_STATUS
634AcpiUtGetObjectSize(
635 ACPI_OPERAND_OBJECT *Obj,
636 ACPI_SIZE *ObjLength);
637
638
639/*
640 * utosi - Support for the _OSI predefined control method
641 */
642ACPI_STATUS
643AcpiUtInitializeInterfaces (
644 void);
645
646ACPI_STATUS
647AcpiUtInterfaceTerminate (
648 void);
649
650ACPI_STATUS
651AcpiUtInstallInterface (
652 ACPI_STRING InterfaceName);
653
654ACPI_STATUS
655AcpiUtRemoveInterface (
656 ACPI_STRING InterfaceName);
657
658ACPI_STATUS
659AcpiUtUpdateInterfaces (
660 UINT8 Action);
661
662ACPI_INTERFACE_INFO *
663AcpiUtGetInterface (
664 ACPI_STRING InterfaceName);
665
666ACPI_STATUS
667AcpiUtOsiImplementation (
668 ACPI_WALK_STATE *WalkState);
669
670
671/*
672 * utpredef - support for predefined names
673 */
674const ACPI_PREDEFINED_INFO *
675AcpiUtGetNextPredefinedMethod (
676 const ACPI_PREDEFINED_INFO *ThisName);
677
678const ACPI_PREDEFINED_INFO *
679AcpiUtMatchPredefinedMethod (
680 char *Name);
681
682void
683AcpiUtGetExpectedReturnTypes (
684 char *Buffer,
685 UINT32 ExpectedBtypes);
686
687#if (defined ACPI_ASL_COMPILER || defined ACPI_HELP_APP)
688const ACPI_PREDEFINED_INFO *
689AcpiUtMatchResourceName (
690 char *Name);
691
692void
693AcpiUtDisplayPredefinedMethod (
694 char *Buffer,
695 const ACPI_PREDEFINED_INFO *ThisName,
696 BOOLEAN MultiLine);
697
698UINT32
699AcpiUtGetResourceBitWidth (
700 char *Buffer,
701 UINT16 Types);
702#endif
703
704
705/*
706 * utstate - Generic state creation/cache routines
707 */
708void
709AcpiUtPushGenericState (
710 ACPI_GENERIC_STATE **ListHead,
711 ACPI_GENERIC_STATE *State);
712
713ACPI_GENERIC_STATE *
714AcpiUtPopGenericState (
715 ACPI_GENERIC_STATE **ListHead);
716
717
718ACPI_GENERIC_STATE *
719AcpiUtCreateGenericState (
720 void);
721
722ACPI_THREAD_STATE *
723AcpiUtCreateThreadState (
724 void);
725
726ACPI_GENERIC_STATE *
727AcpiUtCreateUpdateState (
728 ACPI_OPERAND_OBJECT *Object,
729 UINT16 Action);
730
731ACPI_GENERIC_STATE *
732AcpiUtCreatePkgState (
733 void *InternalObject,
734 void *ExternalObject,
735 UINT16 Index);
736
737ACPI_STATUS
738AcpiUtCreateUpdateStateAndPush (
739 ACPI_OPERAND_OBJECT *Object,
740 UINT16 Action,
741 ACPI_GENERIC_STATE **StateList);
742
743ACPI_GENERIC_STATE *
744AcpiUtCreateControlState (
745 void);
746
747void
748AcpiUtDeleteGenericState (
749 ACPI_GENERIC_STATE *State);
750
751
752/*
753 * utmath
754 */
755ACPI_STATUS
756AcpiUtDivide (
757 UINT64 InDividend,
758 UINT64 InDivisor,
759 UINT64 *OutQuotient,
760 UINT64 *OutRemainder);
761
762ACPI_STATUS
763AcpiUtShortDivide (
764 UINT64 InDividend,
765 UINT32 Divisor,
766 UINT64 *OutQuotient,
767 UINT32 *OutRemainder);
768
769
770/*
771 * utmisc
772 */
773const ACPI_EXCEPTION_INFO *
774AcpiUtValidateException (
775 ACPI_STATUS Status);
776
777BOOLEAN
778AcpiUtIsPciRootBridge (
779 char *Id);
780
781#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_NAMES_APP)
782BOOLEAN
783AcpiUtIsAmlTable (
784 ACPI_TABLE_HEADER *Table);
785#endif
786
787ACPI_STATUS
788AcpiUtWalkPackageTree (
789 ACPI_OPERAND_OBJECT *SourceObject,
790 void *TargetObject,
791 ACPI_PKG_CALLBACK WalkCallback,
792 void *Context);
793
794/* Values for Base above (16=Hex, 10=Decimal) */
795
796#define ACPI_ANY_BASE 0
797
798
799UINT32
800AcpiUtDwordByteSwap (
801 UINT32 Value);
802
803void
804AcpiUtSetIntegerWidth (
805 UINT8 Revision);
806
807#ifdef ACPI_DEBUG_OUTPUT
808void
809AcpiUtDisplayInitPathname (
810 UINT8 Type,
811 ACPI_NAMESPACE_NODE *ObjHandle,
812 const char *Path);
813#endif
814
815
816/*
817 * utownerid - Support for Table/Method Owner IDs
818 */
819ACPI_STATUS
820AcpiUtAllocateOwnerId (
821 ACPI_OWNER_ID *OwnerId);
822
823void
824AcpiUtReleaseOwnerId (
825 ACPI_OWNER_ID *OwnerId);
826
827
828/*
829 * utresrc
830 */
831ACPI_STATUS
832AcpiUtWalkAmlResources (
833 ACPI_WALK_STATE *WalkState,
834 UINT8 *Aml,
835 ACPI_SIZE AmlLength,
836 ACPI_WALK_AML_CALLBACK UserFunction,
837 void **Context);
838
839ACPI_STATUS
840AcpiUtValidateResource (
841 ACPI_WALK_STATE *WalkState,
842 void *Aml,
843 UINT8 *ReturnIndex);
844
845UINT32
846AcpiUtGetDescriptorLength (
847 void *Aml);
848
849UINT16
850AcpiUtGetResourceLength (
851 void *Aml);
852
853UINT8
854AcpiUtGetResourceHeaderLength (
855 void *Aml);
856
857UINT8
858AcpiUtGetResourceType (
859 void *Aml);
860
861ACPI_STATUS
862AcpiUtGetResourceEndTag (
863 ACPI_OPERAND_OBJECT *ObjDesc,
864 UINT8 **EndTag);
865
866
867/*
868 * utstring - String and character utilities
869 */
870void
871AcpiUtPrintString (
872 char *String,
873 UINT16 MaxLength);
874
875#if defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP
876void
877UtConvertBackslashes (
878 char *Pathname);
879#endif
880
881void
882AcpiUtRepairName (
883 char *Name);
884
885#if defined (ACPI_DEBUGGER) || defined (ACPI_APPLICATION)
886BOOLEAN
887AcpiUtSafeStrcpy (
888 char *Dest,
889 ACPI_SIZE DestSize,
890 char *Source);
891
892BOOLEAN
893AcpiUtSafeStrcat (
894 char *Dest,
895 ACPI_SIZE DestSize,
896 char *Source);
897
898BOOLEAN
899AcpiUtSafeStrncat (
900 char *Dest,
901 ACPI_SIZE DestSize,
902 char *Source,
903 ACPI_SIZE MaxTransferLength);
904#endif
905
906
907/*
908 * utmutex - mutex support
909 */
910ACPI_STATUS
911AcpiUtMutexInitialize (
912 void);
913
914void
915AcpiUtMutexTerminate (
916 void);
917
918ACPI_STATUS
919AcpiUtAcquireMutex (
920 ACPI_MUTEX_HANDLE MutexId);
921
922ACPI_STATUS
923AcpiUtReleaseMutex (
924 ACPI_MUTEX_HANDLE MutexId);
925
926
927/*
928 * utalloc - memory allocation and object caching
929 */
930ACPI_STATUS
931AcpiUtCreateCaches (
932 void);
933
934ACPI_STATUS
935AcpiUtDeleteCaches (
936 void);
937
938ACPI_STATUS
939AcpiUtValidateBuffer (
940 ACPI_BUFFER *Buffer);
941
942ACPI_STATUS
943AcpiUtInitializeBuffer (
944 ACPI_BUFFER *Buffer,
945 ACPI_SIZE RequiredLength);
946
947#ifdef ACPI_DBG_TRACK_ALLOCATIONS
948void *
949AcpiUtAllocateAndTrack (
950 ACPI_SIZE Size,
951 UINT32 Component,
952 const char *Module,
953 UINT32 Line);
954
955void *
956AcpiUtAllocateZeroedAndTrack (
957 ACPI_SIZE Size,
958 UINT32 Component,
959 const char *Module,
960 UINT32 Line);
961
962void
963AcpiUtFreeAndTrack (
964 void *Address,
965 UINT32 Component,
966 const char *Module,
967 UINT32 Line);
968
969void
970AcpiUtDumpAllocationInfo (
971 void);
972
973void
974AcpiUtDumpAllocations (
975 UINT32 Component,
976 const char *Module);
977
978ACPI_STATUS
979AcpiUtCreateList (
980 const char *ListName,
981 UINT16 ObjectSize,
982 ACPI_MEMORY_LIST **ReturnCache);
983
984#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
985
986
987/*
988 * utaddress - address range check
989 */
990ACPI_STATUS
991AcpiUtAddAddressRange (
992 ACPI_ADR_SPACE_TYPE SpaceId,
993 ACPI_PHYSICAL_ADDRESS Address,
994 UINT32 Length,
995 ACPI_NAMESPACE_NODE *RegionNode);
996
997void
998AcpiUtRemoveAddressRange (
999 ACPI_ADR_SPACE_TYPE SpaceId,
1000 ACPI_NAMESPACE_NODE *RegionNode);
1001
1002UINT32
1003AcpiUtCheckAddressRange (
1004 ACPI_ADR_SPACE_TYPE SpaceId,
1005 ACPI_PHYSICAL_ADDRESS Address,
1006 UINT32 Length,
1007 BOOLEAN Warn);
1008
1009void
1010AcpiUtDeleteAddressLists (
1011 void);
1012
1013
1014/*
1015 * utxferror - various error/warning output functions
1016 */
1017void ACPI_INTERNAL_VAR_XFACE
1018AcpiUtPredefinedWarning (
1019 const char *ModuleName,
1020 UINT32 LineNumber,
1021 char *Pathname,
1022 UINT8 NodeFlags,
1023 const char *Format,
1024 ...);
1025
1026void ACPI_INTERNAL_VAR_XFACE
1027AcpiUtPredefinedInfo (
1028 const char *ModuleName,
1029 UINT32 LineNumber,
1030 char *Pathname,
1031 UINT8 NodeFlags,
1032 const char *Format,
1033 ...);
1034
1035void ACPI_INTERNAL_VAR_XFACE
1036AcpiUtPredefinedBiosError (
1037 const char *ModuleName,
1038 UINT32 LineNumber,
1039 char *Pathname,
1040 UINT8 NodeFlags,
1041 const char *Format,
1042 ...);
1043
1044void
1045AcpiUtNamespaceError (
1046 const char *ModuleName,
1047 UINT32 LineNumber,
1048 const char *InternalName,
1049 ACPI_STATUS LookupStatus);
1050
1051void
1052AcpiUtMethodError (
1053 const char *ModuleName,
1054 UINT32 LineNumber,
1055 const char *Message,
1056 ACPI_NAMESPACE_NODE *Node,
1057 const char *Path,
1058 ACPI_STATUS LookupStatus);
1059
1060
1061/*
1062 * Utility functions for ACPI names and IDs
1063 */
1064const AH_PREDEFINED_NAME *
1065AcpiAhMatchPredefinedName (
1066 char *Nameseg);
1067
1068const AH_DEVICE_ID *
1069AcpiAhMatchHardwareId (
1070 char *Hid);
1071
1072const char *
1073AcpiAhMatchUuid (
1074 UINT8 *Data);
1075
1076
1077/*
1078 * utuuid -- UUID support functions
1079 */
1080#if (defined ACPI_ASL_COMPILER || defined ACPI_EXEC_APP || defined ACPI_HELP_APP|| defined ACPI_DISASSEMBLER)
1081void
1082AcpiUtConvertStringToUuid (
1083 const char *InString,
1084 UINT8 *UuidBuffer);
1085#endif
1086
1087#endif /* _ACUTILS_H */
1088