utxface.c revision 77424
1/****************************************************************************** 2 * 3 * Module Name: utxface - External interfaces for "global" ACPI functions 4 * $Revision: 72 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118#define __UTXFACE_C__ 119 120#include "acpi.h" 121#include "acevents.h" 122#include "achware.h" 123#include "acnamesp.h" 124#include "acinterp.h" 125#include "amlcode.h" 126#include "acdebug.h" 127 128 129#define _COMPONENT ACPI_UTILITIES 130 MODULE_NAME ("utxface") 131 132 133/******************************************************************************* 134 * 135 * FUNCTION: AcpiInitializeSubsystem 136 * 137 * PARAMETERS: None 138 * 139 * RETURN: Status 140 * 141 * DESCRIPTION: Initializes all global variables. This is the first function 142 * called, so any early initialization belongs here. 143 * 144 ******************************************************************************/ 145 146ACPI_STATUS 147AcpiInitializeSubsystem ( 148 void) 149{ 150 ACPI_STATUS Status; 151 152 FUNCTION_TRACE ("AcpiInitializeSubsystem"); 153 154 155 /* Initialize all globals used by the subsystem */ 156 157 AcpiUtInitGlobals (); 158 159 /* Initialize the OS-Dependent layer */ 160 161 Status = AcpiOsInitialize (); 162 if (ACPI_FAILURE (Status)) 163 { 164 REPORT_ERROR (("OSD failed to initialize, %s\n", 165 AcpiUtFormatException (Status))); 166 return_ACPI_STATUS (Status); 167 } 168 169 /* Create the default mutex objects */ 170 171 Status = AcpiUtMutexInitialize (); 172 if (ACPI_FAILURE (Status)) 173 { 174 REPORT_ERROR (("Global mutex creation failure, %s\n", 175 AcpiUtFormatException (Status))); 176 return_ACPI_STATUS (Status); 177 } 178 179 /* 180 * Initialize the namespace manager and 181 * the root of the namespace tree 182 */ 183 184 Status = AcpiNsRootInitialize (); 185 if (ACPI_FAILURE (Status)) 186 { 187 REPORT_ERROR (("Namespace initialization failure, %s\n", 188 AcpiUtFormatException (Status))); 189 return_ACPI_STATUS (Status); 190 } 191 192 193 /* If configured, initialize the AML debugger */ 194 195 DEBUGGER_EXEC (AcpiDbInitialize ()); 196 197 return_ACPI_STATUS (Status); 198} 199 200 201/******************************************************************************* 202 * 203 * FUNCTION: AcpiEnableSubsystem 204 * 205 * PARAMETERS: Flags - Init/enable Options 206 * 207 * RETURN: Status 208 * 209 * DESCRIPTION: Completes the subsystem initialization including hardware. 210 * Puts system into ACPI mode if it isn't already. 211 * 212 ******************************************************************************/ 213 214ACPI_STATUS 215AcpiEnableSubsystem ( 216 UINT32 Flags) 217{ 218 ACPI_STATUS Status = AE_OK; 219 220 221 FUNCTION_TRACE ("AcpiEnableSubsystem"); 222 223 224 /* Sanity check the FADT for valid values */ 225 226 Status = AcpiUtValidateFadt (); 227 if (ACPI_FAILURE (Status)) 228 { 229 return_ACPI_STATUS (Status); 230 } 231 232 /* 233 * Install the default OpRegion handlers. These are 234 * installed unless other handlers have already been 235 * installed via the InstallAddressSpaceHandler interface 236 */ 237 238 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT)) 239 { 240 DEBUG_PRINT (TRACE_EXEC, ("[Init] Installing default address space handlers\n")); 241 242 Status = AcpiEvInstallDefaultAddressSpaceHandlers (); 243 if (ACPI_FAILURE (Status)) 244 { 245 return_ACPI_STATUS (Status); 246 } 247 } 248 249 /* 250 * We must initialize the hardware before we can enable ACPI. 251 */ 252 253 if (!(Flags & ACPI_NO_HARDWARE_INIT)) 254 { 255 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI hardware\n")); 256 257 Status = AcpiHwInitialize (); 258 if (ACPI_FAILURE (Status)) 259 { 260 return_ACPI_STATUS (Status); 261 } 262 } 263 264 /* 265 * Enable ACPI on this platform 266 */ 267 268 if (!(Flags & ACPI_NO_ACPI_ENABLE)) 269 { 270 DEBUG_PRINT (TRACE_EXEC, ("[Init] Going into ACPI mode\n")); 271 272 Status = AcpiEnable (); 273 if (ACPI_FAILURE (Status)) 274 { 275 DEBUG_PRINT(ACPI_WARN, ("AcpiEnable failed.\n")); 276 return_ACPI_STATUS (Status); 277 } 278 } 279 280 /* 281 * Note: 282 * We must have the hardware AND events initialized before we can execute 283 * ANY control methods SAFELY. Any control method can require ACPI hardware 284 * support, so the hardware MUST be initialized before execution! 285 */ 286 287 if (!(Flags & ACPI_NO_EVENT_INIT)) 288 { 289 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI events\n")); 290 291 Status = AcpiEvInitialize (); 292 if (ACPI_FAILURE (Status)) 293 { 294 return_ACPI_STATUS (Status); 295 } 296 } 297 298 299 /* 300 * Initialize all device objects in the namespace 301 * This runs the _STA and _INI methods. 302 */ 303 304 if (!(Flags & ACPI_NO_DEVICE_INIT)) 305 { 306 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI Devices\n")); 307 308 Status = AcpiNsInitializeDevices (); 309 if (ACPI_FAILURE (Status)) 310 { 311 return_ACPI_STATUS (Status); 312 } 313 } 314 315 316 /* 317 * Initialize the objects that remain uninitialized. This 318 * runs the executable AML that is part of the declaration of OpRegions 319 * and Fields. 320 */ 321 322 if (!(Flags & ACPI_NO_OBJECT_INIT)) 323 { 324 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI Objects\n")); 325 326 Status = AcpiNsInitializeObjects (); 327 if (ACPI_FAILURE (Status)) 328 { 329 return_ACPI_STATUS (Status); 330 } 331 } 332 333 334 return_ACPI_STATUS (Status); 335} 336 337 338/******************************************************************************* 339 * 340 * FUNCTION: AcpiTerminate 341 * 342 * PARAMETERS: None 343 * 344 * RETURN: Status 345 * 346 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources. 347 * 348 ******************************************************************************/ 349 350ACPI_STATUS 351AcpiTerminate (void) 352{ 353 ACPI_STATUS Status; 354 355 356 FUNCTION_TRACE ("AcpiTerminate"); 357 358 359 /* Ensure that ACPI has been initialized */ 360 361 ACPI_IS_INITIALIZATION_COMPLETE (Status); 362 if (ACPI_FAILURE (Status)) 363 { 364 return_ACPI_STATUS (Status); 365 } 366 367 /* Terminate the AML Debugger if present */ 368 369 DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE); 370 371 /* TBD: [Investigate] This is no longer needed?*/ 372/* AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_READY); */ 373 374 375 /* Shutdown and free all resources */ 376 377 AcpiUtSubsystemShutdown (); 378 379 380 /* Free the mutex objects */ 381 382 AcpiUtMutexTerminate (); 383 384 385 /* Now we can shutdown the OS-dependent layer */ 386 387 AcpiOsTerminate (); 388 389 return_ACPI_STATUS (AE_OK); 390} 391 392 393/****************************************************************************** 394 * 395 * FUNCTION: AcpiGetSystemInfo 396 * 397 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 398 * resources for the device 399 * BufferLength - the number of bytes available in the buffer 400 * 401 * RETURN: Status - the status of the call 402 * 403 * DESCRIPTION: This function is called to get information about the current 404 * state of the ACPI subsystem. It will return system information 405 * in the OutBuffer. 406 * 407 * If the function fails an appropriate status will be returned 408 * and the value of OutBuffer is undefined. 409 * 410 ******************************************************************************/ 411 412ACPI_STATUS 413AcpiGetSystemInfo ( 414 ACPI_BUFFER *OutBuffer) 415{ 416 ACPI_SYSTEM_INFO *InfoPtr; 417 UINT32 i; 418 ACPI_STATUS Status; 419 420 421 FUNCTION_TRACE ("AcpiGetSystemInfo"); 422 423 424 /* Ensure that ACPI has been initialized */ 425 426 ACPI_IS_INITIALIZATION_COMPLETE (Status); 427 if (ACPI_FAILURE (Status)) 428 { 429 return_ACPI_STATUS (Status); 430 } 431 432 /* 433 * Must have a valid buffer 434 */ 435 if ((!OutBuffer) || 436 (!OutBuffer->Pointer)) 437 { 438 return_ACPI_STATUS (AE_BAD_PARAMETER); 439 } 440 441 if (OutBuffer->Length < sizeof (ACPI_SYSTEM_INFO)) 442 { 443 /* 444 * Caller's buffer is too small 445 */ 446 OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO); 447 448 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 449 } 450 451 452 /* 453 * Set return length and get data 454 */ 455 OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO); 456 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer; 457 458 InfoPtr->AcpiCaVersion = ACPI_CA_VERSION; 459 460 /* System flags (ACPI capabilities) */ 461 462 InfoPtr->Flags = AcpiGbl_SystemFlags; 463 464 /* Timer resolution - 24 or 32 bits */ 465 if (!AcpiGbl_FADT) 466 { 467 InfoPtr->TimerResolution = 0; 468 } 469 else if (AcpiGbl_FADT->TmrValExt == 0) 470 { 471 InfoPtr->TimerResolution = 24; 472 } 473 else 474 { 475 InfoPtr->TimerResolution = 32; 476 } 477 478 /* Clear the reserved fields */ 479 480 InfoPtr->Reserved1 = 0; 481 InfoPtr->Reserved2 = 0; 482 483 /* Current debug levels */ 484 485 InfoPtr->DebugLayer = AcpiDbgLayer; 486 InfoPtr->DebugLevel = AcpiDbgLevel; 487 488 /* Current status of the ACPI tables, per table type */ 489 490 InfoPtr->NumTableTypes = NUM_ACPI_TABLES; 491 for (i = 0; i < NUM_ACPI_TABLES; i++) 492 { 493 InfoPtr->TableInfo[i].Count = AcpiGbl_AcpiTables[i].Count; 494 } 495 496 return_ACPI_STATUS (AE_OK); 497} 498 499 500/****************************************************************************** 501 * 502 * FUNCTION: AcpiFormatException 503 * 504 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 505 * exception name 506 * 507 * RETURN: Status - the status of the call 508 * 509 * DESCRIPTION: This function translates an ACPI exception into an ASCII string. 510 * 511 ******************************************************************************/ 512 513ACPI_STATUS 514AcpiFormatException ( 515 ACPI_STATUS Exception, 516 ACPI_BUFFER *OutBuffer) 517{ 518 UINT32 Length; 519 NATIVE_CHAR *FormattedException; 520 521 522 FUNCTION_TRACE ("AcpiFormatException"); 523 524 525 /* 526 * Must have a valid buffer 527 */ 528 if ((!OutBuffer) || 529 (!OutBuffer->Pointer)) 530 { 531 return_ACPI_STATUS (AE_BAD_PARAMETER); 532 } 533 534 535 /* Convert the exception code (Handles bad exception codes) */ 536 537 FormattedException = AcpiUtFormatException (Exception); 538 539 /* 540 * Get length of string and check if it will fit in caller's buffer 541 */ 542 543 Length = STRLEN (FormattedException); 544 if (OutBuffer->Length < Length) 545 { 546 OutBuffer->Length = Length; 547 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 548 } 549 550 551 /* Copy the string, all done */ 552 553 STRCPY (OutBuffer->Pointer, FormattedException); 554 555 return_ACPI_STATUS (AE_OK); 556} 557 558 559/***************************************************************************** 560 * 561 * FUNCTION: AcpiAllocate 562 * 563 * PARAMETERS: Size - Size of the allocation 564 * 565 * RETURN: Address of the allocated memory on success, NULL on failure. 566 * 567 * DESCRIPTION: The subsystem's equivalent of malloc. 568 * External front-end to the Ut* memory manager 569 * 570 ****************************************************************************/ 571 572void * 573AcpiAllocate ( 574 UINT32 Size) 575{ 576 577 return (AcpiUtAllocate (Size)); 578} 579 580 581/***************************************************************************** 582 * 583 * FUNCTION: AcpiCallocate 584 * 585 * PARAMETERS: Size - Size of the allocation 586 * 587 * RETURN: Address of the allocated memory on success, NULL on failure. 588 * 589 * DESCRIPTION: The subsystem's equivalent of calloc. 590 * External front-end to the Ut* memory manager 591 * 592 ****************************************************************************/ 593 594void * 595AcpiCallocate ( 596 UINT32 Size) 597{ 598 599 return (AcpiUtCallocate (Size)); 600} 601 602 603/***************************************************************************** 604 * 605 * FUNCTION: AcpiFree 606 * 607 * PARAMETERS: Address - Address of the memory to deallocate 608 * 609 * RETURN: None 610 * 611 * DESCRIPTION: Frees the memory at Address 612 * External front-end to the Ut* memory manager 613 * 614 ****************************************************************************/ 615 616void 617AcpiFree ( 618 void *Address) 619{ 620 621 AcpiUtFree (Address); 622} 623