psutils.c revision 193259
196904Sgrog/****************************************************************************** 296904Sgrog * 396904Sgrog * Module Name: psutils - Parser miscellaneous utilities (Parser only) 496904Sgrog * $Revision: 1.70 $ 596904Sgrog * 696904Sgrog *****************************************************************************/ 796904Sgrog 896904Sgrog/****************************************************************************** 996904Sgrog * 1096904Sgrog * 1. Copyright Notice 1196904Sgrog * 1296904Sgrog * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp. 1396904Sgrog * All rights reserved. 1496904Sgrog * 1596904Sgrog * 2. License 1696904Sgrog * 1796904Sgrog * 2.1. This is your license from Intel Corp. under its intellectual property 1896904Sgrog * rights. You may have additional license terms from the party that provided 1996904Sgrog * you this software, covering your right to use that party's intellectual 2096904Sgrog * property rights. 2196904Sgrog * 2296904Sgrog * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2396904Sgrog * copy of the source code appearing in this file ("Covered Code") an 2496904Sgrog * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2596904Sgrog * base code distributed originally by Intel ("Original Intel Code") to copy, 2696904Sgrog * make derivatives, distribute, use and display any portion of the Covered 2796904Sgrog * Code in any form, with the right to sublicense such rights; and 2896904Sgrog * 2996904Sgrog * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3096904Sgrog * license (with the right to sublicense), under only those claims of Intel 3196904Sgrog * patents that are infringed by the Original Intel Code, to make, use, sell, 3296904Sgrog * offer to sell, and import the Covered Code and derivative works thereof 3396904Sgrog * solely to the minimum extent necessary to exercise the above copyright 3496904Sgrog * license, and in no event shall the patent license extend to any additions 3596904Sgrog * to or modifications of the Original Intel Code. No other license or right 3696895Sgrog * is granted directly or by implication, estoppel or otherwise; 3796895Sgrog * 3896895Sgrog * The above copyright and patent license is granted only if the following 3996895Sgrog * conditions are met: 4096895Sgrog * 4196895Sgrog * 3. Conditions 4296895Sgrog * 4396895Sgrog * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4496895Sgrog * Redistribution of source code of any substantial portion of the Covered 4596895Sgrog * Code or modification with rights to further distribute source must include 4696895Sgrog * the above Copyright Notice, the above License, this list of Conditions, 4796895Sgrog * and the following Disclaimer and Export Compliance provision. In addition, 4896895Sgrog * Licensee must cause all Covered Code to which Licensee contributes to 4996895Sgrog * contain a file documenting the changes Licensee made to create that Covered 5096895Sgrog * Code and the date of any change. Licensee must include in that file the 5196895Sgrog * documentation of any changes made by any predecessor Licensee. Licensee 5296895Sgrog * must include a prominent statement that the modification is derived, 5396895Sgrog * directly or indirectly, from Original Intel Code. 5496895Sgrog * 5596895Sgrog * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5696895Sgrog * Redistribution of source code of any substantial portion of the Covered 5796895Sgrog * Code or modification without rights to further distribute source must 5896895Sgrog * include the following Disclaimer and Export Compliance provision in the 5996895Sgrog * documentation and/or other materials provided with distribution. In 6096895Sgrog * addition, Licensee may not authorize further sublicense of source of any 6196895Sgrog * portion of the Covered Code, and must include terms to the effect that the 6296895Sgrog * license from Licensee to its licensee is limited to the intellectual 6396895Sgrog * property embodied in the software Licensee provides to its licensee, and 6496895Sgrog * not to intellectual property embodied in modifications its licensee may 6596895Sgrog * make. 6696895Sgrog * 6796895Sgrog * 3.3. Redistribution of Executable. Redistribution in executable form of any 6896895Sgrog * substantial portion of the Covered Code or modification must reproduce the 6996895Sgrog * above Copyright Notice, and the following Disclaimer and Export Compliance 7096895Sgrog * provision in the documentation and/or other materials provided with the 7196895Sgrog * distribution. 7296895Sgrog * 7396895Sgrog * 3.4. Intel retains all right, title, and interest in and to the Original 7496895Sgrog * Intel Code. 7596895Sgrog * 7696895Sgrog * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7796895Sgrog * Intel shall be used in advertising or otherwise to promote the sale, use or 7896895Sgrog * other dealings in products derived from or relating to the Covered Code 7996895Sgrog * without prior written authorization from Intel. 8096895Sgrog * 8196895Sgrog * 4. Disclaimer and Export Compliance 8296895Sgrog * 8396895Sgrog * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8496895Sgrog * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8596895Sgrog * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8696895Sgrog * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8796895Sgrog * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8896895Sgrog * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 8996895Sgrog * PARTICULAR PURPOSE. 9096895Sgrog * 9196895Sgrog * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9296895Sgrog * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9396895Sgrog * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9496895Sgrog * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9596895Sgrog * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9696895Sgrog * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9796895Sgrog * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9896895Sgrog * LIMITED REMEDY. 9996895Sgrog * 10096895Sgrog * 4.3. Licensee shall not export, either directly or indirectly, any of this 10196895Sgrog * software or system incorporating such software without first obtaining any 10296895Sgrog * required license or other approval from the U. S. Department of Commerce or 10396895Sgrog * any other agency or department of the United States Government. In the 10496895Sgrog * event Licensee exports any such software from the United States or 10596895Sgrog * re-exports any such software from a foreign destination, Licensee shall 10696895Sgrog * ensure that the distribution and export/re-export of the software is in 10796895Sgrog * compliance with all laws, regulations, orders, or other restrictions of the 10896895Sgrog * U.S. Export Administration Regulations. Licensee agrees that neither it nor 10996895Sgrog * any of its subsidiaries will export/re-export any technical data, process, 11096895Sgrog * software, or service, directly or indirectly, to any country for which the 11196895Sgrog * United States government or any agency thereof requires an export license, 11296895Sgrog * other governmental approval, or letter of assurance, without first obtaining 11396895Sgrog * such license, approval or letter. 11496895Sgrog * 11596895Sgrog *****************************************************************************/ 11696895Sgrog 11796895Sgrog 11896895Sgrog#include "acpi.h" 11996895Sgrog#include "acparser.h" 12096895Sgrog#include "amlcode.h" 12196895Sgrog 12296895Sgrog#define _COMPONENT ACPI_PARSER 12396895Sgrog ACPI_MODULE_NAME ("psutils") 12496895Sgrog 12596895Sgrog 12696895Sgrog/******************************************************************************* 12796895Sgrog * 12896895Sgrog * FUNCTION: AcpiPsCreateScopeOp 12996895Sgrog * 130 * PARAMETERS: None 131 * 132 * RETURN: A new Scope object, null on failure 133 * 134 * DESCRIPTION: Create a Scope and associated namepath op with the root name 135 * 136 ******************************************************************************/ 137 138ACPI_PARSE_OBJECT * 139AcpiPsCreateScopeOp ( 140 void) 141{ 142 ACPI_PARSE_OBJECT *ScopeOp; 143 144 145 ScopeOp = AcpiPsAllocOp (AML_SCOPE_OP); 146 if (!ScopeOp) 147 { 148 return (NULL); 149 } 150 151 ScopeOp->Named.Name = ACPI_ROOT_NAME; 152 return (ScopeOp); 153} 154 155 156/******************************************************************************* 157 * 158 * FUNCTION: AcpiPsInitOp 159 * 160 * PARAMETERS: Op - A newly allocated Op object 161 * Opcode - Opcode to store in the Op 162 * 163 * RETURN: None 164 * 165 * DESCRIPTION: Initialize a parse (Op) object 166 * 167 ******************************************************************************/ 168 169void 170AcpiPsInitOp ( 171 ACPI_PARSE_OBJECT *Op, 172 UINT16 Opcode) 173{ 174 ACPI_FUNCTION_ENTRY (); 175 176 177 Op->Common.DescriptorType = ACPI_DESC_TYPE_PARSER; 178 Op->Common.AmlOpcode = Opcode; 179 180 ACPI_DISASM_ONLY_MEMBERS (ACPI_STRNCPY (Op->Common.AmlOpName, 181 (AcpiPsGetOpcodeInfo (Opcode))->Name, 182 sizeof (Op->Common.AmlOpName))); 183} 184 185 186/******************************************************************************* 187 * 188 * FUNCTION: AcpiPsAllocOp 189 * 190 * PARAMETERS: Opcode - Opcode that will be stored in the new Op 191 * 192 * RETURN: Pointer to the new Op, null on failure 193 * 194 * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on 195 * opcode. A cache of opcodes is available for the pure 196 * GENERIC_OP, since this is by far the most commonly used. 197 * 198 ******************************************************************************/ 199 200ACPI_PARSE_OBJECT* 201AcpiPsAllocOp ( 202 UINT16 Opcode) 203{ 204 ACPI_PARSE_OBJECT *Op; 205 const ACPI_OPCODE_INFO *OpInfo; 206 UINT8 Flags = ACPI_PARSEOP_GENERIC; 207 208 209 ACPI_FUNCTION_ENTRY (); 210 211 212 OpInfo = AcpiPsGetOpcodeInfo (Opcode); 213 214 /* Determine type of ParseOp required */ 215 216 if (OpInfo->Flags & AML_DEFER) 217 { 218 Flags = ACPI_PARSEOP_DEFERRED; 219 } 220 else if (OpInfo->Flags & AML_NAMED) 221 { 222 Flags = ACPI_PARSEOP_NAMED; 223 } 224 else if (Opcode == AML_INT_BYTELIST_OP) 225 { 226 Flags = ACPI_PARSEOP_BYTELIST; 227 } 228 229 /* Allocate the minimum required size object */ 230 231 if (Flags == ACPI_PARSEOP_GENERIC) 232 { 233 /* The generic op (default) is by far the most common (16 to 1) */ 234 235 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeCache); 236 } 237 else 238 { 239 /* Extended parseop */ 240 241 Op = AcpiOsAcquireObject (AcpiGbl_PsNodeExtCache); 242 } 243 244 /* Initialize the Op */ 245 246 if (Op) 247 { 248 AcpiPsInitOp (Op, Opcode); 249 Op->Common.Flags = Flags; 250 } 251 252 return (Op); 253} 254 255 256/******************************************************************************* 257 * 258 * FUNCTION: AcpiPsFreeOp 259 * 260 * PARAMETERS: Op - Op to be freed 261 * 262 * RETURN: None. 263 * 264 * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list 265 * or actually free it. 266 * 267 ******************************************************************************/ 268 269void 270AcpiPsFreeOp ( 271 ACPI_PARSE_OBJECT *Op) 272{ 273 ACPI_FUNCTION_NAME (PsFreeOp); 274 275 276 if (Op->Common.AmlOpcode == AML_INT_RETURN_VALUE_OP) 277 { 278 ACPI_DEBUG_PRINT ((ACPI_DB_ALLOCATIONS, "Free retval op: %p\n", Op)); 279 } 280 281 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC) 282 { 283 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeCache, Op); 284 } 285 else 286 { 287 (void) AcpiOsReleaseObject (AcpiGbl_PsNodeExtCache, Op); 288 } 289} 290 291 292/******************************************************************************* 293 * 294 * FUNCTION: Utility functions 295 * 296 * DESCRIPTION: Low level character and object functions 297 * 298 ******************************************************************************/ 299 300 301/* 302 * Is "c" a namestring lead character? 303 */ 304BOOLEAN 305AcpiPsIsLeadingChar ( 306 UINT32 c) 307{ 308 return ((BOOLEAN) (c == '_' || (c >= 'A' && c <= 'Z'))); 309} 310 311 312/* 313 * Is "c" a namestring prefix character? 314 */ 315BOOLEAN 316AcpiPsIsPrefixChar ( 317 UINT32 c) 318{ 319 return ((BOOLEAN) (c == '\\' || c == '^')); 320} 321 322 323/* 324 * Get op's name (4-byte name segment) or 0 if unnamed 325 */ 326UINT32 327AcpiPsGetName ( 328 ACPI_PARSE_OBJECT *Op) 329{ 330 331 /* The "generic" object has no name associated with it */ 332 333 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC) 334 { 335 return (0); 336 } 337 338 /* Only the "Extended" parse objects have a name */ 339 340 return (Op->Named.Name); 341} 342 343 344/* 345 * Set op's name 346 */ 347void 348AcpiPsSetName ( 349 ACPI_PARSE_OBJECT *Op, 350 UINT32 name) 351{ 352 353 /* The "generic" object has no name associated with it */ 354 355 if (Op->Common.Flags & ACPI_PARSEOP_GENERIC) 356 { 357 return; 358 } 359 360 Op->Named.Name = name; 361} 362 363