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 UINT16 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 UINT16 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 UINT16 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 case ACPI_DMT_LPIT: 537 538 ByteLength = 4; 539 break; 540 541 case ACPI_DMT_UINT40: 542 543 ByteLength = 5; 544 break; 545 546 case ACPI_DMT_UINT48: 547 case ACPI_DMT_NAME6: 548 549 ByteLength = 6; 550 break; 551 552 case ACPI_DMT_UINT56: 553 case ACPI_DMT_BUF7: 554 555 ByteLength = 7; 556 break; 557 558 case ACPI_DMT_UINT64: 559 case ACPI_DMT_NAME8: 560 561 ByteLength = 8; 562 break; 563 564 case ACPI_DMT_STRING: 565 566 Value = DtGetFieldValue (Field); 567 if (Value) 568 { 569 ByteLength = ACPI_STRLEN (Value) + 1; 570 } 571 else 572 { /* At this point, this is a fatal error */ 573 574 sprintf (MsgBuffer, "Expected \"%s\"", Info->Name); 575 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer); 576 return (0); 577 } 578 break; 579 580 case ACPI_DMT_GAS: 581 582 ByteLength = sizeof (ACPI_GENERIC_ADDRESS); 583 break; 584 585 case ACPI_DMT_HESTNTFY: 586 587 ByteLength = sizeof (ACPI_HEST_NOTIFY); 588 break; 589 590 case ACPI_DMT_BUFFER: 591 592 Value = DtGetFieldValue (Field); 593 if (Value) 594 { 595 ByteLength = DtGetBufferLength (Value); 596 } 597 else 598 { /* At this point, this is a fatal error */ 599 600 sprintf (MsgBuffer, "Expected \"%s\"", Info->Name); 601 DtFatal (ASL_MSG_COMPILER_INTERNAL, NULL, MsgBuffer); 602 return (0); 603 } 604 break; 605 606 case ACPI_DMT_BUF10: 607 608 ByteLength = 10; 609 break; 610 611 case ACPI_DMT_BUF16: 612 case ACPI_DMT_UUID: 613 614 ByteLength = 16; 615 break; 616 617 case ACPI_DMT_BUF128: 618 619 ByteLength = 128; 620 break; 621 622 case ACPI_DMT_UNICODE: 623 624 Value = DtGetFieldValue (Field); 625 626 /* TBD: error if Value is NULL? (as below?) */ 627 628 ByteLength = (ACPI_STRLEN (Value) + 1) * sizeof(UINT16); 629 break; 630 631 default: 632 633 DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid table opcode"); 634 return (0); 635 } 636 637 return (ByteLength); 638 } 639 640 641 /****************************************************************************** 642 * 643 * FUNCTION: DtSum 644 * 645 * PARAMETERS: DT_WALK_CALLBACK: 646 * Subtable - Subtable 647 * Context - Unused 648 * ReturnValue - Store the checksum of subtable 649 * 650 * RETURN: Status 651 * 652 * DESCRIPTION: Get the checksum of subtable 653 * 654 *****************************************************************************/ 655 656 static void 657 DtSum ( 658 DT_SUBTABLE *Subtable, 659 void *Context, 660 void *ReturnValue) 661 { 662 UINT8 Checksum; 663 UINT8 *Sum = ReturnValue; 664 665 666 Checksum = AcpiTbChecksum (Subtable->Buffer, Subtable->Length); 667 *Sum = (UINT8) (*Sum + Checksum); 668 } 669 670 671 /****************************************************************************** 672 * 673 * FUNCTION: DtSetTableChecksum 674 * 675 * PARAMETERS: ChecksumPointer - Where to return the checksum 676 * 677 * RETURN: None 678 * 679 * DESCRIPTION: Set checksum of the whole data table into the checksum field 680 * 681 *****************************************************************************/ 682 683 void 684 DtSetTableChecksum ( 685 UINT8 *ChecksumPointer) 686 { 687 UINT8 Checksum = 0; 688 UINT8 OldSum; 689 690 691 DtWalkTableTree (Gbl_RootTable, DtSum, NULL, &Checksum); 692 693 OldSum = *ChecksumPointer; 694 Checksum = (UINT8) (Checksum - OldSum); 695 696 /* Compute the final checksum */ 697 698 Checksum = (UINT8) (0 - Checksum); 699 *ChecksumPointer = Checksum; 700 } 701 702 703 /****************************************************************************** 704 * 705 * FUNCTION: DtSetTableLength 706 * 707 * PARAMETERS: None 708 * 709 * RETURN: None 710 * 711 * DESCRIPTION: Walk the subtables and set all the length fields 712 * 713 *****************************************************************************/ 714 715 void 716 DtSetTableLength ( 717 void) 718 { 719 DT_SUBTABLE *ParentTable; 720 DT_SUBTABLE *ChildTable; 721 722 723 ParentTable = Gbl_RootTable; 724 ChildTable = NULL; 725 726 if (!ParentTable) 727 { 728 return; 729 } 730 731 DtSetSubtableLength (ParentTable); 732 733 while (1) 734 { 735 ChildTable = DtGetNextSubtable (ParentTable, ChildTable); 736 if (ChildTable) 737 { 738 if (ChildTable->LengthField) 739 { 740 DtSetSubtableLength (ChildTable); 741 } 742 743 if (ChildTable->Child) 744 { 745 ParentTable = ChildTable; 746 ChildTable = NULL; 747 } 748 else 749 { 750 ParentTable->TotalLength += ChildTable->TotalLength; 751 if (ParentTable->LengthField) 752 { 753 DtSetSubtableLength (ParentTable); 754 } 755 } 756 } 757 else 758 { 759 ChildTable = ParentTable; 760 761 if (ChildTable == Gbl_RootTable) 762 { 763 break; 764 } 765 766 ParentTable = DtGetParentSubtable (ParentTable); 767 768 ParentTable->TotalLength += ChildTable->TotalLength; 769 if (ParentTable->LengthField) 770 { 771 DtSetSubtableLength (ParentTable); 772 } 773 } 774 } 775 } 776 777 778 /****************************************************************************** 779 * 780 * FUNCTION: DtWalkTableTree 781 * 782 * PARAMETERS: StartTable - Subtable in the tree where walking begins 783 * UserFunction - Called during the walk 784 * Context - Passed to user function 785 * ReturnValue - The return value of UserFunction 786 * 787 * RETURN: None 788 * 789 * DESCRIPTION: Performs a depth-first walk of the subtable tree 790 * 791 *****************************************************************************/ 792 793 void 794 DtWalkTableTree ( 795 DT_SUBTABLE *StartTable, 796 DT_WALK_CALLBACK UserFunction, 797 void *Context, 798 void *ReturnValue) 799 { 800 DT_SUBTABLE *ParentTable; 801 DT_SUBTABLE *ChildTable; 802 803 804 ParentTable = StartTable; 805 ChildTable = NULL; 806 807 if (!ParentTable) 808 { 809 return; 810 } 811 812 UserFunction (ParentTable, Context, ReturnValue); 813 814 while (1) 815 { 816 ChildTable = DtGetNextSubtable (ParentTable, ChildTable); 817 if (ChildTable) 818 { 819 UserFunction (ChildTable, Context, ReturnValue); 820 821 if (ChildTable->Child) 822 { 823 ParentTable = ChildTable; 824 ChildTable = NULL; 825 } 826 } 827 else 828 { 829 ChildTable = ParentTable; 830 if (ChildTable == Gbl_RootTable) 831 { 832 break; 833 } 834 835 ParentTable = DtGetParentSubtable (ParentTable); 836 837 if (ChildTable->Peer == StartTable) 838 { 839 break; 840 } 841 } 842 } 843 } 844 845 846 /****************************************************************************** 847 * 848 * FUNCTION: DtFreeFieldList 849 * 850 * PARAMETERS: None 851 * 852 * RETURN: None 853 * 854 * DESCRIPTION: Free the field list 855 * 856 *****************************************************************************/ 857 858 void 859 DtFreeFieldList ( 860 void) 861 { 862 DT_FIELD *Field = Gbl_FieldList; 863 DT_FIELD *NextField; 864 865 866 /* Walk and free entire field list */ 867 868 while (Field) 869 { 870 NextField = Field->Next; /* Save link */ 871 872 if (!(Field->Flags & DT_FIELD_NOT_ALLOCATED)) 873 { 874 ACPI_FREE (Field->Name); 875 ACPI_FREE (Field->Value); 876 } 877 878 ACPI_FREE (Field); 879 Field = NextField; 880 } 881 } 882