drivers/acpica/psutils.c

0001 /******************************************************************************
0002  *
0003  * Module Name: psutils - Parser miscellaneous utilities (Parser only)
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights.  You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code.  No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision.  In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change.  Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee.  Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution.  In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government.  In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************/
0115
0116
0117 #include "acpi.h"
0118 #include "accommon.h"
0119 #include "acparser.h"
0120 #include "amlcode.h"
0121
0122 #define _COMPONENT          ACPI_PARSER
0123         ACPI_MODULE_NAME    ("psutils")
0124
0125
0126 /*******************************************************************************
0127  *
0128  * FUNCTION:    AcpiPsCreateScopeOp
0129  *
0130  * PARAMETERS:  None
0131  *
0132  * RETURN:      A new Scope object, null on failure
0133  *
0134  * DESCRIPTION: Create a Scope and associated namepath op with the root name
0135  *
0136  ******************************************************************************/
0137
0138 ACPI_PARSE_OBJECT *
0139 AcpiPsCreateScopeOp (
0140     void)
0141 {
0142     ACPI_PARSE_OBJECT       *ScopeOp;
0143
0144
0145     ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP);
0146     if (!ScopeOp)
0147     {
0148         return (NULL);
0149     }
0150
0151     ScopeOp->Named.Name = ACPI_ROOT_NAME;
0152     return (ScopeOp);
0153 }
0154
0155
0156 /*******************************************************************************
0157  *
0158  * FUNCTION:    AcpiPsInitOp
0159  *
0160  * PARAMETERS:  Op              - A newly allocated Op object
0161  *              Opcode          - Opcode to store in the Op
0162  *
0163  * RETURN:      None
0164  *
0165  * DESCRIPTION: Initialize a parse (Op) object
0166  *
0167  ******************************************************************************/
0168
0169 void
0170 AcpiPsInitOp (
0171     ACPI_PARSE_OBJECT       *Op,
0172     UINT16                  Opcode)
0173 {
0174     ACPI_FUNCTION_ENTRY ();
0175
0176
0177     Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER;
0178     Op->Common.AmlOpcode = Opcode;
0179
0180     ACPI_DISASM_ONLY_MEMBERS (ACPI_STRNCPY (Op->Common.AmlOpName,
0181             (AcpiPsGetOpcodeInfo (Opcode))->Name,
0182                 sizeof (Op->Common.AmlOpName)));
0183 }
0184
0185
0186 /*******************************************************************************
0187  *
0188  * FUNCTION:    AcpiPsAllocOp
0189  *
0190  * PARAMETERS:  Opcode          - Opcode that will be stored in the new Op
0191  *
0192  * RETURN:      Pointer to the new Op, null on failure
0193  *
0194  * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
0195  *              opcode.  A cache of opcodes is available for the pure
0196  *              GENERIC_OP, since this is by far the most commonly used.
0197  *
0198  ******************************************************************************/
0199
0200 ACPI_PARSE_OBJECT*
0201 AcpiPsAllocOp (
0202     UINT16                  Opcode)
0203 {
0204     ACPI_PARSE_OBJECT       *Op;
0205     const ACPI_OPCODE_INFO  *OpInfo;
0206     UINT8                   Flags = ACPI_PARSEOP_GENERIC;
0207
0208
0209     ACPI_FUNCTION_ENTRY ();
0210
0211
0212     OpInfo = AcpiPsGetOpcodeInfo (Opcode);
0213
0214     /* Determine type of ParseOp required */
0215
0216     if (OpInfo->Flags & AML_DEFER)
0217     {
0218         Flags = ACPI_PARSEOP_DEFERRED;
0219     }
0220     else if (OpInfo->Flags & AML_NAMED)
0221     {
0222         Flags = ACPI_PARSEOP_NAMED;
0223     }
0224     else if (Opcode == AML_INT_BYTELIST_OP)
0225     {
0226         Flags = ACPI_PARSEOP_BYTELIST;
0227     }
0228
0229     /* Allocate the minimum required size object */
0230
0231     if (Flags == ACPI_PARSEOP_GENERIC)
0232     {
0233         /* The generic op (default) is by far the most common (16 to 1) */
0234
0235         Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache);
0236     }
0237     else
0238     {
0239         /* Extended parseop */
0240
0241         Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache);
0242     }
0243
0244     /* Initialize the Op */
0245
0246     if (Op)
0247     {
0248         AcpiPsInitOp (Op, Opcode);
0249         Op->Common.Flags = Flags;
0250     }
0251
0252     return (Op);
0253 }
0254
0255
0256 /*******************************************************************************
0257  *
0258  * FUNCTION:    AcpiPsFreeOp
0259  *
0260  * PARAMETERS:  Op              - Op to be freed
0261  *
0262  * RETURN:      None.
0263  *
0264  * DESCRIPTION: Free an Op object.  Either put it on the GENERIC_OP cache list
0265  *              or actually free it.
0266  *
0267  ******************************************************************************/
0268
0269 void
0270 AcpiPsFreeOp (
0271     ACPI_PARSE_OBJECT       *Op)
0272 {
0273     ACPI_FUNCTION_NAME (PsFreeOp);
0274
0275
0276     if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP)
0277     {
0278         ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", Op));
0279     }
0280
0281     if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
0282     {
0283         (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op);
0284     }
0285     else
0286     {
0287         (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op);
0288     }
0289 }
0290
0291
0292 /*******************************************************************************
0293  *
0294  * FUNCTION:    Utility functions
0295  *
0296  * DESCRIPTION: Low level character and object functions
0297  *
0298  ******************************************************************************/
0299
0300
0301 /*
0302  * Is "c" a namestring lead character?
0303  */
0304 BOOLEAN
0305 AcpiPsIsLeadingChar (
0306     UINT32                  c)
0307 {
0308     return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z')));
0309 }
0310
0311
0312 /*
0313  * Is "c" a namestring prefix character?
0314  */
0315 BOOLEAN
0316 AcpiPsIsPrefixChar (
0317     UINT32                  c)
0318 {
0319     return ((BOOLEAN) (c == '\\' || c == '^'));
0320 }
0321
0322
0323 /*
0324  * Get op's name (4-byte name segment) or 0 if unnamed
0325  */
0326 UINT32
0327 AcpiPsGetName (
0328     ACPI_PARSE_OBJECT       *Op)
0329 {
0330
0331     /* The "generic" object has no name associated with it */
0332
0333     if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
0334     {
0335         return (0);
0336     }
0337
0338     /* Only the "Extended" parse objects have a name */
0339
0340     return (Op->Named.Name);
0341 }
0342
0343
0344 /*
0345  * Set op's name
0346  */
0347 void
0348 AcpiPsSetName (
0349     ACPI_PARSE_OBJECT       *Op,
0350     UINT32                  name)
0351 {
0352
0353     /* The "generic" object has no name associated with it */
0354
0355     if (Op->Common.Flags & ACPI_PARSEOP_GENERIC)
0356     {
0357         return;
0358     }
0359
0360     Op->Named.Name = name;
0361 }
0362