sys/contrib/dev/acpica/psutils.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psutils - Parser miscellaneous utilities (Parser only)
   4  *              $Revision: 55 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/psutils.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 117
 118
 119 #include "acpi.h"
 120 #include "acparser.h"
 121 #include "amlcode.h"
 122 #include "acnamesp.h"
 123
 124 #define _COMPONENT          ACPI_PARSER
 125         ACPI_MODULE_NAME    ("psutils")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiPsCreateScopeOp
 131  *
 132  * PARAMETERS:  None
 133  *
 134  * RETURN:      ScopeOp
 135  *
 136  * DESCRIPTION: Create a Scope and associated namepath op with the root name
 137  *
 138  ******************************************************************************/
 139
 140 ACPI_PARSE_OBJECT *
 141 AcpiPsCreateScopeOp (
 142     void)
 143 {
 144     ACPI_PARSE_OBJECT       *ScopeOp;
 145
 146
 147     ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP);
 148     if (!ScopeOp)
 149     {
 150         return (NULL);
 151     }
 152
 153
 154     ScopeOp->Named.Name = ACPI_ROOT_NAME;
 155     return (ScopeOp);
 156 }
 157
 158
 159 /*******************************************************************************
 160  *
 161  * FUNCTION:    AcpiPsInitOp
 162  *
 163  * PARAMETERS:  Op              - A newly allocated Op object
 164  *              Opcode          - Opcode to store in the Op
 165  *
 166  * RETURN:      Status
 167  *
 168  * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
 169  *              opcode
 170  *
 171  ******************************************************************************/
 172
 173 void
 174 AcpiPsInitOp (
 175     ACPI_PARSE_OBJECT       *Op,
 176     UINT16                  Opcode)
 177 {
 178     ACPI_FUNCTION_ENTRY ();
 179
 180
 181     Op->Common.DataType = ACPI_DESC_TYPE_PARSER;
 182     Op->Common.AmlOpcode = Opcode;
 183
 184     ACPI_DISASM_ONLY_MEMBERS (ACPI_STRNCPY (Op->Common.AmlOpName,
 185             (AcpiPsGetOpcodeInfo (Opcode))->Name, sizeof (Op->Common.AmlOpName)));
 186 }
 187
 188
 189 /*******************************************************************************
 190  *
 191  * FUNCTION:    AcpiPsAllocOp
 192  *
 193  * PARAMETERS:  Opcode          - Opcode that will be stored in the new Op
 194  *
 195  * RETURN:      Pointer to the new Op.
 196  *
 197  * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
 198  *              opcode.  A cache of opcodes is available for the pure
 199  *              GENERIC_OP, since this is by far the most commonly used.
 200  *
 201  ******************************************************************************/
 202
 203 ACPI_PARSE_OBJECT*
 204 AcpiPsAllocOp (
 205     UINT16                  Opcode)
 206 {
 207     ACPI_PARSE_OBJECT       *Op = NULL;
 208     UINT32                  Size;
 209     UINT8                   Flags;
 210     const ACPI_OPCODE_INFO  *OpInfo;
 211
 212
 213     ACPI_FUNCTION_ENTRY ();
 214
 215
 216     OpInfo = AcpiPsGetOpcodeInfo (Opcode);
 217
 218     /* Allocate the minimum required size object */
 219
 220     if (OpInfo->Flags & AML_DEFER)
 221     {
 222         Size = sizeof (ACPI_PARSE_OBJ_NAMED);
 223         Flags = ACPI_PARSEOP_DEFERRED;
 224     }
 225     else if (OpInfo->Flags & AML_NAMED)
 226     {
 227         Size = sizeof (ACPI_PARSE_OBJ_NAMED);
 228         Flags = ACPI_PARSEOP_NAMED;
 229     }
 230     else if (Opcode == AML_INT_BYTELIST_OP)
 231     {
 232         Size = sizeof (ACPI_PARSE_OBJ_NAMED);
 233         Flags = ACPI_PARSEOP_BYTELIST;
 234     }
 235     else
 236     {
 237         Size = sizeof (ACPI_PARSE_OBJ_COMMON);
 238         Flags = ACPI_PARSEOP_GENERIC;
 239     }
 240
 241     if (Size == sizeof (ACPI_PARSE_OBJ_COMMON))
 242     {
 243         /*
 244          * The generic op is by far the most common (16 to 1)
 245          */
 246         Op = AcpiUtAcquireFromCache (ACPI_MEM_LIST_PSNODE);
 247     }
 248     else
 249     {
 250         Op = AcpiUtAcquireFromCache (ACPI_MEM_LIST_PSNODE_EXT);
 251     }
 252
 253     /* Initialize the Op */
 254
 255     if (Op)
 256     {
 257         AcpiPsInitOp (Op, Opcode);
 258         Op->Common.Flags = Flags;
 259     }
 260
 261     return (Op);
 262 }
 263
 264
 265 /*******************************************************************************
 266  *
 267  * FUNCTION:    AcpiPsFreeOp
 268  *
 269  * PARAMETERS:  Op              - Op to be freed
 270  *
 271  * RETURN:      None.
 272  *
 273  * DESCRIPTION: Free an Op object.  Either put it on the GENERIC_OP cache list
 274  *              or actually free it.
 275  *
 276  ******************************************************************************/
 277
 278 void
 279 AcpiPsFreeOp (
 280     ACPI_PARSE_OBJECT       *Op)
 281 {
 282     ACPI_FUNCTION_NAME ("PsFreeOp");
 283
 284
 285     if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
 286     {
 287         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", Op));
 288     }
 289
 290     if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
 291     {
 292         AcpiUtReleaseToCache (ACPI_MEM_LIST_PSNODE, Op);
 293     }
 294     else
 295     {
 296         AcpiUtReleaseToCache (ACPI_MEM_LIST_PSNODE_EXT, Op);
 297     }
 298 }
 299
 300
 301 /*******************************************************************************
 302  *
 303  * FUNCTION:    AcpiPsDeleteParseCache
 304  *
 305  * PARAMETERS:  None
 306  *
 307  * RETURN:      None
 308  *
 309  * DESCRIPTION: Free all objects that are on the parse cache list.
 310  *
 311  ******************************************************************************/
 312
 313 void
 314 AcpiPsDeleteParseCache (
 315     void)
 316 {
 317     ACPI_FUNCTION_TRACE ("PsDeleteParseCache");
 318
 319
 320     AcpiUtDeleteGenericCache (ACPI_MEM_LIST_PSNODE);
 321     AcpiUtDeleteGenericCache (ACPI_MEM_LIST_PSNODE_EXT);
 322     return_VOID;
 323 }
 324
 325
 326 /*******************************************************************************
 327  *
 328  * FUNCTION:    Utility functions
 329  *
 330  * DESCRIPTION: Low level character and object functions
 331  *
 332  ******************************************************************************/
 333
 334
 335 /*
 336  * Is "c" a namestring lead character?
 337  */
 338 BOOLEAN
 339 AcpiPsIsLeadingChar (
 340     UINT32                  c)
 341 {
 342     return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
 343 }
 344
 345
 346 /*
 347  * Is "c" a namestring prefix character?
 348  */
 349 BOOLEAN
 350 AcpiPsIsPrefixChar (
 351     UINT32                  c)
 352 {
 353     return ((BOOLEAN) (c == '\\' || c == '^'));
 354 }
 355
 356
 357 /*
 358  * Get op's name (4-byte name segment) or 0 if unnamed
 359  */
 360 UINT32
 361 AcpiPsGetName (
 362     ACPI_PARSE_OBJECT       *Op)
 363 {
 364
 365
 366     /* The "generic" object has no name associated with it */
 367
 368     if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
 369     {
 370         return (0);
 371     }
 372
 373     /* Only the "Extended" parse objects have a name */
 374
 375     return (Op->Named.Name);
 376 }
 377
 378
 379 /*
 380  * Set op's name
 381  */
 382 void
 383 AcpiPsSetName (
 384     ACPI_PARSE_OBJECT       *Op,
 385     UINT32                  name)
 386 {
 387
 388     /* The "generic" object has no name associated with it */
 389
 390     if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
 391     {
 392         return;
 393     }
 394
 395     Op->Named.Name = name;
 396 }
 397