1 /******************************************************************************* 2 * 3 * Module Name: dmbuffer - AML disassembler, buffer and string support 4 * $Revision: 1.26 $ 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118 #include "acpi.h" 119 #include "acdisasm.h" 120 #include "acparser.h" 121 #include "amlcode.h" 122 123 124 #ifdef ACPI_DISASSEMBLER 125 126 #define _COMPONENT ACPI_CA_DEBUGGER 127 ACPI_MODULE_NAME ("dmbuffer") 128 129 /* Local prototypes */ 130 131 static void 132 AcpiDmUnicode ( 133 ACPI_PARSE_OBJECT *Op); 134 135 136 /******************************************************************************* 137 * 138 * FUNCTION: AcpiDmDisasmByteList 139 * 140 * PARAMETERS: Level - Current source code indentation level 141 * ByteData - Pointer to the byte list 142 * ByteCount - Length of the byte list 143 * 144 * RETURN: None 145 * 146 * DESCRIPTION: Dump an AML "ByteList" in Hex format. 8 bytes per line, prefixed 147 * with the hex buffer offset. 148 * 149 ******************************************************************************/ 150 151 void 152 AcpiDmDisasmByteList ( 153 UINT32 Level, 154 UINT8 *ByteData, 155 UINT32 ByteCount) 156 { 157 UINT32 i; 158 159 160 if (!ByteCount) 161 { 162 return; 163 } 164 165 /* Dump the byte list */ 166 167 for (i = 0; i < ByteCount; i++) 168 { 169 /* New line every 8 bytes */ 170 171 if (((i % 8) == 0) && (i < ByteCount)) 172 { 173 if (i > 0) 174 { 175 AcpiOsPrintf ("\n"); 176 } 177 178 AcpiDmIndent (Level); 179 if (ByteCount > 7) 180 { 181 AcpiOsPrintf ("/* %04X */ ", i); 182 } 183 } 184 185 AcpiOsPrintf ("0x%2.2X", (UINT32) ByteData[i]); 186 187 /* Add comma if there are more bytes to display */ 188 189 if (i < (ByteCount -1)) 190 { 191 AcpiOsPrintf (", "); 192 } 193 } 194 195 if (Level) 196 { 197 AcpiOsPrintf ("\n"); 198 } 199 } 200 201 202 /******************************************************************************* 203 * 204 * FUNCTION: AcpiDmByteList 205 * 206 * PARAMETERS: Info - Parse tree walk info 207 * Op - Byte list op 208 * 209 * RETURN: None 210 * 211 * DESCRIPTION: Dump a buffer byte list, handling the various types of buffers. 212 * Buffer type must be already set in the Op DisasmOpcode. 213 * 214 ******************************************************************************/ 215 216 void 217 AcpiDmByteList ( 218 ACPI_OP_WALK_INFO *Info, 219 ACPI_PARSE_OBJECT *Op) 220 { 221 UINT8 *ByteData; 222 UINT32 ByteCount; 223 224 225 ByteData = Op->Named.Data; 226 ByteCount = (UINT32) Op->Common.Value.Integer; 227 228 /* 229 * The byte list belongs to a buffer, and can be produced by either 230 * a ResourceTemplate, Unicode, quoted string, or a plain byte list. 231 */ 232 switch (Op->Common.Parent->Common.DisasmOpcode) 233 { 234 case ACPI_DASM_RESOURCE: 235 236 AcpiDmResourceTemplate (Info, Op->Common.Parent, ByteData, ByteCount); 237 break; 238 239 case ACPI_DASM_STRING: 240 241 AcpiDmIndent (Info->Level); 242 AcpiUtPrintString ((char *) ByteData, ACPI_UINT8_MAX); 243 AcpiOsPrintf ("\n"); 244 break; 245 246 case ACPI_DASM_UNICODE: 247 248 AcpiDmUnicode (Op); 249 break; 250 251 case ACPI_DASM_BUFFER: 252 default: 253 254 /* 255 * Not a resource, string, or unicode string. 256 * Just dump the buffer 257 */ 258 AcpiDmDisasmByteList (Info->Level, ByteData, ByteCount); 259 break; 260 } 261 } 262 263 264 /******************************************************************************* 265 * 266 * FUNCTION: AcpiDmIsUnicodeBuffer 267 * 268 * PARAMETERS: Op - Buffer Object to be examined 269 * 270 * RETURN: TRUE if buffer contains a UNICODE string 271 * 272 * DESCRIPTION: Determine if a buffer Op contains a Unicode string 273 * 274 ******************************************************************************/ 275 276 BOOLEAN 277 AcpiDmIsUnicodeBuffer ( 278 ACPI_PARSE_OBJECT *Op) 279 { 280 UINT8 *ByteData; 281 UINT32 ByteCount; 282 UINT32 WordCount; 283 ACPI_PARSE_OBJECT *SizeOp; 284 ACPI_PARSE_OBJECT *NextOp; 285 UINT32 i; 286 287 288 /* Buffer size is the buffer argument */ 289 290 SizeOp = Op->Common.Value.Arg; 291 292 /* Next, the initializer byte list to examine */ 293 294 NextOp = SizeOp->Common.Next; 295 if (!NextOp) 296 { 297 return (FALSE); 298 } 299 300 /* Extract the byte list info */ 301 302 ByteData = NextOp->Named.Data; 303 ByteCount = (UINT32) NextOp->Common.Value.Integer; 304 WordCount = ACPI_DIV_2 (ByteCount); 305 306 /* 307 * Unicode string must have an even number of bytes and last 308 * word must be zero 309 */ 310 if ((!ByteCount) || 311 (ByteCount < 4) || 312 (ByteCount & 1) || 313 ((UINT16 *) (void *) ByteData)[WordCount - 1] != 0) 314 { 315 return (FALSE); 316 } 317 318 /* For each word, 1st byte must be ascii, 2nd byte must be zero */ 319 320 for (i = 0; i < (ByteCount - 2); i += 2) 321 { 322 if ((!ACPI_IS_PRINT (ByteData[i])) || 323 (ByteData[(ACPI_SIZE) i + 1] != 0)) 324 { 325 return (FALSE); 326 } 327 } 328 329 /* Ignore the Size argument in the disassembly of this buffer op */ 330 331 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE; 332 return (TRUE); 333 } 334 335 336 /******************************************************************************* 337 * 338 * FUNCTION: AcpiDmIsStringBuffer 339 * 340 * PARAMETERS: Op - Buffer Object to be examined 341 * 342 * RETURN: TRUE if buffer contains a ASCII string, FALSE otherwise 343 * 344 * DESCRIPTION: Determine if a buffer Op contains a ASCII string 345 * 346 ******************************************************************************/ 347 348 BOOLEAN 349 AcpiDmIsStringBuffer ( 350 ACPI_PARSE_OBJECT *Op) 351 { 352 UINT8 *ByteData; 353 UINT32 ByteCount; 354 ACPI_PARSE_OBJECT *SizeOp; 355 ACPI_PARSE_OBJECT *NextOp; 356 UINT32 i; 357 358 359 /* Buffer size is the buffer argument */ 360 361 SizeOp = Op->Common.Value.Arg; 362 363 /* Next, the initializer byte list to examine */ 364 365 NextOp = SizeOp->Common.Next; 366 if (!NextOp) 367 { 368 return (FALSE); 369 } 370 371 /* Extract the byte list info */ 372 373 ByteData = NextOp->Named.Data; 374 ByteCount = (UINT32) NextOp->Common.Value.Integer; 375 376 /* Last byte must be the null terminator */ 377 378 if ((!ByteCount) || 379 (ByteCount < 2) || 380 (ByteData[ByteCount-1] != 0)) 381 { 382 return (FALSE); 383 } 384 385 for (i = 0; i < (ByteCount - 1); i++) 386 { 387 /* TBD: allow some escapes (non-ascii chars). 388 * they will be handled in the string output routine 389 */ 390 391 if (!ACPI_IS_PRINT (ByteData[i])) 392 { 393 return (FALSE); 394 } 395 } 396 397 return (TRUE); 398 } 399 400 401 /******************************************************************************* 402 * 403 * FUNCTION: AcpiDmUnicode 404 * 405 * PARAMETERS: Op - Byte List op containing Unicode string 406 * 407 * RETURN: None 408 * 409 * DESCRIPTION: Dump Unicode string as a standard ASCII string. (Remove 410 * the extra zero bytes). 411 * 412 ******************************************************************************/ 413 414 static void 415 AcpiDmUnicode ( 416 ACPI_PARSE_OBJECT *Op) 417 { 418 UINT16 *WordData; 419 UINT32 WordCount; 420 UINT32 i; 421 422 423 /* Extract the buffer info as a WORD buffer */ 424 425 WordData = ACPI_CAST_PTR (UINT16, Op->Named.Data); 426 WordCount = ACPI_DIV_2 (((UINT32) Op->Common.Value.Integer)); 427 428 429 AcpiOsPrintf ("\""); 430 431 /* Write every other byte as an ASCII character */ 432 433 for (i = 0; i < (WordCount - 1); i++) 434 { 435 AcpiOsPrintf ("%c", (int) WordData[i]); 436 } 437 438 AcpiOsPrintf ("\")"); 439 } 440 441 442 /******************************************************************************* 443 * 444 * FUNCTION: AcpiDmIsEisaIdElement 445 * 446 * PARAMETERS: Op - Op to be examined 447 * 448 * RETURN: None 449 * 450 * DESCRIPTION: Determine if an Op (argument to _HID or _CID) can be converted 451 * to an EISA ID. 452 * 453 ******************************************************************************/ 454 455 void 456 AcpiDmIsEisaIdElement ( 457 ACPI_PARSE_OBJECT *Op) 458 { 459 UINT32 BigEndianId; 460 UINT32 Prefix[3]; 461 UINT32 i; 462 463 464 /* The parameter must be either a word or a dword */ 465 466 if ((Op->Common.AmlOpcode != AML_DWORD_OP) && 467 (Op->Common.AmlOpcode != AML_WORD_OP)) 468 { 469 return; 470 } 471 472 /* Swap from little-endian to big-endian to simplify conversion */ 473 474 BigEndianId = AcpiUtDwordByteSwap ((UINT32) Op->Common.Value.Integer); 475 476 /* Create the 3 leading ASCII letters */ 477 478 Prefix[0] = ((BigEndianId >> 26) & 0x1F) + 0x40; 479 Prefix[1] = ((BigEndianId >> 21) & 0x1F) + 0x40; 480 Prefix[2] = ((BigEndianId >> 16) & 0x1F) + 0x40; 481 482 /* Verify that all 3 are ascii and alpha */ 483 484 for (i = 0; i < 3; i++) 485 { 486 if (!ACPI_IS_ASCII (Prefix[i]) || 487 !ACPI_IS_ALPHA (Prefix[i])) 488 { 489 return; 490 } 491 } 492 493 /* OK - mark this node as convertable to an EISA ID */ 494 495 Op->Common.DisasmOpcode = ACPI_DASM_EISAID; 496 } 497 498 499 /******************************************************************************* 500 * 501 * FUNCTION: AcpiDmIsEisaId 502 * 503 * PARAMETERS: Op - Op to be examined 504 * 505 * RETURN: None 506 * 507 * DESCRIPTION: Determine if a Name() Op can be converted to an EisaId. 508 * 509 ******************************************************************************/ 510 511 void 512 AcpiDmIsEisaId ( 513 ACPI_PARSE_OBJECT *Op) 514 { 515 UINT32 Name; 516 ACPI_PARSE_OBJECT *NextOp; 517 518 519 /* Get the NameSegment */ 520 521 Name = AcpiPsGetName (Op); 522 if (!Name) 523 { 524 return; 525 } 526 527 NextOp = AcpiPsGetDepthNext (NULL, Op); 528 if (!NextOp) 529 { 530 return; 531 } 532 533 /* Check for _HID - has one argument */ 534 535 if (ACPI_COMPARE_NAME (&Name, METHOD_NAME__HID)) 536 { 537 AcpiDmIsEisaIdElement (NextOp); 538 return; 539 } 540 541 /* Exit if not _CID */ 542 543 if (!ACPI_COMPARE_NAME (&Name, METHOD_NAME__CID)) 544 { 545 return; 546 } 547 548 /* _CID can contain a single argument or a package */ 549 550 if (NextOp->Common.AmlOpcode != AML_PACKAGE_OP) 551 { 552 AcpiDmIsEisaIdElement (NextOp); 553 return; 554 } 555 556 /* _CID with Package: get the package length */ 557 558 NextOp = AcpiPsGetDepthNext (NULL, NextOp); 559 560 /* Don't need to use the length, just walk the peer list */ 561 562 NextOp = NextOp->Common.Next; 563 while (NextOp) 564 { 565 AcpiDmIsEisaIdElement (NextOp); 566 NextOp = NextOp->Common.Next; 567 } 568 } 569 570 571 /******************************************************************************* 572 * 573 * FUNCTION: AcpiDmEisaId 574 * 575 * PARAMETERS: EncodedId - Raw encoded EISA ID. 576 * 577 * RETURN: None 578 * 579 * DESCRIPTION: Convert an encoded EISAID back to the original ASCII String. 580 * 581 ******************************************************************************/ 582 583 void 584 AcpiDmEisaId ( 585 UINT32 EncodedId) 586 { 587 UINT32 BigEndianId; 588 589 590 /* Swap from little-endian to big-endian to simplify conversion */ 591 592 BigEndianId = AcpiUtDwordByteSwap (EncodedId); 593 594 595 /* Split to form "AAANNNN" string */ 596 597 AcpiOsPrintf ("EisaId (\"%c%c%c%4.4X\")", 598 599 /* Three Alpha characters (AAA), 5 bits each */ 600 601 (int) ((BigEndianId >> 26) & 0x1F) + 0x40, 602 (int) ((BigEndianId >> 21) & 0x1F) + 0x40, 603 (int) ((BigEndianId >> 16) & 0x1F) + 0x40, 604 605 /* Numeric part (NNNN) is simply the lower 16 bits */ 606 607 (UINT32) (BigEndianId & 0xFFFF)); 608 } 609 610 #endif 611