sys/contrib/dev/acpica-unix-20031203/interpreter/executer/exnames.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exnames - interpreter/scanner name load/execute
   5  *              $Revision: 94 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117
 118 #define __EXNAMES_C__
 119
 120 #include "acpi.h"
 121 #include "acinterp.h"
 122 #include "amlcode.h"
 123
 124 #define _COMPONENT          ACPI_EXECUTER
 125         ACPI_MODULE_NAME    ("exnames")
 126
 127
 128 /* AML Package Length encodings */
 129
 130 #define ACPI_AML_PACKAGE_TYPE1   0x40
 131 #define ACPI_AML_PACKAGE_TYPE2   0x4000
 132 #define ACPI_AML_PACKAGE_TYPE3   0x400000
 133 #define ACPI_AML_PACKAGE_TYPE4   0x40000000
 134
 135
 136 /*******************************************************************************
 137  *
 138  * FUNCTION:    AcpiExAllocateNameString
 139  *
 140  * PARAMETERS:  PrefixCount         - Count of parent levels. Special cases:
 141  *                                    (-1) = root,  0 = none
 142  *              NumNameSegs         - count of 4-character name segments
 143  *
 144  * RETURN:      A pointer to the allocated string segment.  This segment must
 145  *              be deleted by the caller.
 146  *
 147  * DESCRIPTION: Allocate a buffer for a name string. Ensure allocated name
 148  *              string is long enough, and set up prefix if any.
 149  *
 150  ******************************************************************************/
 151
 152 char *
 153 AcpiExAllocateNameString (
 154     UINT32                  PrefixCount,
 155     UINT32                  NumNameSegs)
 156 {
 157     char                    *TempPtr;
 158     char                    *NameString;
 159     UINT32                   SizeNeeded;
 160
 161     ACPI_FUNCTION_TRACE ("ExAllocateNameString");
 162
 163
 164     /*
 165      * Allow room for all \ and ^ prefixes, all segments, and a MultiNamePrefix.
 166      * Also, one byte for the null terminator.
 167      * This may actually be somewhat longer than needed.
 168      */
 169     if (PrefixCount == ACPI_UINT32_MAX)
 170     {
 171         /* Special case for root */
 172
 173         SizeNeeded = 1 + (ACPI_NAME_SIZE * NumNameSegs) + 2 + 1;
 174     }
 175     else
 176     {
 177         SizeNeeded = PrefixCount + (ACPI_NAME_SIZE * NumNameSegs) + 2 + 1;
 178     }
 179
 180     /*
 181      * Allocate a buffer for the name.
 182      * This buffer must be deleted by the caller!
 183      */
 184     NameString = ACPI_MEM_ALLOCATE (SizeNeeded);
 185     if (!NameString)
 186     {
 187         ACPI_REPORT_ERROR (("ExAllocateNameString: Could not allocate size %d\n", SizeNeeded));
 188         return_PTR (NULL);
 189     }
 190
 191     TempPtr = NameString;
 192
 193     /* Set up Root or Parent prefixes if needed */
 194
 195     if (PrefixCount == ACPI_UINT32_MAX)
 196     {
 197         *TempPtr++ = AML_ROOT_PREFIX;
 198     }
 199     else
 200     {
 201         while (PrefixCount--)
 202         {
 203             *TempPtr++ = AML_PARENT_PREFIX;
 204         }
 205     }
 206
 207
 208     /* Set up Dual or Multi prefixes if needed */
 209
 210     if (NumNameSegs > 2)
 211     {
 212         /* Set up multi prefixes   */
 213
 214         *TempPtr++ = AML_MULTI_NAME_PREFIX_OP;
 215         *TempPtr++ = (char) NumNameSegs;
 216     }
 217     else if (2 == NumNameSegs)
 218     {
 219         /* Set up dual prefixes */
 220
 221         *TempPtr++ = AML_DUAL_NAME_PREFIX;
 222     }
 223
 224     /*
 225      * Terminate string following prefixes. AcpiExNameSegment() will
 226      * append the segment(s)
 227      */
 228     *TempPtr = 0;
 229
 230     return_PTR (NameString);
 231 }
 232
 233 /*******************************************************************************
 234  *
 235  * FUNCTION:    AcpiExNameSegment
 236  *
 237  * PARAMETERS:  InterpreterMode     - Current running mode (load1/Load2/Exec)
 238  *
 239  * RETURN:      Status
 240  *
 241  * DESCRIPTION: Execute a name segment (4 bytes)
 242  *
 243  ******************************************************************************/
 244
 245 ACPI_STATUS
 246 AcpiExNameSegment (
 247     UINT8                   **InAmlAddress,
 248     char                    *NameString)
 249 {
 250     char                    *AmlAddress = (void *) *InAmlAddress;
 251     ACPI_STATUS             Status = AE_OK;
 252     UINT32                  Index;
 253     char                    CharBuf[5];
 254
 255
 256     ACPI_FUNCTION_TRACE ("ExNameSegment");
 257
 258
 259     /*
 260      * If first character is a digit, then we know that we aren't looking at a
 261      * valid name segment
 262      */
 263     CharBuf[0] = *AmlAddress;
 264
 265     if ('0' <= CharBuf[0] && CharBuf[0] <= '9')
 266     {
 267         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "leading digit: %c\n", CharBuf[0]));
 268         return_ACPI_STATUS (AE_CTRL_PENDING);
 269     }
 270
 271     ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "Bytes from stream:\n"));
 272
 273     for (Index = 0;
 274         (Index < ACPI_NAME_SIZE) && (AcpiUtValidAcpiCharacter (*AmlAddress));
 275         Index++)
 276     {
 277         CharBuf[Index] = *AmlAddress++;
 278         ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "%c\n", CharBuf[Index]));
 279     }
 280
 281
 282     /* Valid name segment  */
 283
 284     if (Index == 4)
 285     {
 286         /* Found 4 valid characters */
 287
 288         CharBuf[4] = '\0';
 289
 290         if (NameString)
 291         {
 292             ACPI_STRCAT (NameString, CharBuf);
 293             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
 294                 "Appended to - %s \n", NameString));
 295         }
 296         else
 297         {
 298             ACPI_DEBUG_PRINT ((ACPI_DB_NAMES,
 299                 "No Name string - %s \n", CharBuf));
 300         }
 301     }
 302     else if (Index == 0)
 303     {
 304         /*
 305          * First character was not a valid name character,
 306          * so we are looking at something other than a name.
 307          */
 308         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 309             "Leading character is not alpha: %02Xh (not a name)\n",
 310             CharBuf[0]));
 311         Status = AE_CTRL_PENDING;
 312     }
 313     else
 314     {
 315         /* Segment started with one or more valid characters, but fewer than 4 */
 316
 317         Status = AE_AML_BAD_NAME;
 318         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Bad character %02x in name, at %p\n",
 319             *AmlAddress, AmlAddress));
 320     }
 321
 322     *InAmlAddress = (UINT8 *) AmlAddress;
 323     return_ACPI_STATUS (Status);
 324 }
 325
 326
 327 /*******************************************************************************
 328  *
 329  * FUNCTION:    AcpiExGetNameString
 330  *
 331  * PARAMETERS:  DataType            - Data type to be associated with this name
 332  *
 333  * RETURN:      Status
 334  *
 335  * DESCRIPTION: Get a name, including any prefixes.
 336  *
 337  ******************************************************************************/
 338
 339 ACPI_STATUS
 340 AcpiExGetNameString (
 341     ACPI_OBJECT_TYPE        DataType,
 342     UINT8                   *InAmlAddress,
 343     char                    **OutNameString,
 344     UINT32                  *OutNameLength)
 345 {
 346     ACPI_STATUS             Status = AE_OK;
 347     UINT8                   *AmlAddress = InAmlAddress;
 348     char                    *NameString = NULL;
 349     UINT32                  NumSegments;
 350     UINT32                  PrefixCount = 0;
 351     BOOLEAN                 HasPrefix = FALSE;
 352
 353
 354     ACPI_FUNCTION_TRACE_PTR ("ExGetNameString", AmlAddress);
 355
 356
 357     if (ACPI_TYPE_LOCAL_REGION_FIELD == DataType   ||
 358         ACPI_TYPE_LOCAL_BANK_FIELD == DataType     ||
 359         ACPI_TYPE_LOCAL_INDEX_FIELD == DataType)
 360     {
 361         /* Disallow prefixes for types associated with FieldUnit names */
 362
 363         NameString = AcpiExAllocateNameString (0, 1);
 364         if (!NameString)
 365         {
 366             Status = AE_NO_MEMORY;
 367         }
 368         else
 369         {
 370             Status = AcpiExNameSegment (&AmlAddress, NameString);
 371         }
 372     }
 373     else
 374     {
 375         /*
 376          * DataType is not a field name.
 377          * Examine first character of name for root or parent prefix operators
 378          */
 379         switch (*AmlAddress)
 380         {
 381         case AML_ROOT_PREFIX:
 382
 383             ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "RootPrefix(\\) at %p\n", AmlAddress));
 384
 385             /*
 386              * Remember that we have a RootPrefix --
 387              * see comment in AcpiExAllocateNameString()
 388              */
 389             AmlAddress++;
 390             PrefixCount = ACPI_UINT32_MAX;
 391             HasPrefix = TRUE;
 392             break;
 393
 394
 395         case AML_PARENT_PREFIX:
 396
 397             /* Increment past possibly multiple parent prefixes */
 398
 399             do
 400             {
 401                 ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "ParentPrefix (^) at %p\n", AmlAddress));
 402
 403                 AmlAddress++;
 404                 PrefixCount++;
 405
 406             } while (*AmlAddress == AML_PARENT_PREFIX);
 407
 408             HasPrefix = TRUE;
 409             break;
 410
 411
 412         default:
 413
 414             /* Not a prefix character */
 415
 416             break;
 417         }
 418
 419
 420         /* Examine first character of name for name segment prefix operator */
 421
 422         switch (*AmlAddress)
 423         {
 424         case AML_DUAL_NAME_PREFIX:
 425
 426             ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "DualNamePrefix at %p\n", AmlAddress));
 427
 428             AmlAddress++;
 429             NameString = AcpiExAllocateNameString (PrefixCount, 2);
 430             if (!NameString)
 431             {
 432                 Status = AE_NO_MEMORY;
 433                 break;
 434             }
 435
 436             /* Indicate that we processed a prefix */
 437
 438             HasPrefix = TRUE;
 439
 440             Status = AcpiExNameSegment (&AmlAddress, NameString);
 441             if (ACPI_SUCCESS (Status))
 442             {
 443                 Status = AcpiExNameSegment (&AmlAddress, NameString);
 444             }
 445             break;
 446
 447
 448         case AML_MULTI_NAME_PREFIX_OP:
 449
 450             ACPI_DEBUG_PRINT ((ACPI_DB_LOAD, "MultiNamePrefix at %p\n", AmlAddress));
 451
 452             /* Fetch count of segments remaining in name path */
 453
 454             AmlAddress++;
 455             NumSegments = *AmlAddress;
 456
 457             NameString = AcpiExAllocateNameString (PrefixCount, NumSegments);
 458             if (!NameString)
 459             {
 460                 Status = AE_NO_MEMORY;
 461                 break;
 462             }
 463
 464             /* Indicate that we processed a prefix */
 465
 466             AmlAddress++;
 467             HasPrefix = TRUE;
 468
 469             while (NumSegments &&
 470                     (Status = AcpiExNameSegment (&AmlAddress, NameString)) == AE_OK)
 471             {
 472                 NumSegments--;
 473             }
 474
 475             break;
 476
 477
 478         case 0:
 479
 480             /* NullName valid as of 8-12-98 ASL/AML Grammar Update */
 481
 482             if (PrefixCount == ACPI_UINT32_MAX)
 483             {
 484                 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "NameSeg is \"\\\" followed by NULL\n"));
 485             }
 486
 487             /* Consume the NULL byte */
 488
 489             AmlAddress++;
 490             NameString = AcpiExAllocateNameString (PrefixCount, 0);
 491             if (!NameString)
 492             {
 493                 Status = AE_NO_MEMORY;
 494                 break;
 495             }
 496
 497             break;
 498
 499
 500         default:
 501
 502             /* Name segment string */
 503
 504             NameString = AcpiExAllocateNameString (PrefixCount, 1);
 505             if (!NameString)
 506             {
 507                 Status = AE_NO_MEMORY;
 508                 break;
 509             }
 510
 511             Status = AcpiExNameSegment (&AmlAddress, NameString);
 512             break;
 513         }
 514     }
 515
 516     if (AE_CTRL_PENDING == Status && HasPrefix)
 517     {
 518         /* Ran out of segments after processing a prefix */
 519
 520         ACPI_REPORT_ERROR (
 521             ("ExDoName: Malformed Name at %p\n", NameString));
 522         Status = AE_AML_BAD_NAME;
 523     }
 524
 525     *OutNameString = NameString;
 526     *OutNameLength = (UINT32) (AmlAddress - InAmlAddress);
 527
 528     return_ACPI_STATUS (Status);
 529 }
 530
 531