1 /****************************************************************************** 2 * 3 * Module Name: exutils - interpreter/scanner utilities 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #define __EXUTILS_C__ 117 118 /* 119 * DEFINE_AML_GLOBALS is tested in amlcode.h 120 * to determine whether certain global names should be "defined" or only 121 * "declared" in the current compilation. This enhances maintainability 122 * by enabling a single header file to embody all knowledge of the names 123 * in question. 124 * 125 * Exactly one module of any executable should #define DEFINE_GLOBALS 126 * before #including the header files which use this convention. The 127 * names in question will be defined and initialized in that module, 128 * and declared as extern in all other modules which #include those 129 * header files. 130 */ 131 132 #define DEFINE_AML_GLOBALS 133 134 #include "acpi.h" 135 #include "accommon.h" 136 #include "acinterp.h" 137 #include "amlcode.h" 138 139 #define _COMPONENT ACPI_EXECUTER 140 ACPI_MODULE_NAME ("exutils") 141 142 /* Local prototypes */ 143 144 static UINT32 145 AcpiExDigitsNeeded ( 146 UINT64 Value, 147 UINT32 Base); 148 149 150 #ifndef ACPI_NO_METHOD_EXECUTION 151 /******************************************************************************* 152 * 153 * FUNCTION: AcpiExEnterInterpreter 154 * 155 * PARAMETERS: None 156 * 157 * RETURN: None 158 * 159 * DESCRIPTION: Enter the interpreter execution region. Failure to enter 160 * the interpreter region is a fatal system error. Used in 161 * conjunction with ExitInterpreter. 162 * 163 ******************************************************************************/ 164 165 void 166 AcpiExEnterInterpreter ( 167 void) 168 { 169 ACPI_STATUS Status; 170 171 172 ACPI_FUNCTION_TRACE (ExEnterInterpreter); 173 174 175 Status = AcpiUtAcquireMutex (ACPI_MTX_INTERPRETER); 176 if (ACPI_FAILURE (Status)) 177 { 178 ACPI_ERROR ((AE_INFO, "Could not acquire AML Interpreter mutex")); 179 } 180 181 return_VOID; 182 } 183 184 185 /******************************************************************************* 186 * 187 * FUNCTION: AcpiExReacquireInterpreter 188 * 189 * PARAMETERS: None 190 * 191 * RETURN: None 192 * 193 * DESCRIPTION: Reacquire the interpreter execution region from within the 194 * interpreter code. Failure to enter the interpreter region is a 195 * fatal system error. Used in conjunction with 196 * RelinquishInterpreter 197 * 198 ******************************************************************************/ 199 200 void 201 AcpiExReacquireInterpreter ( 202 void) 203 { 204 ACPI_FUNCTION_TRACE (ExReacquireInterpreter); 205 206 207 /* 208 * If the global serialized flag is set, do not release the interpreter, 209 * since it was not actually released by AcpiExRelinquishInterpreter. 210 * This forces the interpreter to be single threaded. 211 */ 212 if (!AcpiGbl_AllMethodsSerialized) 213 { 214 AcpiExEnterInterpreter (); 215 } 216 217 return_VOID; 218 } 219 220 221 /******************************************************************************* 222 * 223 * FUNCTION: AcpiExExitInterpreter 224 * 225 * PARAMETERS: None 226 * 227 * RETURN: None 228 * 229 * DESCRIPTION: Exit the interpreter execution region. This is the top level 230 * routine used to exit the interpreter when all processing has 231 * been completed. 232 * 233 ******************************************************************************/ 234 235 void 236 AcpiExExitInterpreter ( 237 void) 238 { 239 ACPI_STATUS Status; 240 241 242 ACPI_FUNCTION_TRACE (ExExitInterpreter); 243 244 245 Status = AcpiUtReleaseMutex (ACPI_MTX_INTERPRETER); 246 if (ACPI_FAILURE (Status)) 247 { 248 ACPI_ERROR ((AE_INFO, "Could not release AML Interpreter mutex")); 249 } 250 251 return_VOID; 252 } 253 254 255 /******************************************************************************* 256 * 257 * FUNCTION: AcpiExRelinquishInterpreter 258 * 259 * PARAMETERS: None 260 * 261 * RETURN: None 262 * 263 * DESCRIPTION: Exit the interpreter execution region, from within the 264 * interpreter - before attempting an operation that will possibly 265 * block the running thread. 266 * 267 * Cases where the interpreter is unlocked internally 268 * 1) Method to be blocked on a Sleep() AML opcode 269 * 2) Method to be blocked on an Acquire() AML opcode 270 * 3) Method to be blocked on a Wait() AML opcode 271 * 4) Method to be blocked to acquire the global lock 272 * 5) Method to be blocked waiting to execute a serialized control method 273 * that is currently executing 274 * 6) About to invoke a user-installed opregion handler 275 * 276 ******************************************************************************/ 277 278 void 279 AcpiExRelinquishInterpreter ( 280 void) 281 { 282 ACPI_FUNCTION_TRACE (ExRelinquishInterpreter); 283 284 285 /* 286 * If the global serialized flag is set, do not release the interpreter. 287 * This forces the interpreter to be single threaded. 288 */ 289 if (!AcpiGbl_AllMethodsSerialized) 290 { 291 AcpiExExitInterpreter (); 292 } 293 294 return_VOID; 295 } 296 297 298 /******************************************************************************* 299 * 300 * FUNCTION: AcpiExTruncateFor32bitTable 301 * 302 * PARAMETERS: ObjDesc - Object to be truncated 303 * 304 * RETURN: none 305 * 306 * DESCRIPTION: Truncate an ACPI Integer to 32 bits if the execution mode is 307 * 32-bit, as determined by the revision of the DSDT. 308 * 309 ******************************************************************************/ 310 311 void 312 AcpiExTruncateFor32bitTable ( 313 ACPI_OPERAND_OBJECT *ObjDesc) 314 { 315 316 ACPI_FUNCTION_ENTRY (); 317 318 319 /* 320 * Object must be a valid number and we must be executing 321 * a control method. NS node could be there for AML_INT_NAMEPATH_OP. 322 */ 323 if ((!ObjDesc) || 324 (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) != ACPI_DESC_TYPE_OPERAND) || 325 (ObjDesc->Common.Type != ACPI_TYPE_INTEGER)) 326 { 327 return; 328 } 329 330 if (AcpiGbl_IntegerByteWidth == 4) 331 { 332 /* 333 * We are running a method that exists in a 32-bit ACPI table. 334 * Truncate the value to 32 bits by zeroing out the upper 32-bit field 335 */ 336 ObjDesc->Integer.Value &= (UINT64) ACPI_UINT32_MAX; 337 } 338 } 339 340 341 /******************************************************************************* 342 * 343 * FUNCTION: AcpiExAcquireGlobalLock 344 * 345 * PARAMETERS: FieldFlags - Flags with Lock rule: 346 * AlwaysLock or NeverLock 347 * 348 * RETURN: None 349 * 350 * DESCRIPTION: Obtain the ACPI hardware Global Lock, only if the field 351 * flags specifiy that it is to be obtained before field access. 352 * 353 ******************************************************************************/ 354 355 void 356 AcpiExAcquireGlobalLock ( 357 UINT32 FieldFlags) 358 { 359 ACPI_STATUS Status; 360 361 362 ACPI_FUNCTION_TRACE (ExAcquireGlobalLock); 363 364 365 /* Only use the lock if the AlwaysLock bit is set */ 366 367 if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK)) 368 { 369 return_VOID; 370 } 371 372 /* Attempt to get the global lock, wait forever */ 373 374 Status = AcpiExAcquireMutexObject (ACPI_WAIT_FOREVER, 375 AcpiGbl_GlobalLockMutex, AcpiOsGetThreadId ()); 376 377 if (ACPI_FAILURE (Status)) 378 { 379 ACPI_EXCEPTION ((AE_INFO, Status, 380 "Could not acquire Global Lock")); 381 } 382 383 return_VOID; 384 } 385 386 387 /******************************************************************************* 388 * 389 * FUNCTION: AcpiExReleaseGlobalLock 390 * 391 * PARAMETERS: FieldFlags - Flags with Lock rule: 392 * AlwaysLock or NeverLock 393 * 394 * RETURN: None 395 * 396 * DESCRIPTION: Release the ACPI hardware Global Lock 397 * 398 ******************************************************************************/ 399 400 void 401 AcpiExReleaseGlobalLock ( 402 UINT32 FieldFlags) 403 { 404 ACPI_STATUS Status; 405 406 407 ACPI_FUNCTION_TRACE (ExReleaseGlobalLock); 408 409 410 /* Only use the lock if the AlwaysLock bit is set */ 411 412 if (!(FieldFlags & AML_FIELD_LOCK_RULE_MASK)) 413 { 414 return_VOID; 415 } 416 417 /* Release the global lock */ 418 419 Status = AcpiExReleaseMutexObject (AcpiGbl_GlobalLockMutex); 420 if (ACPI_FAILURE (Status)) 421 { 422 /* Report the error, but there isn't much else we can do */ 423 424 ACPI_EXCEPTION ((AE_INFO, Status, 425 "Could not release Global Lock")); 426 } 427 428 return_VOID; 429 } 430 431 432 /******************************************************************************* 433 * 434 * FUNCTION: AcpiExDigitsNeeded 435 * 436 * PARAMETERS: Value - Value to be represented 437 * Base - Base of representation 438 * 439 * RETURN: The number of digits. 440 * 441 * DESCRIPTION: Calculate the number of digits needed to represent the Value 442 * in the given Base (Radix) 443 * 444 ******************************************************************************/ 445 446 static UINT32 447 AcpiExDigitsNeeded ( 448 UINT64 Value, 449 UINT32 Base) 450 { 451 UINT32 NumDigits; 452 UINT64 CurrentValue; 453 454 455 ACPI_FUNCTION_TRACE (ExDigitsNeeded); 456 457 458 /* UINT64 is unsigned, so we don't worry about a '-' prefix */ 459 460 if (Value == 0) 461 { 462 return_UINT32 (1); 463 } 464 465 CurrentValue = Value; 466 NumDigits = 0; 467 468 /* Count the digits in the requested base */ 469 470 while (CurrentValue) 471 { 472 (void) AcpiUtShortDivide (CurrentValue, Base, &CurrentValue, NULL); 473 NumDigits++; 474 } 475 476 return_UINT32 (NumDigits); 477 } 478 479 480 /******************************************************************************* 481 * 482 * FUNCTION: AcpiExEisaIdToString 483 * 484 * PARAMETERS: CompressedId - EISAID to be converted 485 * OutString - Where to put the converted string (8 bytes) 486 * 487 * RETURN: None 488 * 489 * DESCRIPTION: Convert a numeric EISAID to string representation. Return 490 * buffer must be large enough to hold the string. The string 491 * returned is always exactly of length ACPI_EISAID_STRING_SIZE 492 * (includes null terminator). The EISAID is always 32 bits. 493 * 494 ******************************************************************************/ 495 496 void 497 AcpiExEisaIdToString ( 498 char *OutString, 499 UINT64 CompressedId) 500 { 501 UINT32 SwappedId; 502 503 504 ACPI_FUNCTION_ENTRY (); 505 506 507 /* The EISAID should be a 32-bit integer */ 508 509 if (CompressedId > ACPI_UINT32_MAX) 510 { 511 ACPI_WARNING ((AE_INFO, 512 "Expected EISAID is larger than 32 bits: 0x%8.8X%8.8X, truncating", 513 ACPI_FORMAT_UINT64 (CompressedId))); 514 } 515 516 /* Swap ID to big-endian to get contiguous bits */ 517 518 SwappedId = AcpiUtDwordByteSwap ((UINT32) CompressedId); 519 520 /* First 3 bytes are uppercase letters. Next 4 bytes are hexadecimal */ 521 522 OutString[0] = (char) (0x40 + (((unsigned long) SwappedId >> 26) & 0x1F)); 523 OutString[1] = (char) (0x40 + ((SwappedId >> 21) & 0x1F)); 524 OutString[2] = (char) (0x40 + ((SwappedId >> 16) & 0x1F)); 525 OutString[3] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 12); 526 OutString[4] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 8); 527 OutString[5] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 4); 528 OutString[6] = AcpiUtHexToAsciiChar ((UINT64) SwappedId, 0); 529 OutString[7] = 0; 530 } 531 532 533 /******************************************************************************* 534 * 535 * FUNCTION: AcpiExIntegerToString 536 * 537 * PARAMETERS: OutString - Where to put the converted string. At least 538 * 21 bytes are needed to hold the largest 539 * possible 64-bit integer. 540 * Value - Value to be converted 541 * 542 * RETURN: None, string 543 * 544 * DESCRIPTION: Convert a 64-bit integer to decimal string representation. 545 * Assumes string buffer is large enough to hold the string. The 546 * largest string is (ACPI_MAX64_DECIMAL_DIGITS + 1). 547 * 548 ******************************************************************************/ 549 550 void 551 AcpiExIntegerToString ( 552 char *OutString, 553 UINT64 Value) 554 { 555 UINT32 Count; 556 UINT32 DigitsNeeded; 557 UINT32 Remainder; 558 559 560 ACPI_FUNCTION_ENTRY (); 561 562 563 DigitsNeeded = AcpiExDigitsNeeded (Value, 10); 564 OutString[DigitsNeeded] = 0; 565 566 for (Count = DigitsNeeded; Count > 0; Count--) 567 { 568 (void) AcpiUtShortDivide (Value, 10, &Value, &Remainder); 569 OutString[Count-1] = (char) ('0' + Remainder);\ 570 } 571 } 572 573 574 /******************************************************************************* 575 * 576 * FUNCTION: AcpiIsValidSpaceId 577 * 578 * PARAMETERS: SpaceId - ID to be validated 579 * 580 * RETURN: TRUE if valid/supported ID. 581 * 582 * DESCRIPTION: Validate an operation region SpaceID. 583 * 584 ******************************************************************************/ 585 586 BOOLEAN 587 AcpiIsValidSpaceId ( 588 UINT8 SpaceId) 589 { 590 591 if ((SpaceId >= ACPI_NUM_PREDEFINED_REGIONS) && 592 (SpaceId < ACPI_USER_REGION_BEGIN) && 593 (SpaceId != ACPI_ADR_SPACE_DATA_TABLE) && 594 (SpaceId != ACPI_ADR_SPACE_FIXED_HARDWARE)) 595 { 596 return (FALSE); 597 } 598 599 return (TRUE); 600 } 601 602 603 #endif 604