sys/contrib/dev/acpica/compiler/dtfield.c

   1 /******************************************************************************
   2  *
   3  * Module Name: dtfield.c - Code generation for individual source fields
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2010, 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 #define __DTFIELD_C__
 117
 118 #include <contrib/dev/acpica/compiler/aslcompiler.h>
 119 #include <contrib/dev/acpica/compiler/dtcompiler.h>
 120
 121 #define _COMPONENT          DT_COMPILER
 122         ACPI_MODULE_NAME    ("dtfield")
 123
 124
 125 /* Local prototypes */
 126
 127 static void
 128 DtCompileString (
 129     UINT8                   *Buffer,
 130     DT_FIELD                *Field,
 131     UINT32                  ByteLength);
 132
 133 static char *
 134 DtNormalizeBuffer (
 135     char                    *Buffer,
 136     UINT32                  *Count);
 137
 138
 139 /******************************************************************************
 140  *
 141  * FUNCTION:    DtCompileOneField
 142  *
 143  * PARAMETERS:  Buffer              - Output buffer
 144  *              Field               - Field to be compiled
 145  *              ByteLength          - Byte length of the field
 146  *              Type                - Field type
 147  *
 148  * RETURN:      None
 149  *
 150  * DESCRIPTION: Compile a field value to binary
 151  *
 152  *****************************************************************************/
 153
 154 void
 155 DtCompileOneField (
 156     UINT8                   *Buffer,
 157     DT_FIELD                *Field,
 158     UINT32                  ByteLength,
 159     UINT8                   Type,
 160     UINT8                   Flags)
 161 {
 162
 163     switch (Type)
 164     {
 165     case DT_FIELD_TYPE_INTEGER:
 166         DtCompileInteger (Buffer, Field, ByteLength, Flags);
 167         break;
 168
 169     case DT_FIELD_TYPE_STRING:
 170         DtCompileString (Buffer, Field, ByteLength);
 171         break;
 172
 173     case DT_FIELD_TYPE_BUFFER:
 174         DtCompileBuffer (Buffer, Field->Value, Field, ByteLength);
 175         break;
 176
 177     default:
 178         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid field type");
 179         break;
 180     }
 181 }
 182
 183
 184 /******************************************************************************
 185  *
 186  * FUNCTION:    DtCompileString
 187  *
 188  * PARAMETERS:  Buffer              - Output buffer
 189  *              Field               - String to be copied to buffer
 190  *              ByteLength          - Maximum length of string
 191  *
 192  * RETURN:      None
 193  *
 194  * DESCRIPTION: Copy string to the buffer
 195  *
 196  *****************************************************************************/
 197
 198 static void
 199 DtCompileString (
 200     UINT8                   *Buffer,
 201     DT_FIELD                *Field,
 202     UINT32                  ByteLength)
 203 {
 204     UINT32                  Length;
 205
 206
 207     Length = ACPI_STRLEN (Field->Value);
 208
 209     /* Check if the string is too long for the field */
 210
 211     if (Length > ByteLength)
 212     {
 213         sprintf (MsgBuffer, "Maximum %u characters", ByteLength);
 214         DtError (ASL_ERROR, ASL_MSG_STRING_LENGTH, Field, MsgBuffer);
 215         Length = ByteLength;
 216     }
 217
 218     ACPI_MEMCPY (Buffer, Field->Value, Length);
 219 }
 220
 221
 222 /******************************************************************************
 223  *
 224  * FUNCTION:    DtCompileInteger
 225  *
 226  * PARAMETERS:  Buffer              - Output buffer
 227  *              Field               - Field obj with Integer to be compiled
 228  *              ByteLength          - Byte length of the integer
 229  *
 230  * RETURN:      None
 231  *
 232  * DESCRIPTION: Compile an integer
 233  *
 234  *****************************************************************************/
 235
 236 void
 237 DtCompileInteger (
 238     UINT8                   *Buffer,
 239     DT_FIELD                *Field,
 240     UINT32                  ByteLength,
 241     UINT8                   Flags)
 242 {
 243     UINT64                  Value = 0;
 244     UINT64                  MaxValue;
 245     UINT8                   *Hex;
 246     char                    *Message = NULL;
 247     ACPI_STATUS             Status;
 248     int                     i;
 249
 250
 251     /* Byte length must be in range 1-8 */
 252
 253     if ((ByteLength > 8) || (ByteLength == 0))
 254     {
 255         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field,
 256             "Invalid internal Byte length");
 257         return;
 258     }
 259
 260     /* Convert string to an actual integer */
 261
 262     Status = DtStrtoul64 (Field->Value, &Value);
 263     if (ACPI_FAILURE (Status))
 264     {
 265         if (Status == AE_LIMIT)
 266         {
 267             Message = "Constant larger than 64 bits";
 268         }
 269         else if (Status == AE_BAD_CHARACTER)
 270         {
 271             Message = "Invalid character in constant";
 272         }
 273
 274         DtError (ASL_ERROR, ASL_MSG_INVALID_HEX_INTEGER, Field, Message);
 275         goto Exit;
 276     }
 277
 278     /* Ensure that reserved fields are set to zero */
 279     /* TBD: should we set to zero, or just make this an ERROR? */
 280     /* TBD: Probably better to use a flag */
 281
 282     if (!ACPI_STRCMP (Field->Name, "Reserved") &&
 283         (Value != 0))
 284     {
 285         DtError (ASL_WARNING, ASL_MSG_RESERVED_VALUE, Field,
 286             "Setting to zero");
 287         Value = 0;
 288     }
 289
 290     /* Check if the value must be non-zero */
 291
 292     if ((Value == 0) && (Flags & DT_NON_ZERO))
 293     {
 294         DtError (ASL_ERROR, ASL_MSG_ZERO_VALUE, Field, NULL);
 295     }
 296
 297     /*
 298      * Generate the maximum value for the data type (ByteLength)
 299      * Note: construct chosen for maximum portability
 300      */
 301     MaxValue = ((UINT64) (-1)) >> (64 - (ByteLength * 8));
 302
 303     /* Validate that the input value is within range of the target */
 304
 305     if (Value > MaxValue)
 306     {
 307         sprintf (MsgBuffer, "Maximum %u bytes", ByteLength);
 308         DtError (ASL_ERROR, ASL_MSG_INTEGER_SIZE, Field, MsgBuffer);
 309     }
 310
 311     /*
 312      * TBD: hard code for ASF! Capabilites field.
 313      *
 314      * This field is actually a buffer, not a 56-bit integer --
 315      * so, the ordering is reversed. Something should be fixed
 316      * so we don't need this code.
 317      */
 318     if (ByteLength == 7)
 319     {
 320         Hex = ACPI_CAST_PTR (UINT8, &Value);
 321         for (i = 6; i >= 0; i--)
 322         {
 323             Buffer[i] = *Hex;
 324             Hex++;
 325         }
 326         return;
 327     }
 328
 329 Exit:
 330     ACPI_MEMCPY (Buffer, &Value, ByteLength);
 331     return;
 332 }
 333
 334
 335 /******************************************************************************
 336  *
 337  * FUNCTION:    DtNormalizeBuffer
 338  *
 339  * PARAMETERS:  Buffer              - Input buffer
 340  *              Count               - Output the count of hex number in
 341  *                                    the Buffer
 342  *
 343  * RETURN:      The normalized buffer, freed by caller
 344  *
 345  * DESCRIPTION: [1A,2B,3C,4D] or 1A, 2B, 3C, 4D will be normalized
 346  *              to 1A 2B 3C 4D
 347  *
 348  *****************************************************************************/
 349
 350 static char *
 351 DtNormalizeBuffer (
 352     char                    *Buffer,
 353     UINT32                  *Count)
 354 {
 355     char                    *NewBuffer;
 356     char                    *TmpBuffer;
 357     UINT32                  BufferCount = 0;
 358     BOOLEAN                 Separator = TRUE;
 359     char                    c;
 360
 361
 362     NewBuffer = UtLocalCalloc (ACPI_STRLEN (Buffer) + 1);
 363     TmpBuffer = NewBuffer;
 364
 365     while ((c = *Buffer++))
 366     {
 367         switch (c)
 368         {
 369         /* Valid separators */
 370
 371         case '[':
 372         case ']':
 373         case ' ':
 374         case ',':
 375             Separator = TRUE;
 376             break;
 377
 378         default:
 379             if (Separator)
 380             {
 381                 /* Insert blank as the standard separator */
 382
 383                 if (NewBuffer[0])
 384                 {
 385                     *TmpBuffer++ = ' ';
 386                     BufferCount++;
 387                 }
 388
 389                 Separator = FALSE;
 390             }
 391
 392             *TmpBuffer++ = c;
 393             break;
 394         }
 395     }
 396
 397     *Count = BufferCount + 1;
 398     return (NewBuffer);
 399 }
 400
 401
 402 /******************************************************************************
 403  *
 404  * FUNCTION:    DtCompileBuffer
 405  *
 406  * PARAMETERS:  Buffer              - Output buffer
 407  *              StringValue         - Integer list to be compiled
 408  *              Field               - Current field object
 409  *              ByteLength          - Byte length of the integer list
 410  *
 411  * RETURN:      Count of remaining data in the input list
 412  *
 413  * DESCRIPTION: Compile and pack an integer list, for example
 414  *              "AA 1F 20 3B" ==> Buffer[] = {0xAA,0x1F,0x20,0x3B}
 415  *
 416  *****************************************************************************/
 417
 418 UINT32
 419 DtCompileBuffer (
 420     UINT8                   *Buffer,
 421     char                    *StringValue,
 422     DT_FIELD                *Field,
 423     UINT32                  ByteLength)
 424 {
 425     ACPI_STATUS             Status;
 426     char                    Hex[3];
 427     UINT64                  Value;
 428     UINT32                  i;
 429     UINT32                  Count;
 430
 431
 432     /* Allow several different types of value separators */
 433
 434     StringValue = DtNormalizeBuffer (StringValue, &Count);
 435
 436     Hex[2] = 0;
 437     for (i = 0; i < Count; i++)
 438     {
 439         /* Each element of StringValue is three chars */
 440
 441         Hex[0] = StringValue[(3 * i)];
 442         Hex[1] = StringValue[(3 * i) + 1];
 443
 444         /* Convert one hex byte */
 445
 446         Value = 0;
 447         Status = DtStrtoul64 (Hex, &Value);
 448         if (ACPI_FAILURE (Status))
 449         {
 450             DtError (ASL_ERROR, ASL_MSG_BUFFER_ELEMENT, Field, MsgBuffer);
 451             return (ByteLength - Count);
 452         }
 453
 454         Buffer[i] = (UINT8) Value;
 455     }
 456
 457     ACPI_FREE (StringValue);
 458     return (ByteLength - Count);
 459 }
 460
 461
 462 /******************************************************************************
 463  *
 464  * FUNCTION:    DtCompileFlag
 465  *
 466  * PARAMETERS:  Buffer              - Output buffer
 467  *              Field               - Field to be compiled
 468  *              Info                - Flag info
 469  *
 470  * RETURN:
 471  *
 472  * DESCRIPTION: Compile a flag
 473  *
 474  *****************************************************************************/
 475
 476 void
 477 DtCompileFlag (
 478     UINT8                   *Buffer,
 479     DT_FIELD                *Field,
 480     ACPI_DMTABLE_INFO       *Info)
 481 {
 482     UINT64                  Value = 0;
 483     UINT32                  BitLength = 1;
 484     UINT8                   BitPosition = 0;
 485     ACPI_STATUS             Status;
 486
 487
 488     Status = DtStrtoul64 (Field->Value, &Value);
 489     if (ACPI_FAILURE (Status))
 490     {
 491         DtError (ASL_ERROR, ASL_MSG_INVALID_HEX_INTEGER, Field, NULL);
 492     }
 493
 494     switch (Info->Opcode)
 495     {
 496     case ACPI_DMT_FLAG0:
 497     case ACPI_DMT_FLAG1:
 498     case ACPI_DMT_FLAG2:
 499     case ACPI_DMT_FLAG3:
 500     case ACPI_DMT_FLAG4:
 501     case ACPI_DMT_FLAG5:
 502     case ACPI_DMT_FLAG6:
 503     case ACPI_DMT_FLAG7:
 504
 505         BitPosition = Info->Opcode;
 506         BitLength = 1;
 507         break;
 508
 509     case ACPI_DMT_FLAGS0:
 510
 511         BitPosition = 0;
 512         BitLength = 2;
 513         break;
 514
 515
 516     case ACPI_DMT_FLAGS2:
 517
 518         BitPosition = 2;
 519         BitLength = 2;
 520         break;
 521
 522     default:
 523
 524         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid flag opcode");
 525         break;
 526     }
 527
 528     /* Check range of the input flag value */
 529
 530     if (Value >= ((UINT64) 1 << BitLength))
 531     {
 532         sprintf (MsgBuffer, "Maximum %u bit", BitLength);
 533         DtError (ASL_ERROR, ASL_MSG_FLAG_VALUE, Field, MsgBuffer);
 534         Value = 0;
 535     }
 536
 537     *Buffer |= (UINT8) (Value << BitPosition);
 538 }