kernel: Sync ACPICA with Intel's version 20140325.
[dragonfly.git] / sys / contrib / dev / acpica / source / compiler / dtutils.c
1 /******************************************************************************
2  *
3  * Module Name: dtutils.c - Utility routines for the data table compiler
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2014, 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 #define __DTUTILS_C__
45
46 #include "aslcompiler.h"
47 #include "dtcompiler.h"
48 #include "actables.h"
49
50 #define _COMPONENT          DT_COMPILER
51         ACPI_MODULE_NAME    ("dtutils")
52
53 /* Local prototypes */
54
55 static void
56 DtSum (
57     DT_SUBTABLE             *Subtable,
58     void                    *Context,
59     void                    *ReturnValue);
60
61
62 /******************************************************************************
63  *
64  * FUNCTION:    DtError
65  *
66  * PARAMETERS:  Level               - Seriousness (Warning/error, etc.)
67  *              MessageId           - Index into global message buffer
68  *              Op                  - Parse node where error happened
69  *              ExtraMessage        - additional error message
70  *
71  * RETURN:      None
72  *
73  * DESCRIPTION: Common error interface for data table compiler
74  *
75  *****************************************************************************/
76
77 void
78 DtError (
79     UINT8                   Level,
80     UINT8                   MessageId,
81     DT_FIELD                *FieldObject,
82     char                    *ExtraMessage)
83 {
84
85     /* Check if user wants to ignore this exception */
86
87     if (AslIsExceptionDisabled (Level, MessageId))
88     {
89         return;
90     }
91
92     if (FieldObject)
93     {
94         AslCommonError (Level, MessageId,
95             FieldObject->Line,
96             FieldObject->Line,
97             FieldObject->ByteOffset,
98             FieldObject->Column,
99             Gbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
100     }
101     else
102     {
103         AslCommonError (Level, MessageId, 0,
104             0, 0, 0, 0, ExtraMessage);
105     }
106 }
107
108
109 /******************************************************************************
110  *
111  * FUNCTION:    DtNameError
112  *
113  * PARAMETERS:  Level               - Seriousness (Warning/error, etc.)
114  *              MessageId           - Index into global message buffer
115  *              Op                  - Parse node where error happened
116  *              ExtraMessage        - additional error message
117  *
118  * RETURN:      None
119  *
120  * DESCRIPTION: Error interface for named objects
121  *
122  *****************************************************************************/
123
124 void
125 DtNameError (
126     UINT8                   Level,
127     UINT8                   MessageId,
128     DT_FIELD                *FieldObject,
129     char                    *ExtraMessage)
130 {
131
132     switch (Level)
133     {
134     case ASL_WARNING2:
135     case ASL_WARNING3:
136
137         if (Gbl_WarningLevel < Level)
138         {
139             return;
140         }
141         break;
142
143     default:
144
145         break;
146     }
147
148     if (FieldObject)
149     {
150         AslCommonError (Level, MessageId,
151             FieldObject->Line,
152             FieldObject->Line,
153             FieldObject->ByteOffset,
154             FieldObject->NameColumn,
155             Gbl_Files[ASL_FILE_INPUT].Filename, ExtraMessage);
156     }
157     else
158     {
159         AslCommonError (Level, MessageId, 0,
160             0, 0, 0, 0, ExtraMessage);
161     }
162 }
163
164
165 /*******************************************************************************
166  *
167  * FUNCTION:    DtFatal
168  *
169  * PARAMETERS:  None
170  *
171  * RETURN:      None
172  *
173  * DESCRIPTION: Dump the error log and abort the compiler. Used for serious
174  *              compile or I/O errors
175  *
176  ******************************************************************************/
177
178 void
179 DtFatal (
180     UINT8                   MessageId,
181     DT_FIELD                *FieldObject,
182     char                    *ExtraMessage)
183 {
184
185     DtError (ASL_ERROR, MessageId, FieldObject, ExtraMessage);
186
187 /*
188  * TBD: remove this entire function, DtFatal
189  *
190  * We cannot abort the compiler on error, because we may be compiling a
191  * list of files. We must move on to the next file.
192  */
193 #ifdef __OBSOLETE
194     CmCleanupAndExit ();
195     exit (1);
196 #endif
197 }
198
199
200 /******************************************************************************
201  *
202  * FUNCTION:    DtStrtoul64
203  *
204  * PARAMETERS:  String              - Null terminated string
205  *              ReturnInteger       - Where the converted integer is returned
206  *
207  * RETURN:      Status
208  *
209  * DESCRIPTION: Simple conversion of a string hex integer constant to unsigned
210  *              value. Assumes no leading "0x" for the constant.
211  *
212  * Portability note: The reason this function exists is because a 64-bit
213  * sscanf is not available in all environments.
214  *
215  *****************************************************************************/
216
217 ACPI_STATUS
218 DtStrtoul64 (
219     char                    *String,
220     UINT64                  *ReturnInteger)
221 {
222     char                    *ThisChar = String;
223     UINT32                  ThisDigit;
224     UINT64                  ReturnValue = 0;
225     int                     DigitCount = 0;
226
227
228     /* Skip over any white space in the buffer */
229
230     while ((*ThisChar == ' ') || (*ThisChar == '\t'))
231     {
232         ThisChar++;
233     }
234
235     /* Skip leading zeros */
236
237     while ((*ThisChar) == '0')
238     {
239         ThisChar++;
240     }
241
242     /* Convert character-by-character */
243
244     while (*ThisChar)
245     {
246         if (ACPI_IS_DIGIT (*ThisChar))
247         {
248             /* Convert ASCII 0-9 to Decimal value */
249
250             ThisDigit = ((UINT8) *ThisChar) - '0';
251         }
252         else /* Letter */
253         {
254             ThisDigit = (UINT32) ACPI_TOUPPER (*ThisChar);
255             if (!ACPI_IS_XDIGIT ((char) ThisDigit))
256             {
257                 /* Not A-F */
258
259                 return (AE_BAD_CHARACTER);
260             }
261
262             /* Convert ASCII Hex char (A-F) to value */
263
264             ThisDigit = (ThisDigit - 'A') + 10;
265         }
266
267         /* Insert the 4-bit hex digit */
268
269         ReturnValue <<= 4;
270         ReturnValue += ThisDigit;
271
272         ThisChar++;
273         DigitCount++;
274         if (DigitCount > 16)
275         {
276             /* Value is too large (> 64 bits/8 bytes/16 hex digits) */
277
278             return (AE_LIMIT);
279         }
280     }
281
282     *ReturnInteger = ReturnValue;
283     return (AE_OK);
284 }
285
286
287 /******************************************************************************
288  *
289  * FUNCTION:    DtGetFieldValue
290  *
291  * PARAMETERS:  Field               - Current field list pointer
292  *
293  * RETURN:      Field value
294  *
295  * DESCRIPTION: Get field value
296  *
297  *****************************************************************************/
298
299 char *
300 DtGetFieldValue (
301     DT_FIELD                *Field)
302 {
303     if (!Field)
304     {
305         return (NULL);
306     }
307
308     return (Field->Value);
309 }
310
311
312 /******************************************************************************
313  *
314  * FUNCTION:    DtGetFieldType
315  *
316  * PARAMETERS:  Info                - Data table info
317  *
318  * RETURN:      Field type
319  *
320  * DESCRIPTION: Get field type
321  *
322  *****************************************************************************/
323
324 UINT8
325 DtGetFieldType (
326     ACPI_DMTABLE_INFO       *Info)
327 {
328     UINT8                   Type;
329
330
331     /* DT_FLAG means that this is the start of a block of flag bits */
332     /* TBD - we can make these a separate opcode later */
333
334     if (Info->Flags & DT_FLAG)
335     {
336         return (DT_FIELD_TYPE_FLAGS_INTEGER);
337     }
338
339     /* Type is based upon the opcode for this field in the info table */
340
341     switch (Info->Opcode)
342     {
343     case ACPI_DMT_FLAG0:
344     case ACPI_DMT_FLAG1:
345     case ACPI_DMT_FLAG2:
346     case ACPI_DMT_FLAG3:
347     case ACPI_DMT_FLAG4:
348     case ACPI_DMT_FLAG5:
349     case ACPI_DMT_FLAG6:
350     case ACPI_DMT_FLAG7:
351     case ACPI_DMT_FLAGS0:
352     case ACPI_DMT_FLAGS1:
353     case ACPI_DMT_FLAGS2:
354     case ACPI_DMT_FLAGS4:
355
356         Type = DT_FIELD_TYPE_FLAG;
357         break;
358
359     case ACPI_DMT_NAME4:
360     case ACPI_DMT_SIG:
361     case ACPI_DMT_NAME6:
362     case ACPI_DMT_NAME8:
363     case ACPI_DMT_STRING:
364
365         Type = DT_FIELD_TYPE_STRING;
366         break;
367
368     case ACPI_DMT_BUFFER:
369     case ACPI_DMT_BUF7:
370     case ACPI_DMT_BUF10:
371     case ACPI_DMT_BUF16:
372     case ACPI_DMT_BUF128:
373     case ACPI_DMT_PCI_PATH:
374
375         Type = DT_FIELD_TYPE_BUFFER;
376         break;
377
378     case ACPI_DMT_GAS:
379     case ACPI_DMT_HESTNTFY:
380
381         Type = DT_FIELD_TYPE_INLINE_SUBTABLE;
382         break;
383
384     case ACPI_DMT_UNICODE:
385
386         Type = DT_FIELD_TYPE_UNICODE;
387         break;
388
389     case ACPI_DMT_UUID:
390
391         Type = DT_FIELD_TYPE_UUID;
392         break;
393
394     case ACPI_DMT_DEVICE_PATH:
395
396         Type = DT_FIELD_TYPE_DEVICE_PATH;
397         break;
398
399     case ACPI_DMT_LABEL:
400
401         Type = DT_FIELD_TYPE_LABEL;
402         break;
403
404     default:
405
406         Type = DT_FIELD_TYPE_INTEGER;
407         break;
408     }
409
410     return (Type);
411 }
412
413
414 /******************************************************************************
415  *
416  * FUNCTION:    DtGetBufferLength
417  *
418  * PARAMETERS:  Buffer              - List of integers,
419  *                                    for example "10 3A 4F 2E"
420  *
421  * RETURN:      Count of integer
422  *
423  * DESCRIPTION: Get length of bytes needed to store the integers
424  *
425  *****************************************************************************/
426
427 UINT32
428 DtGetBufferLength (
429     char                    *Buffer)
430 {
431     UINT32                  ByteLength = 0;
432
433
434     while (*Buffer)
435     {
436         if (*Buffer == ' ')
437         {
438             ByteLength++;
439
440             while (*Buffer == ' ')
441             {
442                 Buffer++;
443             }
444         }
445
446         Buffer++;
447     }
448
449     return (++ByteLength);
450 }
451
452
453 /******************************************************************************
454  *
455  * FUNCTION:    DtGetFieldLength
456  *
457  * PARAMETERS:  Field               - Current field
458  *              Info                - Data table info
459  *
460  * RETURN:      Field length
461  *
462  * DESCRIPTION: Get length of bytes needed to compile the field
463  *
464  * Note: This function must remain in sync with AcpiDmDumpTable.
465  *
466  *****************************************************************************/
467
468 UINT32
469 DtGetFieldLength (
470     DT_FIELD                *Field,
471     ACPI_DMTABLE_INFO       *Info)
472 {
473     UINT32                  ByteLength = 0;
474     char                    *Value;
475
476
477     /* Length is based upon the opcode for this field in the info table */
478
479     switch (Info->Opcode)
480     {
481     case ACPI_DMT_FLAG0:
482     case ACPI_DMT_FLAG1:
483     case ACPI_DMT_FLAG2:
484     case ACPI_DMT_FLAG3:
485     case ACPI_DMT_FLAG4:
486     case ACPI_DMT_FLAG5:
487     case ACPI_DMT_FLAG6:
488     case ACPI_DMT_FLAG7:
489     case ACPI_DMT_FLAGS0:
490     case ACPI_DMT_FLAGS1:
491     case ACPI_DMT_FLAGS2:
492     case ACPI_DMT_FLAGS4:
493     case ACPI_DMT_LABEL:
494     case ACPI_DMT_EXTRA_TEXT:
495
496         ByteLength = 0;
497         break;
498
499     case ACPI_DMT_UINT8:
500     case ACPI_DMT_CHKSUM:
501     case ACPI_DMT_SPACEID:
502     case ACPI_DMT_ACCWIDTH:
503     case ACPI_DMT_IVRS:
504     case ACPI_DMT_MADT:
505     case ACPI_DMT_PCCT:
506     case ACPI_DMT_PMTT:
507     case ACPI_DMT_SRAT:
508     case ACPI_DMT_ASF:
509     case ACPI_DMT_HESTNTYP:
510     case ACPI_DMT_FADTPM:
511     case ACPI_DMT_EINJACT:
512     case ACPI_DMT_EINJINST:
513     case ACPI_DMT_ERSTACT:
514     case ACPI_DMT_ERSTINST:
515
516         ByteLength = 1;
517         break;
518
519     case ACPI_DMT_UINT16:
520     case ACPI_DMT_DMAR:
521     case ACPI_DMT_HEST:
522     case ACPI_DMT_PCI_PATH:
523
524         ByteLength = 2;
525         break;
526
527     case ACPI_DMT_UINT24:
528
529         ByteLength = 3;
530         break;
531
532     case ACPI_DMT_UINT32:
533     case ACPI_DMT_NAME4:
534     case ACPI_DMT_SLIC:
535     case ACPI_DMT_SIG:
536
537         ByteLength = 4;
538         break;
539
540     case ACPI_DMT_UINT40:
541
542         ByteLength = 5;
543         break;
544
545     case ACPI_DMT_UINT48:
546     case ACPI_DMT_NAME6:
547
548         ByteLength = 6;
549         break;
550
551     case ACPI_DMT_UINT56:
552     case ACPI_DMT_BUF7:
553
554         ByteLength = 7;
555         break;
556
557     case ACPI_DMT_UINT64:
558     case ACPI_DMT_NAME8:
559
560         ByteLength = 8;
561         break;
562
563     case ACPI_DMT_STRING:
564
565         Value = DtGetFieldValue (Field);
566         if (Value)
567         {
568             ByteLength = ACPI_STRLEN (Value) + 1;
569         }
570         else
571         {   /* At this point, this is a fatal error */
572
573             sprintf (MsgBuffer, "Expected \"%s\"", Info->Name);
574             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
575             return (0);
576         }
577         break;
578
579     case ACPI_DMT_GAS:
580
581         ByteLength = sizeof (ACPI_GENERIC_ADDRESS);
582         break;
583
584     case ACPI_DMT_HESTNTFY:
585
586         ByteLength = sizeof (ACPI_HEST_NOTIFY);
587         break;
588
589     case ACPI_DMT_BUFFER:
590
591         Value = DtGetFieldValue (Field);
592         if (Value)
593         {
594             ByteLength = DtGetBufferLength (Value);
595         }
596         else
597         {   /* At this point, this is a fatal error */
598
599             sprintf (MsgBuffer, "Expected \"%s\"", Info->Name);
600             DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer);
601             return (0);
602         }
603         break;
604
605     case ACPI_DMT_BUF10:
606
607         ByteLength = 10;
608         break;
609
610     case ACPI_DMT_BUF16:
611     case ACPI_DMT_UUID:
612
613         ByteLength = 16;
614         break;
615
616     case ACPI_DMT_BUF128:
617
618         ByteLength = 128;
619         break;
620
621     case ACPI_DMT_UNICODE:
622
623         Value = DtGetFieldValue (Field);
624
625         /* TBD: error if Value is NULL? (as below?) */
626
627         ByteLength = (ACPI_STRLEN (Value) + 1) * sizeof(UINT16);
628         break;
629
630     default:
631
632         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid table opcode");
633         return (0);
634     }
635
636     return (ByteLength);
637 }
638
639
640 /******************************************************************************
641  *
642  * FUNCTION:    DtSum
643  *
644  * PARAMETERS:  DT_WALK_CALLBACK:
645  *              Subtable            - Subtable
646  *              Context             - Unused
647  *              ReturnValue         - Store the checksum of subtable
648  *
649  * RETURN:      Status
650  *
651  * DESCRIPTION: Get the checksum of subtable
652  *
653  *****************************************************************************/
654
655 static void
656 DtSum (
657     DT_SUBTABLE             *Subtable,
658     void                    *Context,
659     void                    *ReturnValue)
660 {
661     UINT8                   Checksum;
662     UINT8                   *Sum = ReturnValue;
663
664
665     Checksum = AcpiTbChecksum (Subtable->Buffer, Subtable->Length);
666     *Sum = (UINT8) (*Sum + Checksum);
667 }
668
669
670 /******************************************************************************
671  *
672  * FUNCTION:    DtSetTableChecksum
673  *
674  * PARAMETERS:  ChecksumPointer     - Where to return the checksum
675  *
676  * RETURN:      None
677  *
678  * DESCRIPTION: Set checksum of the whole data table into the checksum field
679  *
680  *****************************************************************************/
681
682 void
683 DtSetTableChecksum (
684     UINT8                   *ChecksumPointer)
685 {
686     UINT8                   Checksum = 0;
687     UINT8                   OldSum;
688
689
690     DtWalkTableTree (Gbl_RootTable, DtSum, NULL, &Checksum);
691
692     OldSum = *ChecksumPointer;
693     Checksum = (UINT8) (Checksum - OldSum);
694
695     /* Compute the final checksum */
696
697     Checksum = (UINT8) (0 - Checksum);
698     *ChecksumPointer = Checksum;
699 }
700
701
702 /******************************************************************************
703  *
704  * FUNCTION:    DtSetTableLength
705  *
706  * PARAMETERS:  None
707  *
708  * RETURN:      None
709  *
710  * DESCRIPTION: Walk the subtables and set all the length fields
711  *
712  *****************************************************************************/
713
714 void
715 DtSetTableLength (
716     void)
717 {
718     DT_SUBTABLE             *ParentTable;
719     DT_SUBTABLE             *ChildTable;
720
721
722     ParentTable = Gbl_RootTable;
723     ChildTable = NULL;
724
725     if (!ParentTable)
726     {
727         return;
728     }
729
730     DtSetSubtableLength (ParentTable);
731
732     while (1)
733     {
734         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
735         if (ChildTable)
736         {
737             if (ChildTable->LengthField)
738             {
739                 DtSetSubtableLength (ChildTable);
740             }
741
742             if (ChildTable->Child)
743             {
744                 ParentTable = ChildTable;
745                 ChildTable = NULL;
746             }
747             else
748             {
749                 ParentTable->TotalLength += ChildTable->TotalLength;
750                 if (ParentTable->LengthField)
751                 {
752                     DtSetSubtableLength (ParentTable);
753                 }
754             }
755         }
756         else
757         {
758             ChildTable = ParentTable;
759
760             if (ChildTable == Gbl_RootTable)
761             {
762                 break;
763             }
764
765             ParentTable = DtGetParentSubtable (ParentTable);
766
767             ParentTable->TotalLength += ChildTable->TotalLength;
768             if (ParentTable->LengthField)
769             {
770                 DtSetSubtableLength (ParentTable);
771             }
772         }
773     }
774 }
775
776
777 /******************************************************************************
778  *
779  * FUNCTION:    DtWalkTableTree
780  *
781  * PARAMETERS:  StartTable          - Subtable in the tree where walking begins
782  *              UserFunction        - Called during the walk
783  *              Context             - Passed to user function
784  *              ReturnValue         - The return value of UserFunction
785  *
786  * RETURN:      None
787  *
788  * DESCRIPTION: Performs a depth-first walk of the subtable tree
789  *
790  *****************************************************************************/
791
792 void
793 DtWalkTableTree (
794     DT_SUBTABLE             *StartTable,
795     DT_WALK_CALLBACK        UserFunction,
796     void                    *Context,
797     void                    *ReturnValue)
798 {
799     DT_SUBTABLE             *ParentTable;
800     DT_SUBTABLE             *ChildTable;
801
802
803     ParentTable = StartTable;
804     ChildTable = NULL;
805
806     if (!ParentTable)
807     {
808         return;
809     }
810
811     UserFunction (ParentTable, Context, ReturnValue);
812
813     while (1)
814     {
815         ChildTable = DtGetNextSubtable (ParentTable, ChildTable);
816         if (ChildTable)
817         {
818             UserFunction (ChildTable, Context, ReturnValue);
819
820             if (ChildTable->Child)
821             {
822                 ParentTable = ChildTable;
823                 ChildTable = NULL;
824             }
825         }
826         else
827         {
828             ChildTable = ParentTable;
829             if (ChildTable == Gbl_RootTable)
830             {
831                 break;
832             }
833
834             ParentTable = DtGetParentSubtable (ParentTable);
835
836             if (ChildTable->Peer == StartTable)
837             {
838                 break;
839             }
840         }
841     }
842 }
843
844
845 /******************************************************************************
846  *
847  * FUNCTION:    DtFreeFieldList
848  *
849  * PARAMETERS:  None
850  *
851  * RETURN:      None
852  *
853  * DESCRIPTION: Free the field list
854  *
855  *****************************************************************************/
856
857 void
858 DtFreeFieldList (
859     void)
860 {
861     DT_FIELD                *Field = Gbl_FieldList;
862     DT_FIELD                *NextField;
863
864
865     /* Walk and free entire field list */
866
867     while (Field)
868     {
869         NextField = Field->Next; /* Save link */
870
871         if (!(Field->Flags & DT_FIELD_NOT_ALLOCATED))
872         {
873             ACPI_FREE (Field->Name);
874             ACPI_FREE (Field->Value);
875         }
876
877         ACPI_FREE (Field);
878         Field = NextField;
879     }
880 }