sys/contrib/dev/acpica-unix-20050309/disassembler/dmbuffer.c

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