sys/contrib/dev/acpica/dmbuffer.c

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