exutils.c revision 91116
1 2/****************************************************************************** 3 * 4 * Module Name: exutils - interpreter/scanner utilities 5 * $Revision: 93 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, 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 __EXUTILS_C__ 119 120/* 121 * DEFINE_AML_GLOBALS is tested in amlcode.h 122 * to determine whether certain global names should be "defined" or only 123 * "declared" in the current compilation. This enhances maintainability 124 * by enabling a single header file to embody all knowledge of the names 125 * in question. 126 * 127 * Exactly one module of any executable should #define DEFINE_GLOBALS 128 * before #including the header files which use this convention. The 129 * names in question will be defined and initialized in that module, 130 * and declared as extern in all other modules which #include those 131 * header files. 132 */ 133 134#define DEFINE_AML_GLOBALS 135 136#include "acpi.h" 137#include "acparser.h" 138#include "acinterp.h" 139#include "amlcode.h" 140#include "acnamesp.h" 141#include "acevents.h" 142#include "acparser.h" 143 144#define _COMPONENT ACPI_EXECUTER 145 ACPI_MODULE_NAME ("exutils") 146 147 148/******************************************************************************* 149 * 150 * FUNCTION: AcpiExEnterInterpreter 151 * 152 * PARAMETERS: None 153 * 154 * DESCRIPTION: Enter the interpreter execution region. Failure to enter 155 * the interpreter region is a fatal system error 156 * 157 ******************************************************************************/ 158 159ACPI_STATUS 160AcpiExEnterInterpreter (void) 161{ 162 ACPI_STATUS Status; 163 164 ACPI_FUNCTION_TRACE ("ExEnterInterpreter"); 165 166 167 Status = AcpiUtAcquireMutex (ACPI_MTX_EXECUTE); 168 if (ACPI_FAILURE (Status)) 169 { 170 ACPI_REPORT_ERROR (("Fatal - Could not acquire interpreter lock\n")); 171 } 172 173 return_ACPI_STATUS (Status); 174} 175 176 177/******************************************************************************* 178 * 179 * FUNCTION: AcpiExExitInterpreter 180 * 181 * PARAMETERS: None 182 * 183 * DESCRIPTION: Exit the interpreter execution region 184 * 185 * Cases where the interpreter is unlocked: 186 * 1) Completion of the execution of a control method 187 * 2) Method blocked on a Sleep() AML opcode 188 * 3) Method blocked on an Acquire() AML opcode 189 * 4) Method blocked on a Wait() AML opcode 190 * 5) Method blocked to acquire the global lock 191 * 6) Method blocked to execute a serialized control method that is 192 * already executing 193 * 7) About to invoke a user-installed opregion handler 194 * 195 ******************************************************************************/ 196 197void 198AcpiExExitInterpreter (void) 199{ 200 ACPI_STATUS Status; 201 202 203 ACPI_FUNCTION_TRACE ("ExExitInterpreter"); 204 205 206 Status = AcpiUtReleaseMutex (ACPI_MTX_EXECUTE); 207 208 return_VOID; 209} 210 211 212/******************************************************************************* 213 * 214 * FUNCTION: AcpiExValidateObjectType 215 * 216 * PARAMETERS: Type Object type to validate 217 * 218 * DESCRIPTION: Determine if a type is a valid ACPI object type 219 * 220 ******************************************************************************/ 221 222BOOLEAN 223AcpiExValidateObjectType ( 224 ACPI_OBJECT_TYPE Type) 225{ 226 227 ACPI_FUNCTION_ENTRY (); 228 229 230 if ((Type > ACPI_TYPE_MAX && Type < INTERNAL_TYPE_BEGIN) || 231 (Type > INTERNAL_TYPE_MAX)) 232 { 233 return (FALSE); 234 } 235 236 return (TRUE); 237} 238 239 240/******************************************************************************* 241 * 242 * FUNCTION: AcpiExTruncateFor32bitTable 243 * 244 * PARAMETERS: ObjDesc - Object to be truncated 245 * WalkState - Current walk state 246 * (A method must be executing) 247 * 248 * RETURN: none 249 * 250 * DESCRIPTION: Truncate a number to 32-bits if the currently executing method 251 * belongs to a 32-bit ACPI table. 252 * 253 ******************************************************************************/ 254 255void 256AcpiExTruncateFor32bitTable ( 257 ACPI_OPERAND_OBJECT *ObjDesc, 258 ACPI_WALK_STATE *WalkState) 259{ 260 261 ACPI_FUNCTION_ENTRY (); 262 263 264 /* 265 * Object must be a valid number and we must be executing 266 * a control method 267 */ 268 if ((!ObjDesc) || 269 (ObjDesc->Common.Type != ACPI_TYPE_INTEGER) || 270 (!WalkState->MethodNode)) 271 { 272 return; 273 } 274 275 if (WalkState->MethodNode->Flags & ANOBJ_DATA_WIDTH_32) 276 { 277 /* 278 * We are running a method that exists in a 32-bit ACPI table. 279 * Truncate the value to 32 bits by zeroing out the upper 32-bit field 280 */ 281 ObjDesc->Integer.Value &= (ACPI_INTEGER) ACPI_UINT32_MAX; 282 } 283} 284 285 286/******************************************************************************* 287 * 288 * FUNCTION: AcpiExAcquireGlobalLock 289 * 290 * PARAMETERS: FieldFlags - Flags with Lock rule: 291 * AlwaysLock or NeverLock 292 * 293 * RETURN: TRUE/FALSE indicating whether the lock was actually acquired 294 * 295 * DESCRIPTION: Obtain the global lock and keep track of this fact via two 296 * methods. A global variable keeps the state of the lock, and 297 * the state is returned to the caller. 298 * 299 ******************************************************************************/ 300 301BOOLEAN 302AcpiExAcquireGlobalLock ( 303 UINT32 FieldFlags) 304{ 305 BOOLEAN Locked = FALSE; 306 ACPI_STATUS Status; 307 308 309 ACPI_FUNCTION_TRACE ("ExAcquireGlobalLock"); 310 311 312 /* Only attempt lock if the AlwaysLock bit is set */ 313 314 if (FieldFlags & AML_FIELD_LOCK_RULE_MASK) 315 { 316 /* We should attempt to get the lock, wait forever */ 317 318 Status = AcpiEvAcquireGlobalLock (ACPI_UINT32_MAX); 319 if (ACPI_SUCCESS (Status)) 320 { 321 Locked = TRUE; 322 } 323 else 324 { 325 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not acquire Global Lock, %s\n", 326 AcpiFormatException (Status))); 327 } 328 } 329 330 return_VALUE (Locked); 331} 332 333 334/******************************************************************************* 335 * 336 * FUNCTION: AcpiExReleaseGlobalLock 337 * 338 * PARAMETERS: LockedByMe - Return value from corresponding call to 339 * AcquireGlobalLock. 340 * 341 * RETURN: Status 342 * 343 * DESCRIPTION: Release the global lock if it is locked. 344 * 345 ******************************************************************************/ 346 347ACPI_STATUS 348AcpiExReleaseGlobalLock ( 349 BOOLEAN LockedByMe) 350{ 351 352 ACPI_FUNCTION_TRACE ("ExReleaseGlobalLock"); 353 354 355 /* Only attempt unlock if the caller locked it */ 356 357 if (LockedByMe) 358 { 359 /* OK, now release the lock */ 360 361 AcpiEvReleaseGlobalLock (); 362 } 363 364 return_ACPI_STATUS (AE_OK); 365} 366 367 368/******************************************************************************* 369 * 370 * FUNCTION: AcpiExDigitsNeeded 371 * 372 * PARAMETERS: Value - Value to be represented 373 * Base - Base of representation 374 * 375 * RETURN: the number of digits needed to represent Value in Base 376 * 377 ******************************************************************************/ 378 379UINT32 380AcpiExDigitsNeeded ( 381 ACPI_INTEGER Value, 382 UINT32 Base) 383{ 384 UINT32 NumDigits = 0; 385 386 387 ACPI_FUNCTION_TRACE ("ExDigitsNeeded"); 388 389 390 if (Base < 1) 391 { 392 ACPI_REPORT_ERROR (("ExDigitsNeeded: Internal error - Invalid base\n")); 393 } 394 else 395 { 396 /* 397 * ACPI_INTEGER is unsigned, which is why we don't worry about a '-' 398 */ 399 for (NumDigits = 1; 400 (AcpiUtShortDivide (&Value, Base, &Value, NULL)); 401 ++NumDigits) 402 { ; } 403 } 404 405 return_VALUE (NumDigits); 406} 407 408 409/******************************************************************************* 410 * 411 * FUNCTION: ntohl 412 * 413 * PARAMETERS: Value - Value to be converted 414 * 415 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes) 416 * 417 ******************************************************************************/ 418 419static UINT32 420_ntohl ( 421 UINT32 Value) 422{ 423 union 424 { 425 UINT32 Value; 426 UINT8 Bytes[4]; 427 } Out; 428 429 union 430 { 431 UINT32 Value; 432 UINT8 Bytes[4]; 433 } In; 434 435 436 ACPI_FUNCTION_ENTRY (); 437 438 439 In.Value = Value; 440 441 Out.Bytes[0] = In.Bytes[3]; 442 Out.Bytes[1] = In.Bytes[2]; 443 Out.Bytes[2] = In.Bytes[1]; 444 Out.Bytes[3] = In.Bytes[0]; 445 446 return (Out.Value); 447} 448 449 450/******************************************************************************* 451 * 452 * FUNCTION: AcpiExEisaIdToString 453 * 454 * PARAMETERS: NumericId - EISA ID to be converted 455 * OutString - Where to put the converted string (8 bytes) 456 * 457 * DESCRIPTION: Convert a numeric EISA ID to string representation 458 * 459 ******************************************************************************/ 460 461ACPI_STATUS 462AcpiExEisaIdToString ( 463 UINT32 NumericId, 464 NATIVE_CHAR *OutString) 465{ 466 UINT32 id; 467 468 469 ACPI_FUNCTION_ENTRY (); 470 471 472 /* swap to big-endian to get contiguous bits */ 473 474 id = _ntohl (NumericId); 475 476 OutString[0] = (char) ('@' + ((id >> 26) & 0x1f)); 477 OutString[1] = (char) ('@' + ((id >> 21) & 0x1f)); 478 OutString[2] = (char) ('@' + ((id >> 16) & 0x1f)); 479 OutString[3] = AcpiUtHexToAsciiChar (id, 12); 480 OutString[4] = AcpiUtHexToAsciiChar (id, 8); 481 OutString[5] = AcpiUtHexToAsciiChar (id, 4); 482 OutString[6] = AcpiUtHexToAsciiChar (id, 0); 483 OutString[7] = 0; 484 485 return (AE_OK); 486} 487 488 489/******************************************************************************* 490 * 491 * FUNCTION: AcpiExUnsignedIntegerToString 492 * 493 * PARAMETERS: Value - Value to be converted 494 * OutString - Where to put the converted string (8 bytes) 495 * 496 * RETURN: Convert a number to string representation 497 * 498 ******************************************************************************/ 499 500ACPI_STATUS 501AcpiExUnsignedIntegerToString ( 502 ACPI_INTEGER Value, 503 NATIVE_CHAR *OutString) 504{ 505 UINT32 Count; 506 UINT32 DigitsNeeded; 507 UINT32 Remainder; 508 509 510 ACPI_FUNCTION_ENTRY (); 511 512 513 DigitsNeeded = AcpiExDigitsNeeded (Value, 10); 514 OutString[DigitsNeeded] = 0; 515 516 for (Count = DigitsNeeded; Count > 0; Count--) 517 { 518 AcpiUtShortDivide (&Value, 10, &Value, &Remainder); 519 OutString[Count-1] = (NATIVE_CHAR) ('0' + Remainder); 520 } 521 522 return (AE_OK); 523} 524 525 526