1 /******************************************************************************* 2 * 3 * Module Name: dmbuffer - AML disassembler, buffer and string support 4 * $Revision: 1.22 $ 5 * 6 ******************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2006, 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 147 * 148 ******************************************************************************/ 149 150 void 151 AcpiDmDisasmByteList ( 152 UINT32 Level, 153 UINT8 *ByteData, 154 UINT32 ByteCount) 155 { 156 UINT32 i; 157 158 159 if (!ByteCount) 160 { 161 return; 162 } 163 164 AcpiDmIndent (Level); 165 166 /* Dump the byte list */ 167 168 for (i = 0; i < ByteCount; i++) 169 { 170 AcpiOsPrintf ("0x%2.2X", (UINT32) ByteData[i]); 171 172 /* Add comma if there are more bytes to display */ 173 174 if (i < (ByteCount -1)) 175 { 176 AcpiOsPrintf (", "); 177 } 178 179 /* New line every 8 bytes */ 180 181 if ((((i+1) % 8) == 0) && ((i+1) < ByteCount)) 182 { 183 AcpiOsPrintf ("\n"); 184 AcpiDmIndent (Level); 185 } 186 } 187 188 if (Level) 189 { 190 AcpiOsPrintf ("\n"); 191 } 192 } 193 194 195 /******************************************************************************* 196 * 197 * FUNCTION: AcpiDmByteList 198 * 199 * PARAMETERS: Info - Parse tree walk info 200 * Op - Byte list op 201 * 202 * RETURN: None 203 * 204 * DESCRIPTION: Dump a buffer byte list, handling the various types of buffers. 205 * Buffer type must be already set in the Op DisasmOpcode. 206 * 207 ******************************************************************************/ 208 209 void 210 AcpiDmByteList ( 211 ACPI_OP_WALK_INFO *Info, 212 ACPI_PARSE_OBJECT *Op) 213 { 214 UINT8 *ByteData; 215 UINT32 ByteCount; 216 217 218 ByteData = Op->Named.Data; 219 ByteCount = (UINT32) Op->Common.Value.Integer; 220 221 /* 222 * The byte list belongs to a buffer, and can be produced by either 223 * a ResourceTemplate, Unicode, quoted string, or a plain byte list. 224 */ 225 switch (Op->Common.Parent->Common.DisasmOpcode) 226 { 227 case ACPI_DASM_RESOURCE: 228 229 AcpiDmResourceTemplate (Info, Op->Common.Parent, ByteData, ByteCount); 230 break; 231 232 case ACPI_DASM_STRING: 233 234 AcpiDmIndent (Info->Level); 235 AcpiUtPrintString ((char *) ByteData, ACPI_UINT8_MAX); 236 AcpiOsPrintf ("\n"); 237 break; 238 239 case ACPI_DASM_UNICODE: 240 241 AcpiDmUnicode (Op); 242 break; 243 244 case ACPI_DASM_BUFFER: 245 default: 246 247 /* 248 * Not a resource, string, or unicode string. 249 * Just dump the buffer 250 */ 251 AcpiDmDisasmByteList (Info->Level, ByteData, ByteCount); 252 break; 253 } 254 } 255 256 257 /******************************************************************************* 258 * 259 * FUNCTION: AcpiDmIsUnicodeBuffer 260 * 261 * PARAMETERS: Op - Buffer Object to be examined 262 * 263 * RETURN: TRUE if buffer contains a UNICODE string 264 * 265 * DESCRIPTION: Determine if a buffer Op contains a Unicode string 266 * 267 ******************************************************************************/ 268 269 BOOLEAN 270 AcpiDmIsUnicodeBuffer ( 271 ACPI_PARSE_OBJECT *Op) 272 { 273 UINT8 *ByteData; 274 UINT32 ByteCount; 275 UINT32 WordCount; 276 ACPI_PARSE_OBJECT *SizeOp; 277 ACPI_PARSE_OBJECT *NextOp; 278 ACPI_NATIVE_UINT i; 279 280 281 /* Buffer size is the buffer argument */ 282 283 SizeOp = Op->Common.Value.Arg; 284 285 /* Next, the initializer byte list to examine */ 286 287 NextOp = SizeOp->Common.Next; 288 if (!NextOp) 289 { 290 return (FALSE); 291 } 292 293 /* Extract the byte list info */ 294 295 ByteData = NextOp->Named.Data; 296 ByteCount = (UINT32) NextOp->Common.Value.Integer; 297 WordCount = ACPI_DIV_2 (ByteCount); 298 299 /* 300 * Unicode string must have an even number of bytes and last 301 * word must be zero 302 */ 303 if ((!ByteCount) || 304 (ByteCount < 4) || 305 (ByteCount & 1) || 306 ((UINT16 *) (void *) ByteData)[WordCount - 1] != 0) 307 { 308 return (FALSE); 309 } 310 311 /* For each word, 1st byte must be ascii, 2nd byte must be zero */ 312 313 for (i = 0; i < (ByteCount - 2); i += 2) 314 { 315 if ((!ACPI_IS_PRINT (ByteData[i])) || 316 (ByteData[i + 1] != 0)) 317 { 318 return (FALSE); 319 } 320 } 321 322 /* Ignore the Size argument in the disassembly of this buffer op */ 323 324 SizeOp->Common.DisasmFlags |= ACPI_PARSEOP_IGNORE; 325 return (TRUE); 326 } 327 328 329 /******************************************************************************* 330 * 331 * FUNCTION: AcpiDmIsStringBuffer 332 * 333 * PARAMETERS: Op - Buffer Object to be examined 334 * 335 * RETURN: TRUE if buffer contains a ASCII string, FALSE otherwise 336 * 337 * DESCRIPTION: Determine if a buffer Op contains a ASCII string 338 * 339 ******************************************************************************/ 340 341 BOOLEAN 342 AcpiDmIsStringBuffer ( 343 ACPI_PARSE_OBJECT *Op) 344 { 345 UINT8 *ByteData; 346 UINT32 ByteCount; 347 ACPI_PARSE_OBJECT *SizeOp; 348 ACPI_PARSE_OBJECT *NextOp; 349 UINT32 i; 350 351 352 /* Buffer size is the buffer argument */ 353 354 SizeOp = Op->Common.Value.Arg; 355 356 /* Next, the initializer byte list to examine */ 357 358 NextOp = SizeOp->Common.Next; 359 if (!NextOp) 360 { 361 return (FALSE); 362 } 363 364 /* Extract the byte list info */ 365 366 ByteData = NextOp->Named.Data; 367 ByteCount = (UINT32) NextOp->Common.Value.Integer; 368 369 /* Last byte must be the null terminator */ 370 371 if ((!ByteCount) || 372 (ByteCount < 2) || 373 (ByteData[ByteCount-1] != 0)) 374 { 375 return (FALSE); 376 } 377 378 for (i = 0; i < (ByteCount - 1); i++) 379 { 380 /* TBD: allow some escapes (non-ascii chars). 381 * they will be handled in the string output routine 382 */ 383 384 if (!ACPI_IS_PRINT (ByteData[i])) 385 { 386 return (FALSE); 387 } 388 } 389 390 return (TRUE); 391 } 392 393 394 /******************************************************************************* 395 * 396 * FUNCTION: AcpiDmUnicode 397 * 398 * PARAMETERS: Op - Byte List op containing Unicode string 399 * 400 * RETURN: None 401 * 402 * DESCRIPTION: Dump Unicode string as a standard ASCII string. (Remove 403 * the extra zero bytes). 404 * 405 ******************************************************************************/ 406 407 static void 408 AcpiDmUnicode ( 409 ACPI_PARSE_OBJECT *Op) 410 { 411 UINT16 *WordData; 412 UINT32 WordCount; 413 UINT32 i; 414 415 416 /* Extract the buffer info as a WORD buffer */ 417 418 WordData = ACPI_CAST_PTR (UINT16, Op->Named.Data); 419 WordCount = ACPI_DIV_2 (((UINT32) Op->Common.Value.Integer)); 420 421 422 AcpiOsPrintf ("\""); 423 424 /* Write every other byte as an ASCII character */ 425 426 for (i = 0; i < (WordCount - 1); i++) 427 { 428 AcpiOsPrintf ("%c", (int) WordData[i]); 429 } 430 431 AcpiOsPrintf ("\")"); 432 } 433 434 435 /******************************************************************************* 436 * 437 * FUNCTION: AcpiDmIsEisaId 438 * 439 * PARAMETERS: Op - Op to be examined 440 * 441 * RETURN: None 442 * 443 * DESCRIPTION: Determine if an Op can be converted to an EisaId. 444 * 445 ******************************************************************************/ 446 447 void 448 AcpiDmIsEisaId ( 449 ACPI_PARSE_OBJECT *Op) 450 { 451 UINT32 Name; 452 UINT32 BigEndianId; 453 ACPI_PARSE_OBJECT *NextOp; 454 ACPI_NATIVE_UINT i; 455 UINT32 Prefix[3]; 456 457 458 /* Get the NameSegment */ 459 460 Name = AcpiPsGetName (Op); 461 if (!Name) 462 { 463 return; 464 } 465 466 /* We are looking for _HID */ 467 468 if (!ACPI_COMPARE_NAME (&Name, METHOD_NAME__HID)) 469 { 470 return; 471 } 472 473 /* The parameter must be either a word or a dword */ 474 475 NextOp = AcpiPsGetDepthNext (NULL, Op); 476 if ((NextOp->Common.AmlOpcode != AML_DWORD_OP) && 477 (NextOp->Common.AmlOpcode != AML_WORD_OP)) 478 { 479 return; 480 } 481 482 /* Swap from little-endian to big-endian to simplify conversion */ 483 484 BigEndianId = AcpiUtDwordByteSwap ((UINT32) NextOp->Common.Value.Integer); 485 486 /* Create the 3 leading ASCII letters */ 487 488 Prefix[0] = ((BigEndianId >> 26) & 0x1F) + 0x40; 489 Prefix[1] = ((BigEndianId >> 21) & 0x1F) + 0x40; 490 Prefix[2] = ((BigEndianId >> 16) & 0x1F) + 0x40; 491 492 /* Verify that all 3 are ascii and alpha */ 493 494 for (i = 0; i < 3; i++) 495 { 496 if (!ACPI_IS_ASCII (Prefix[i]) || 497 !ACPI_IS_ALPHA (Prefix[i])) 498 { 499 return; 500 } 501 } 502 503 /* OK - mark this node as convertable to an EISA ID */ 504 505 NextOp->Common.DisasmOpcode = ACPI_DASM_EISAID; 506 } 507 508 509 /******************************************************************************* 510 * 511 * FUNCTION: AcpiDmEisaId 512 * 513 * PARAMETERS: EncodedId - Raw encoded EISA ID. 514 * 515 * RETURN: None 516 * 517 * DESCRIPTION: Convert an encoded EISAID back to the original ASCII String. 518 * 519 ******************************************************************************/ 520 521 void 522 AcpiDmEisaId ( 523 UINT32 EncodedId) 524 { 525 UINT32 BigEndianId; 526 527 528 /* Swap from little-endian to big-endian to simplify conversion */ 529 530 BigEndianId = AcpiUtDwordByteSwap (EncodedId); 531 532 533 /* Split to form "AAANNNN" string */ 534 535 AcpiOsPrintf ("EisaId (\"%c%c%c%4.4X\")", 536 537 /* Three Alpha characters (AAA), 5 bits each */ 538 539 (int) ((BigEndianId >> 26) & 0x1F) + 0x40, 540 (int) ((BigEndianId >> 21) & 0x1F) + 0x40, 541 (int) ((BigEndianId >> 16) & 0x1F) + 0x40, 542 543 /* Numeric part (NNNN) is simply the lower 16 bits */ 544 545 (UINT32) (BigEndianId & 0xFFFF)); 546 } 547 548 #endif 549