exutils.c revision 100966
1 2/****************************************************************************** 3 * 4 * Module Name: exutils - interpreter/scanner utilities 5 * $Revision: 102 $ 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 "acinterp.h" 138#include "amlcode.h" 139#include "acevents.h" 140 141#define _COMPONENT ACPI_EXECUTER 142 ACPI_MODULE_NAME ("exutils") 143 144 145/******************************************************************************* 146 * 147 * FUNCTION: AcpiExValidateObjectType 148 * 149 * PARAMETERS: Type Object type to validate 150 * 151 * DESCRIPTION: Determine if a type is a valid ACPI object type 152 * 153 ******************************************************************************/ 154 155BOOLEAN 156AcpiExValidateObjectType ( 157 ACPI_OBJECT_TYPE Type) 158{ 159 160 ACPI_FUNCTION_ENTRY (); 161 162 163 if ((Type > ACPI_TYPE_MAX && Type < INTERNAL_TYPE_BEGIN) || 164 (Type > INTERNAL_TYPE_MAX)) 165 { 166 return (FALSE); 167 } 168 169 return (TRUE); 170} 171 172#ifndef ACPI_NO_METHOD_EXECUTION 173 174/******************************************************************************* 175 * 176 * FUNCTION: AcpiExEnterInterpreter 177 * 178 * PARAMETERS: None 179 * 180 * DESCRIPTION: Enter the interpreter execution region. Failure to enter 181 * the interpreter region is a fatal system error 182 * 183 ******************************************************************************/ 184 185ACPI_STATUS 186AcpiExEnterInterpreter (void) 187{ 188 ACPI_STATUS Status; 189 190 ACPI_FUNCTION_TRACE ("ExEnterInterpreter"); 191 192 193 Status = AcpiUtAcquireMutex (ACPI_MTX_EXECUTE); 194 if (ACPI_FAILURE (Status)) 195 { 196 ACPI_REPORT_ERROR (("Could not acquire interpreter mutex\n")); 197 } 198 199 return_ACPI_STATUS (Status); 200} 201 202 203/******************************************************************************* 204 * 205 * FUNCTION: AcpiExExitInterpreter 206 * 207 * PARAMETERS: None 208 * 209 * DESCRIPTION: Exit the interpreter execution region 210 * 211 * Cases where the interpreter is unlocked: 212 * 1) Completion of the execution of a control method 213 * 2) Method blocked on a Sleep() AML opcode 214 * 3) Method blocked on an Acquire() AML opcode 215 * 4) Method blocked on a Wait() AML opcode 216 * 5) Method blocked to acquire the global lock 217 * 6) Method blocked to execute a serialized control method that is 218 * already executing 219 * 7) About to invoke a user-installed opregion handler 220 * 221 ******************************************************************************/ 222 223void 224AcpiExExitInterpreter (void) 225{ 226 ACPI_STATUS Status; 227 228 229 ACPI_FUNCTION_TRACE ("ExExitInterpreter"); 230 231 232 Status = AcpiUtReleaseMutex (ACPI_MTX_EXECUTE); 233 if (ACPI_FAILURE (Status)) 234 { 235 ACPI_REPORT_ERROR (("Could not release interpreter mutex\n")); 236 } 237 238 return_VOID; 239} 240 241 242/******************************************************************************* 243 * 244 * FUNCTION: AcpiExTruncateFor32bitTable 245 * 246 * PARAMETERS: ObjDesc - Object to be truncated 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{ 259 260 ACPI_FUNCTION_ENTRY (); 261 262 263 /* 264 * Object must be a valid number and we must be executing 265 * a control method 266 */ 267 if ((!ObjDesc) || 268 (ACPI_GET_OBJECT_TYPE (ObjDesc) != ACPI_TYPE_INTEGER)) 269 { 270 return; 271 } 272 273 if (AcpiGbl_IntegerByteWidth == 4) 274 { 275 /* 276 * We are running a method that exists in a 32-bit ACPI table. 277 * Truncate the value to 32 bits by zeroing out the upper 32-bit field 278 */ 279 ObjDesc->Integer.Value &= (ACPI_INTEGER) ACPI_UINT32_MAX; 280 } 281} 282 283 284/******************************************************************************* 285 * 286 * FUNCTION: AcpiExAcquireGlobalLock 287 * 288 * PARAMETERS: FieldFlags - Flags with Lock rule: 289 * AlwaysLock or NeverLock 290 * 291 * RETURN: TRUE/FALSE indicating whether the lock was actually acquired 292 * 293 * DESCRIPTION: Obtain the global lock and keep track of this fact via two 294 * methods. A global variable keeps the state of the lock, and 295 * the state is returned to the caller. 296 * 297 ******************************************************************************/ 298 299BOOLEAN 300AcpiExAcquireGlobalLock ( 301 UINT32 FieldFlags) 302{ 303 BOOLEAN Locked = FALSE; 304 ACPI_STATUS Status; 305 306 307 ACPI_FUNCTION_TRACE ("ExAcquireGlobalLock"); 308 309 310 /* Only attempt lock if the AlwaysLock bit is set */ 311 312 if (FieldFlags & AML_FIELD_LOCK_RULE_MASK) 313 { 314 /* We should attempt to get the lock, wait forever */ 315 316 Status = AcpiEvAcquireGlobalLock (ACPI_UINT32_MAX); 317 if (ACPI_SUCCESS (Status)) 318 { 319 Locked = TRUE; 320 } 321 else 322 { 323 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not acquire Global Lock, %s\n", 324 AcpiFormatException (Status))); 325 } 326 } 327 328 return_VALUE (Locked); 329} 330 331 332/******************************************************************************* 333 * 334 * FUNCTION: AcpiExReleaseGlobalLock 335 * 336 * PARAMETERS: LockedByMe - Return value from corresponding call to 337 * AcquireGlobalLock. 338 * 339 * RETURN: Status 340 * 341 * DESCRIPTION: Release the global lock if it is locked. 342 * 343 ******************************************************************************/ 344 345void 346AcpiExReleaseGlobalLock ( 347 BOOLEAN LockedByMe) 348{ 349 ACPI_STATUS Status; 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 Status = AcpiEvReleaseGlobalLock (); 362 if (ACPI_FAILURE (Status)) 363 { 364 /* Report the error, but there isn't much else we can do */ 365 366 ACPI_REPORT_ERROR (("Could not release ACPI Global Lock\n")); 367 } 368 } 369 370 return_VOID; 371} 372 373 374/******************************************************************************* 375 * 376 * FUNCTION: AcpiExDigitsNeeded 377 * 378 * PARAMETERS: Value - Value to be represented 379 * Base - Base of representation 380 * 381 * RETURN: the number of digits needed to represent Value in Base 382 * 383 ******************************************************************************/ 384 385UINT32 386AcpiExDigitsNeeded ( 387 ACPI_INTEGER Value, 388 UINT32 Base) 389{ 390 UINT32 NumDigits; 391 ACPI_INTEGER CurrentValue; 392 ACPI_INTEGER Quotient; 393 394 395 ACPI_FUNCTION_TRACE ("ExDigitsNeeded"); 396 397 398 /* 399 * ACPI_INTEGER is unsigned, so we don't worry about a '-' 400 */ 401 CurrentValue = Value; 402 NumDigits = 0; 403 404 while (CurrentValue) 405 { 406 (void) AcpiUtShortDivide (&CurrentValue, Base, &Quotient, NULL); 407 NumDigits++; 408 CurrentValue = Quotient; 409 } 410 411 return_VALUE (NumDigits); 412} 413 414 415/******************************************************************************* 416 * 417 * FUNCTION: AcpiExEisaIdToString 418 * 419 * PARAMETERS: NumericId - EISA ID to be converted 420 * OutString - Where to put the converted string (8 bytes) 421 * 422 * DESCRIPTION: Convert a numeric EISA ID to string representation 423 * 424 ******************************************************************************/ 425 426void 427AcpiExEisaIdToString ( 428 UINT32 NumericId, 429 NATIVE_CHAR *OutString) 430{ 431 UINT32 EisaId; 432 433 434 ACPI_FUNCTION_ENTRY (); 435 436 437 /* Swap ID to big-endian to get contiguous bits */ 438 439 EisaId = AcpiUtDwordByteSwap (NumericId); 440 441 OutString[0] = (char) ('@' + ((EisaId >> 26) & 0x1f)); 442 OutString[1] = (char) ('@' + ((EisaId >> 21) & 0x1f)); 443 OutString[2] = (char) ('@' + ((EisaId >> 16) & 0x1f)); 444 OutString[3] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 12); 445 OutString[4] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 8); 446 OutString[5] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 4); 447 OutString[6] = AcpiUtHexToAsciiChar ((ACPI_INTEGER) EisaId, 0); 448 OutString[7] = 0; 449} 450 451 452/******************************************************************************* 453 * 454 * FUNCTION: AcpiExUnsignedIntegerToString 455 * 456 * PARAMETERS: Value - Value to be converted 457 * OutString - Where to put the converted string (8 bytes) 458 * 459 * RETURN: Convert a number to string representation 460 * 461 ******************************************************************************/ 462 463void 464AcpiExUnsignedIntegerToString ( 465 ACPI_INTEGER Value, 466 NATIVE_CHAR *OutString) 467{ 468 UINT32 Count; 469 UINT32 DigitsNeeded; 470 UINT32 Remainder; 471 ACPI_INTEGER Quotient; 472 473 474 ACPI_FUNCTION_ENTRY (); 475 476 477 DigitsNeeded = AcpiExDigitsNeeded (Value, 10); 478 OutString[DigitsNeeded] = 0; 479 480 for (Count = DigitsNeeded; Count > 0; Count--) 481 { 482 (void) AcpiUtShortDivide (&Value, 10, &Quotient, &Remainder); 483 OutString[Count-1] = (NATIVE_CHAR) ('0' + Remainder);\ 484 Value = Quotient; 485 } 486} 487 488#endif 489