1 /******************************************************************************* 2 * 3 * Module Name: dmbuffer - AML disassembler, buffer and string support 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2020, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 ***************************************************************************** 115 * 116 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152 #include <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/acutils.h> 155 #include <contrib/dev/acpica/include/acdisasm.h> 156 #include <contrib/dev/acpica/include/acparser.h> 157 #include <contrib/dev/acpica/include/amlcode.h> 158 #include <contrib/dev/acpica/include/acinterp.h> 159 160 161 #define _COMPONENT ACPI_CA_DEBUGGER 162 ACPI_MODULE_NAME ("dmbuffer") 163 164 /* Local prototypes */ 165 166 static void 167 AcpiDmUuid ( 168 ACPI_PARSE_OBJECT *Op); 169 170 static void 171 AcpiDmUnicode ( 172 ACPI_PARSE_OBJECT *Op); 173 174 static void 175 AcpiDmGetHardwareIdType ( 176 ACPI_PARSE_OBJECT *Op); 177 178 static void 179 AcpiDmPldBuffer ( 180 UINT32 Level, 181 UINT8 *ByteData, 182 UINT32 ByteCount); 183 184 static const char * 185 AcpiDmFindNameByIndex ( 186 UINT64 Index, 187 const char **List); 188 189 190 #define ACPI_BUFFER_BYTES_PER_LINE 8 191 192 193 /******************************************************************************* 194 * 195 * FUNCTION: AcpiDmDisasmByteList 196 * 197 * PARAMETERS: Level - Current source code indentation level 198 * ByteData - Pointer to the byte list 199 * ByteCount - Length of the byte list 200 * 201 * RETURN: None 202 * 203 * DESCRIPTION: Dump an AML "ByteList" in Hex format. 8 bytes per line, prefixed 204 * with the hex buffer offset. 205 * 206 ******************************************************************************/ 207 208 void 209 AcpiDmDisasmByteList ( 210 UINT32 Level, 211 UINT8 *ByteData, 212 UINT32 ByteCount) 213 { 214 UINT32 i; 215 UINT32 j; 216 UINT32 CurrentIndex; 217 UINT8 BufChar; 218 219 220 if (!ByteCount) 221 { 222 return; 223 } 224 225 for (i = 0; i < ByteCount; i += ACPI_BUFFER_BYTES_PER_LINE) 226 { 227 /* Line indent and offset prefix for each new line */ 228 229 AcpiDmIndent (Level); 230 if (ByteCount > ACPI_BUFFER_BYTES_PER_LINE) 231 { 232 AcpiOsPrintf ("/* %04X */ ", i); 233 } 234 235 /* Dump the actual hex values */ 236 237 for (j = 0; j < ACPI_BUFFER_BYTES_PER_LINE; j++) 238 { 239 CurrentIndex = i + j; 240 if (CurrentIndex >= ByteCount) 241 { 242 /* Dump fill spaces */ 243 244 AcpiOsPrintf (" "); 245 continue; 246 } 247 248 AcpiOsPrintf (" 0x%2.2X", ByteData[CurrentIndex]); 249 250 /* Add comma if there are more bytes to display */ 251 252 if (CurrentIndex < (ByteCount - 1)) 253 { 254 AcpiOsPrintf (","); 255 } 256 else 257 { 258 AcpiOsPrintf (" "); 259 } 260 } 261 262 /* Dump the ASCII equivalents within a comment */ 263 264 AcpiOsPrintf (" // "); 265 for (j = 0; j < ACPI_BUFFER_BYTES_PER_LINE; j++) 266 { 267 CurrentIndex = i + j; 268 if (CurrentIndex >= ByteCount) 269 { 270 break; 271 } 272 273 BufChar = ByteData[CurrentIndex]; 274 if (isprint (BufChar)) 275 { 276 AcpiOsPrintf ("%c", BufChar); 277 } 278 else 279 { 280 AcpiOsPrintf ("."); 281 } 282 } 283 284 /* Finished with this line */ 285 286 AcpiOsPrintf ("\n"); 287 } 288 } 289 290 291 /******************************************************************************* 292 * 293 * FUNCTION: AcpiDmByteList 294 * 295 * PARAMETERS: Info - Parse tree walk info 296 * Op - Byte list op 297 * 298 * RETURN: None 299 * 300 * DESCRIPTION: Dump a buffer byte list, handling the various types of buffers. 301 * Buffer type must be already set in the Op DisasmOpcode. 302 * 303 ******************************************************************************/ 304 305 void 306 AcpiDmByteList ( 307 ACPI_OP_WALK_INFO *Info, 308 ACPI_PARSE_OBJECT *Op) 309 { 310 UINT8 *ByteData; 311 UINT32 ByteCount; 312 313 314 ByteData = Op->Named.Data; 315 ByteCount = (UINT32) Op->Common.Value.Integer; 316 317 /* 318 * The byte list belongs to a buffer, and can be produced by either 319 * a ResourceTemplate, Unicode, quoted string, or a plain byte list. 320 */ 321 switch (Op->Common.Parent->Common.DisasmOpcode) 322 { 323 case ACPI_DASM_RESOURCE: 324 325 AcpiDmResourceTemplate ( 326 Info, Op->Common.Parent, ByteData, ByteCount); 327 break; 328 329 case ACPI_DASM_STRING: 330 331 AcpiDmIndent (Info->Level); 332 AcpiUtPrintString ((char *) ByteData, ACPI_UINT16_MAX); 333 AcpiOsPrintf ("\n"); 334 break; 335 336 case ACPI_DASM_UUID: 337 338 AcpiDmUuid (Op); 339 break; 340 341 case ACPI_DASM_UNICODE: 342 343 AcpiDmUnicode (Op); 344 break; 345 346 case ACPI_DASM_PLD_METHOD: 347 #if 0 348 AcpiDmDisasmByteList (Info->Level, ByteData, ByteCount); 349 #endif 350 AcpiDmPldBuffer (Info->Level, ByteData, ByteCount); 351 break; 352 353 case ACPI_DASM_BUFFER: 354 default: 355 /* 356 * Not a resource, string, or unicode string. 357 * Just dump the buffer 358 */ 359 AcpiDmDisasmByteList (Info->Level, ByteData, ByteCount); 360 break; 361 } 362 } 363 364 365 /******************************************************************************* 366 * 367 * FUNCTION: AcpiDmIsUuidBuffer 368 * 369 * PARAMETERS: Op - Buffer Object to be examined 370 * 371 * RETURN: TRUE if buffer contains a UUID 372 * 373 * DESCRIPTION: Determine if a buffer Op contains a UUID 374 * 375 * To help determine whether the buffer is a UUID versus a raw data buffer, 376 * there a are a couple bytes we can look at: 377 * 378 * xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx 379 * 380 * The variant covered by the UUID specification is indicated by the two most 381 * significant bits of N being 1 0 (i.e., the hexadecimal N will always be 382 * 8, 9, A, or B). 383 * 384 * The variant covered by the UUID specification has five versions. For this 385 * variant, the four bits of M indicates the UUID version (i.e., the 386 * hexadecimal M will be either 1, 2, 3, 4, or 5). 387 * 388 ******************************************************************************/ 389 390 BOOLEAN 391 AcpiDmIsUuidBuffer ( 392 ACPI_PARSE_OBJECT *Op) 393 { 394 UINT8 *ByteData; 395 UINT32 ByteCount; 396 ACPI_PARSE_OBJECT *SizeOp; 397 ACPI_PARSE_OBJECT *NextOp; 398 399 400 /* Buffer size is the buffer argument */ 401 402 SizeOp = Op->Common.Value.Arg; 403 if (!SizeOp) 404 { 405 return (FALSE); 406 } 407 408 /* Next, the initializer byte list to examine */ 409 410 NextOp = SizeOp->Common.Next; 411 if (!NextOp) 412 { 413 return (FALSE); 414 } 415 416 /* Extract the byte list info */ 417 418 ByteData = NextOp->Named.Data; 419 ByteCount = (UINT32) NextOp->Common.Value.Integer; 420 421 /* Byte count must be exactly 16 */ 422 423 if (ByteCount != UUID_BUFFER_LENGTH) 424 { 425 return (FALSE); 426 } 427 428 /* Check for valid "M" and "N" values (see function header above) */ 429 430 if (((ByteData[7] & 0xF0) == 0x00) || /* M={1,2,3,4,5} */ 431 ((ByteData[7] & 0xF0) > 0x50) || 432 ((ByteData[8] & 0xF0) < 0x80) || /* N={8,9,A,B} */ 433 ((ByteData[8] & 0xF0) > 0xB0)) 434 { 435 return (FALSE); 436 } 437 438 /* Ignore the Size argument in the disassembly of this buffer op */ 439 440 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE; 441 return (TRUE); 442 } 443 444 445 /******************************************************************************* 446 * 447 * FUNCTION: AcpiDmUuid 448 * 449 * PARAMETERS: Op - Byte List op containing a UUID 450 * 451 * RETURN: None 452 * 453 * DESCRIPTION: Dump a buffer containing a UUID as a standard ASCII string. 454 * 455 * Output Format: 456 * In its canonical form, the UUID is represented by a string containing 32 457 * lowercase hexadecimal digits, displayed in 5 groups separated by hyphens. 458 * The complete form is 8-4-4-4-12 for a total of 36 characters (32 459 * alphanumeric characters representing hex digits and 4 hyphens). In bytes, 460 * 4-2-2-2-6. Example: 461 * 462 * ToUUID ("107ededd-d381-4fd7-8da9-08e9a6c79644") 463 * 464 ******************************************************************************/ 465 466 static void 467 AcpiDmUuid ( 468 ACPI_PARSE_OBJECT *Op) 469 { 470 UINT8 *Data; 471 const char *Description; 472 473 474 Data = ACPI_CAST_PTR (UINT8, Op->Named.Data); 475 476 /* Emit the 36-byte UUID string in the proper format/order */ 477 478 AcpiOsPrintf ( 479 "\"%2.2x%2.2x%2.2x%2.2x-" 480 "%2.2x%2.2x-" 481 "%2.2x%2.2x-" 482 "%2.2x%2.2x-" 483 "%2.2x%2.2x%2.2x%2.2x%2.2x%2.2x\")", 484 Data[3], Data[2], Data[1], Data[0], 485 Data[5], Data[4], 486 Data[7], Data[6], 487 Data[8], Data[9], 488 Data[10], Data[11], Data[12], Data[13], Data[14], Data[15]); 489 490 /* Dump the UUID description string if available */ 491 492 Description = AcpiAhMatchUuid (Data); 493 if (Description) 494 { 495 AcpiOsPrintf (" /* %s */", Description); 496 } 497 } 498 499 500 /******************************************************************************* 501 * 502 * FUNCTION: AcpiDmIsUnicodeBuffer 503 * 504 * PARAMETERS: Op - Buffer Object to be examined 505 * 506 * RETURN: TRUE if buffer contains a UNICODE string 507 * 508 * DESCRIPTION: Determine if a buffer Op contains a Unicode string 509 * 510 ******************************************************************************/ 511 512 BOOLEAN 513 AcpiDmIsUnicodeBuffer ( 514 ACPI_PARSE_OBJECT *Op) 515 { 516 UINT8 *ByteData; 517 UINT32 ByteCount; 518 UINT32 WordCount; 519 ACPI_PARSE_OBJECT *SizeOp; 520 ACPI_PARSE_OBJECT *NextOp; 521 UINT32 i; 522 523 524 /* Buffer size is the buffer argument */ 525 526 SizeOp = Op->Common.Value.Arg; 527 if (!SizeOp) 528 { 529 return (FALSE); 530 } 531 532 /* Next, the initializer byte list to examine */ 533 534 NextOp = SizeOp->Common.Next; 535 if (!NextOp) 536 { 537 return (FALSE); 538 } 539 540 /* Extract the byte list info */ 541 542 ByteData = NextOp->Named.Data; 543 ByteCount = (UINT32) NextOp->Common.Value.Integer; 544 WordCount = ACPI_DIV_2 (ByteCount); 545 546 /* 547 * Unicode string must have an even number of bytes and last 548 * word must be zero 549 */ 550 if ((!ByteCount) || 551 (ByteCount < 4) || 552 (ByteCount & 1) || 553 ((UINT16 *) (void *) ByteData)[WordCount - 1] != 0) 554 { 555 return (FALSE); 556 } 557 558 /* 559 * For each word, 1st byte must be printable ascii, and the 560 * 2nd byte must be zero. This does not allow for escape 561 * sequences, but it is the most secure way to detect a 562 * unicode string. 563 */ 564 for (i = 0; i < (ByteCount - 2); i += 2) 565 { 566 if ((ByteData[i] == 0) || 567 !(isprint (ByteData[i])) || 568 (ByteData[(ACPI_SIZE) i + 1] != 0)) 569 { 570 return (FALSE); 571 } 572 } 573 574 /* Ignore the Size argument in the disassembly of this buffer op */ 575 576 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE; 577 return (TRUE); 578 } 579 580 581 /******************************************************************************* 582 * 583 * FUNCTION: AcpiDmIsStringBuffer 584 * 585 * PARAMETERS: Op - Buffer Object to be examined 586 * 587 * RETURN: TRUE if buffer contains a ASCII string, FALSE otherwise 588 * 589 * DESCRIPTION: Determine if a buffer Op contains a ASCII string 590 * 591 ******************************************************************************/ 592 593 BOOLEAN 594 AcpiDmIsStringBuffer ( 595 ACPI_PARSE_OBJECT *Op) 596 { 597 UINT8 *ByteData; 598 UINT32 ByteCount; 599 ACPI_PARSE_OBJECT *SizeOp; 600 ACPI_PARSE_OBJECT *NextOp; 601 UINT32 i; 602 603 604 /* Buffer size is the buffer argument */ 605 606 SizeOp = Op->Common.Value.Arg; 607 if (!SizeOp) 608 { 609 return (FALSE); 610 } 611 612 /* Next, the initializer byte list to examine */ 613 614 NextOp = SizeOp->Common.Next; 615 if (!NextOp) 616 { 617 return (FALSE); 618 } 619 620 /* Extract the byte list info */ 621 622 ByteData = NextOp->Named.Data; 623 ByteCount = (UINT32) NextOp->Common.Value.Integer; 624 625 /* Last byte must be the null terminator */ 626 627 if ((!ByteCount) || 628 (ByteCount < 2) || 629 (ByteData[ByteCount-1] != 0)) 630 { 631 return (FALSE); 632 } 633 634 /* 635 * Check for a possible standalone resource EndTag, ignore it 636 * here. However, this sequence is also the string "Y", but 637 * this seems rare enough to be acceptable. 638 */ 639 if ((ByteCount == 2) && (ByteData[0] == 0x79)) 640 { 641 return (FALSE); 642 } 643 644 /* Check all bytes for ASCII */ 645 646 for (i = 0; i < (ByteCount - 1); i++) 647 { 648 /* 649 * TBD: allow some escapes (non-ascii chars). 650 * they will be handled in the string output routine 651 */ 652 653 /* Not a string if not printable ascii */ 654 655 if (!isprint (ByteData[i])) 656 { 657 return (FALSE); 658 } 659 } 660 661 return (TRUE); 662 } 663 664 665 /******************************************************************************* 666 * 667 * FUNCTION: AcpiDmIsPldBuffer 668 * 669 * PARAMETERS: Op - Buffer Object to be examined 670 * 671 * RETURN: TRUE if buffer appears to contain data produced via the 672 * ToPLD macro, FALSE otherwise 673 * 674 * DESCRIPTION: Determine if a buffer Op contains a _PLD structure 675 * 676 ******************************************************************************/ 677 678 BOOLEAN 679 AcpiDmIsPldBuffer ( 680 ACPI_PARSE_OBJECT *Op) 681 { 682 ACPI_NAMESPACE_NODE *Node; 683 ACPI_PARSE_OBJECT *SizeOp; 684 ACPI_PARSE_OBJECT *ByteListOp; 685 ACPI_PARSE_OBJECT *ParentOp; 686 UINT64 BufferSize; 687 UINT64 InitializerSize; 688 689 690 if (!Op) 691 { 692 return (FALSE); 693 } 694 695 /* 696 * Get the BufferSize argument - Buffer(BufferSize) 697 * If the buffer was generated by the ToPld macro, it must 698 * be a BYTE constant. 699 */ 700 SizeOp = Op->Common.Value.Arg; 701 if (!SizeOp || SizeOp->Common.AmlOpcode != AML_BYTE_OP) 702 { 703 return (FALSE); 704 } 705 706 /* Check the declared BufferSize, two possibilities */ 707 708 BufferSize = SizeOp->Common.Value.Integer; 709 if ((BufferSize != ACPI_PLD_REV1_BUFFER_SIZE) && 710 (BufferSize != ACPI_PLD_REV2_BUFFER_SIZE)) 711 { 712 return (FALSE); 713 } 714 715 /* 716 * Check the initializer list length. This is the actual 717 * number of bytes in the buffer as counted by the AML parser. 718 * The declared BufferSize can be larger than the actual length. 719 * However, for the ToPLD macro, the BufferSize will be the same 720 * as the initializer list length. 721 */ 722 ByteListOp = SizeOp->Common.Next; 723 if (!ByteListOp) 724 { 725 return (FALSE); /* Zero-length buffer case */ 726 } 727 728 InitializerSize = ByteListOp->Common.Value.Integer; 729 if ((InitializerSize != ACPI_PLD_REV1_BUFFER_SIZE) && 730 (InitializerSize != ACPI_PLD_REV2_BUFFER_SIZE)) 731 { 732 return (FALSE); 733 } 734 735 /* Final size check */ 736 737 if (BufferSize != InitializerSize) 738 { 739 return (FALSE); 740 } 741 742 /* Now examine the buffer parent */ 743 744 ParentOp = Op->Common.Parent; 745 if (!ParentOp) 746 { 747 return (FALSE); 748 } 749 750 /* Check for form: Name(_PLD, Buffer() {}). Not legal, however */ 751 752 if (ParentOp->Common.AmlOpcode == AML_NAME_OP) 753 { 754 Node = ParentOp->Common.Node; 755 756 if (ACPI_COMPARE_NAMESEG (Node->Name.Ascii, METHOD_NAME__PLD)) 757 { 758 /* Ignore the Size argument in the disassembly of this buffer op */ 759 760 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE; 761 return (TRUE); 762 } 763 764 return (FALSE); 765 } 766 767 /* 768 * Check for proper form: Name(_PLD, Package() {ToPLD()}) 769 * 770 * Note: All other forms such as 771 * Return (Package() {ToPLD()}) 772 * Local0 = ToPLD() 773 * etc. are not converted back to the ToPLD macro, because 774 * there is really no deterministic way to disassemble the buffer 775 * back to the ToPLD macro, other than trying to find the "_PLD" 776 * name 777 */ 778 if (ParentOp->Common.AmlOpcode == AML_PACKAGE_OP) 779 { 780 ParentOp = ParentOp->Common.Parent; 781 if (!ParentOp) 782 { 783 return (FALSE); 784 } 785 786 if (ParentOp->Common.AmlOpcode == AML_NAME_OP) 787 { 788 Node = ParentOp->Common.Node; 789 790 if (ACPI_COMPARE_NAMESEG (Node->Name.Ascii, METHOD_NAME__PLD)) 791 { 792 /* Ignore the Size argument in the disassembly of this buffer op */ 793 794 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE; 795 return (TRUE); 796 } 797 } 798 } 799 800 return (FALSE); 801 } 802 803 804 /******************************************************************************* 805 * 806 * FUNCTION: AcpiDmFindNameByIndex 807 * 808 * PARAMETERS: Index - Index of array to check 809 * List - Array to reference 810 * 811 * RETURN: String from List or empty string 812 * 813 * DESCRIPTION: Finds and returns the char string located at the given index 814 * position in List. 815 * 816 ******************************************************************************/ 817 818 static const char * 819 AcpiDmFindNameByIndex ( 820 UINT64 Index, 821 const char **List) 822 { 823 const char *NameString; 824 UINT32 i; 825 826 827 /* Bounds check */ 828 829 NameString = List[0]; 830 i = 0; 831 832 while (NameString) 833 { 834 i++; 835 NameString = List[i]; 836 } 837 838 if (Index >= i) 839 { 840 /* TBD: Add error msg */ 841 842 return (""); 843 } 844 845 return (List[Index]); 846 } 847 848 849 /******************************************************************************* 850 * 851 * FUNCTION: AcpiDmPldBuffer 852 * 853 * PARAMETERS: Level - Current source code indentation level 854 * ByteData - Pointer to the byte list 855 * ByteCount - Length of the byte list 856 * 857 * RETURN: None 858 * 859 * DESCRIPTION: Dump and format the contents of a _PLD buffer object 860 * 861 ******************************************************************************/ 862 863 #define ACPI_PLD_OUTPUT08 "%*.s%-22s = 0x%X,\n", ACPI_MUL_4 (Level), " " 864 #define ACPI_PLD_OUTPUT08P "%*.s%-22s = 0x%X)\n", ACPI_MUL_4 (Level), " " 865 #define ACPI_PLD_OUTPUT16 "%*.s%-22s = 0x%X,\n", ACPI_MUL_4 (Level), " " 866 #define ACPI_PLD_OUTPUT16P "%*.s%-22s = 0x%X)\n", ACPI_MUL_4 (Level), " " 867 #define ACPI_PLD_OUTPUT24 "%*.s%-22s = 0x%X,\n", ACPI_MUL_4 (Level), " " 868 #define ACPI_PLD_OUTPUTSTR "%*.s%-22s = \"%s\",\n", ACPI_MUL_4 (Level), " " 869 870 static void 871 AcpiDmPldBuffer ( 872 UINT32 Level, 873 UINT8 *ByteData, 874 UINT32 ByteCount) 875 { 876 ACPI_PLD_INFO *PldInfo; 877 ACPI_STATUS Status; 878 879 880 /* Check for valid byte count */ 881 882 if (ByteCount < ACPI_PLD_REV1_BUFFER_SIZE) 883 { 884 return; 885 } 886 887 /* Convert _PLD buffer to local _PLD struct */ 888 889 Status = AcpiDecodePldBuffer (ByteData, ByteCount, &PldInfo); 890 if (ACPI_FAILURE (Status)) 891 { 892 return; 893 } 894 895 AcpiOsPrintf ("\n"); 896 897 /* First 32-bit dword */ 898 899 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Revision", PldInfo->Revision); 900 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_IgnoreColor", PldInfo->IgnoreColor); 901 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Red", PldInfo->Red); 902 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Green", PldInfo->Green); 903 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Blue", PldInfo->Blue); 904 905 /* Second 32-bit dword */ 906 907 AcpiOsPrintf (ACPI_PLD_OUTPUT16, "PLD_Width", PldInfo->Width); 908 AcpiOsPrintf (ACPI_PLD_OUTPUT16, "PLD_Height", PldInfo->Height); 909 910 /* Third 32-bit dword */ 911 912 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_UserVisible", PldInfo->UserVisible); 913 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Dock", PldInfo->Dock); 914 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Lid", PldInfo->Lid); 915 AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_Panel", 916 AcpiDmFindNameByIndex(PldInfo->Panel, AcpiGbl_PldPanelList)); 917 918 AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_VerticalPosition", 919 AcpiDmFindNameByIndex(PldInfo->VerticalPosition, AcpiGbl_PldVerticalPositionList)); 920 921 AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_HorizontalPosition", 922 AcpiDmFindNameByIndex(PldInfo->HorizontalPosition, AcpiGbl_PldHorizontalPositionList)); 923 924 AcpiOsPrintf (ACPI_PLD_OUTPUTSTR, "PLD_Shape", 925 AcpiDmFindNameByIndex(PldInfo->Shape, AcpiGbl_PldShapeList)); 926 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_GroupOrientation", PldInfo->GroupOrientation); 927 928 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_GroupToken", PldInfo->GroupToken); 929 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_GroupPosition", PldInfo->GroupPosition); 930 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Bay", PldInfo->Bay); 931 932 /* Fourth 32-bit dword */ 933 934 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Ejectable", PldInfo->Ejectable); 935 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_EjectRequired", PldInfo->OspmEjectRequired); 936 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_CabinetNumber", PldInfo->CabinetNumber); 937 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_CardCageNumber", PldInfo->CardCageNumber); 938 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Reference", PldInfo->Reference); 939 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Rotation", PldInfo->Rotation); 940 941 if (ByteCount >= ACPI_PLD_REV2_BUFFER_SIZE) 942 { 943 AcpiOsPrintf (ACPI_PLD_OUTPUT08, "PLD_Order", PldInfo->Order); 944 945 /* Fifth 32-bit dword */ 946 947 AcpiOsPrintf (ACPI_PLD_OUTPUT16, "PLD_VerticalOffset", PldInfo->VerticalOffset); 948 AcpiOsPrintf (ACPI_PLD_OUTPUT16P, "PLD_HorizontalOffset", PldInfo->HorizontalOffset); 949 } 950 else /* Rev 1 buffer */ 951 { 952 AcpiOsPrintf (ACPI_PLD_OUTPUT08P, "PLD_Order", PldInfo->Order); 953 } 954 955 ACPI_FREE (PldInfo); 956 } 957 958 959 /******************************************************************************* 960 * 961 * FUNCTION: AcpiDmUnicode 962 * 963 * PARAMETERS: Op - Byte List op containing Unicode string 964 * 965 * RETURN: None 966 * 967 * DESCRIPTION: Dump Unicode string as a standard ASCII string. (Remove 968 * the extra zero bytes). 969 * 970 ******************************************************************************/ 971 972 static void 973 AcpiDmUnicode ( 974 ACPI_PARSE_OBJECT *Op) 975 { 976 UINT16 *WordData; 977 UINT32 WordCount; 978 UINT32 i; 979 int OutputValue; 980 981 982 /* Extract the buffer info as a WORD buffer */ 983 984 WordData = ACPI_CAST_PTR (UINT16, Op->Named.Data); 985 WordCount = ACPI_DIV_2 (((UINT32) Op->Common.Value.Integer)); 986 987 /* Write every other byte as an ASCII character */ 988 989 AcpiOsPrintf ("\""); 990 for (i = 0; i < (WordCount - 1); i++) 991 { 992 OutputValue = (int) WordData[i]; 993 994 /* Handle values that must be escaped */ 995 996 if ((OutputValue == '\"') || 997 (OutputValue == '\\')) 998 { 999 AcpiOsPrintf ("\\%c", OutputValue); 1000 } 1001 else if (!isprint (OutputValue)) 1002 { 1003 AcpiOsPrintf ("\\x%2.2X", OutputValue); 1004 } 1005 else 1006 { 1007 AcpiOsPrintf ("%c", OutputValue); 1008 } 1009 } 1010 1011 AcpiOsPrintf ("\")"); 1012 } 1013 1014 1015 /******************************************************************************* 1016 * 1017 * FUNCTION: AcpiDmGetHardwareIdType 1018 * 1019 * PARAMETERS: Op - Op to be examined 1020 * 1021 * RETURN: None 1022 * 1023 * DESCRIPTION: Determine the type of the argument to a _HID or _CID 1024 * 1) Strings are allowed 1025 * 2) If Integer, determine if it is a valid EISAID 1026 * 1027 ******************************************************************************/ 1028 1029 static void 1030 AcpiDmGetHardwareIdType ( 1031 ACPI_PARSE_OBJECT *Op) 1032 { 1033 UINT32 BigEndianId; 1034 UINT32 Prefix[3]; 1035 UINT32 i; 1036 1037 1038 switch (Op->Common.AmlOpcode) 1039 { 1040 case AML_STRING_OP: 1041 1042 /* Mark this string as an _HID/_CID string */ 1043 1044 Op->Common.DisasmOpcode = ACPI_DASM_HID_STRING; 1045 break; 1046 1047 case AML_WORD_OP: 1048 case AML_DWORD_OP: 1049 1050 /* Determine if a Word/Dword is a valid encoded EISAID */ 1051 1052 /* Swap from little-endian to big-endian to simplify conversion */ 1053 1054 BigEndianId = AcpiUtDwordByteSwap ((UINT32) Op->Common.Value.Integer); 1055 1056 /* Create the 3 leading ASCII letters */ 1057 1058 Prefix[0] = ((BigEndianId >> 26) & 0x1F) + 0x40; 1059 Prefix[1] = ((BigEndianId >> 21) & 0x1F) + 0x40; 1060 Prefix[2] = ((BigEndianId >> 16) & 0x1F) + 0x40; 1061 1062 /* Verify that all 3 are ascii and alpha */ 1063 1064 for (i = 0; i < 3; i++) 1065 { 1066 if (!ACPI_IS_ASCII (Prefix[i]) || 1067 !isalpha (Prefix[i])) 1068 { 1069 return; 1070 } 1071 } 1072 1073 /* Mark this node as convertible to an EISA ID string */ 1074 1075 Op->Common.DisasmOpcode = ACPI_DASM_EISAID; 1076 break; 1077 1078 default: 1079 break; 1080 } 1081 } 1082 1083 1084 /******************************************************************************* 1085 * 1086 * FUNCTION: AcpiDmCheckForHardwareId 1087 * 1088 * PARAMETERS: Op - Op to be examined 1089 * 1090 * RETURN: None 1091 * 1092 * DESCRIPTION: Determine if a Name() Op is a _HID/_CID. 1093 * 1094 ******************************************************************************/ 1095 1096 void 1097 AcpiDmCheckForHardwareId ( 1098 ACPI_PARSE_OBJECT *Op) 1099 { 1100 UINT32 Name; 1101 ACPI_PARSE_OBJECT *NextOp; 1102 1103 1104 /* Get the NameSegment */ 1105 1106 Name = AcpiPsGetName (Op); 1107 if (!Name) 1108 { 1109 return; 1110 } 1111 1112 NextOp = AcpiPsGetDepthNext (NULL, Op); 1113 if (!NextOp) 1114 { 1115 return; 1116 } 1117 1118 /* Check for _HID - has one argument */ 1119 1120 if (ACPI_COMPARE_NAMESEG (&Name, METHOD_NAME__HID)) 1121 { 1122 AcpiDmGetHardwareIdType (NextOp); 1123 return; 1124 } 1125 1126 /* Exit if not _CID */ 1127 1128 if (!ACPI_COMPARE_NAMESEG (&Name, METHOD_NAME__CID)) 1129 { 1130 return; 1131 } 1132 1133 /* _CID can contain a single argument or a package */ 1134 1135 if (NextOp->Common.AmlOpcode != AML_PACKAGE_OP) 1136 { 1137 AcpiDmGetHardwareIdType (NextOp); 1138 return; 1139 } 1140 1141 /* _CID with Package: get the package length, check all elements */ 1142 1143 NextOp = AcpiPsGetDepthNext (NULL, NextOp); 1144 if (!NextOp) 1145 { 1146 return; 1147 } 1148 1149 /* Don't need to use the length, just walk the peer list */ 1150 1151 NextOp = NextOp->Common.Next; 1152 while (NextOp) 1153 { 1154 AcpiDmGetHardwareIdType (NextOp); 1155 NextOp = NextOp->Common.Next; 1156 } 1157 } 1158 1159 1160 /******************************************************************************* 1161 * 1162 * FUNCTION: AcpiDmDecompressEisaId 1163 * 1164 * PARAMETERS: EncodedId - Raw encoded EISA ID. 1165 * 1166 * RETURN: None 1167 * 1168 * DESCRIPTION: Convert an encoded EISAID back to the original ASCII String 1169 * and emit the correct ASL statement. If the ID is known, emit 1170 * a description of the ID as a comment. 1171 * 1172 ******************************************************************************/ 1173 1174 void 1175 AcpiDmDecompressEisaId ( 1176 UINT32 EncodedId) 1177 { 1178 char IdBuffer[ACPI_EISAID_STRING_SIZE]; 1179 const AH_DEVICE_ID *Info; 1180 1181 1182 /* Convert EISAID to a string an emit the statement */ 1183 1184 AcpiExEisaIdToString (IdBuffer, EncodedId); 1185 AcpiOsPrintf ("EisaId (\"%s\")", IdBuffer); 1186 1187 /* If we know about the ID, emit the description */ 1188 1189 Info = AcpiAhMatchHardwareId (IdBuffer); 1190 if (Info) 1191 { 1192 AcpiOsPrintf (" /* %s */", Info->Description); 1193 } 1194 } 1195