utxface.c revision 100966
1/****************************************************************************** 2 * 3 * Module Name: utxface - External interfaces for "global" ACPI functions 4 * $Revision: 97 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 "acnamesp.h" 123#include "acparser.h" 124#include "acdispat.h" 125#include "acdebug.h" 126 127#define _COMPONENT ACPI_UTILITIES 128 ACPI_MODULE_NAME ("utxface") 129 130 131/******************************************************************************* 132 * 133 * FUNCTION: AcpiInitializeSubsystem 134 * 135 * PARAMETERS: None 136 * 137 * RETURN: Status 138 * 139 * DESCRIPTION: Initializes all global variables. This is the first function 140 * called, so any early initialization belongs here. 141 * 142 ******************************************************************************/ 143 144ACPI_STATUS 145AcpiInitializeSubsystem ( 146 void) 147{ 148 ACPI_STATUS Status; 149 150 ACPI_FUNCTION_TRACE ("AcpiInitializeSubsystem"); 151 152 153 ACPI_DEBUG_EXEC (AcpiUtInitStackPtrTrace ()); 154 155 156 /* Initialize all globals used by the subsystem */ 157 158 AcpiUtInitGlobals (); 159 160 /* Initialize the OS-Dependent layer */ 161 162 Status = AcpiOsInitialize (); 163 if (ACPI_FAILURE (Status)) 164 { 165 ACPI_REPORT_ERROR (("OSD failed to initialize, %s\n", 166 AcpiFormatException (Status))); 167 return_ACPI_STATUS (Status); 168 } 169 170 /* Create the default mutex objects */ 171 172 Status = AcpiUtMutexInitialize (); 173 if (ACPI_FAILURE (Status)) 174 { 175 ACPI_REPORT_ERROR (("Global mutex creation failure, %s\n", 176 AcpiFormatException (Status))); 177 return_ACPI_STATUS (Status); 178 } 179 180 /* 181 * Initialize the namespace manager and 182 * the root of the namespace tree 183 */ 184 185 Status = AcpiNsRootInitialize (); 186 if (ACPI_FAILURE (Status)) 187 { 188 ACPI_REPORT_ERROR (("Namespace initialization failure, %s\n", 189 AcpiFormatException (Status))); 190 return_ACPI_STATUS (Status); 191 } 192 193 194 /* If configured, initialize the AML debugger */ 195 196 ACPI_DEBUGGER_EXEC (Status = AcpiDbInitialize ()); 197 198 return_ACPI_STATUS (Status); 199} 200 201 202/******************************************************************************* 203 * 204 * FUNCTION: AcpiEnableSubsystem 205 * 206 * PARAMETERS: Flags - Init/enable Options 207 * 208 * RETURN: Status 209 * 210 * DESCRIPTION: Completes the subsystem initialization including hardware. 211 * Puts system into ACPI mode if it isn't already. 212 * 213 ******************************************************************************/ 214 215ACPI_STATUS 216AcpiEnableSubsystem ( 217 UINT32 Flags) 218{ 219 ACPI_STATUS Status = AE_OK; 220 221 222 ACPI_FUNCTION_TRACE ("AcpiEnableSubsystem"); 223 224 225 /* 226 * Install the default OpRegion handlers. These are installed unless 227 * other handlers have already been installed via the 228 * InstallAddressSpaceHandler interface 229 */ 230 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT)) 231 { 232 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Installing default address space handlers\n")); 233 234 Status = AcpiEvInitAddressSpaces (); 235 if (ACPI_FAILURE (Status)) 236 { 237 return_ACPI_STATUS (Status); 238 } 239 } 240 241 /* 242 * We must initialize the hardware before we can enable ACPI. 243 * FADT values are validated here. 244 */ 245 if (!(Flags & ACPI_NO_HARDWARE_INIT)) 246 { 247 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI hardware\n")); 248 249 Status = AcpiHwInitialize (); 250 if (ACPI_FAILURE (Status)) 251 { 252 return_ACPI_STATUS (Status); 253 } 254 } 255 256 /* 257 * Enable ACPI on this platform 258 */ 259 if (!(Flags & ACPI_NO_ACPI_ENABLE)) 260 { 261 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Going into ACPI mode\n")); 262 263 Status = AcpiEnable (); 264 if (ACPI_FAILURE (Status)) 265 { 266 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "AcpiEnable failed.\n")); 267 return_ACPI_STATUS (Status); 268 } 269 } 270 271 /* 272 * Note: 273 * We must have the hardware AND events initialized before we can execute 274 * ANY control methods SAFELY. Any control method can require ACPI hardware 275 * support, so the hardware MUST be initialized before execution! 276 */ 277 if (!(Flags & ACPI_NO_EVENT_INIT)) 278 { 279 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI events\n")); 280 281 Status = AcpiEvInitialize (); 282 if (ACPI_FAILURE (Status)) 283 { 284 return_ACPI_STATUS (Status); 285 } 286 } 287 288 /* Install SCI handler, Global Lock handler, GPE handlers */ 289 290 if (!(Flags & ACPI_NO_HANDLER_INIT)) 291 { 292 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Installing SCI/GL/GPE handlers\n")); 293 294 Status = AcpiEvHandlerInitialize (); 295 if (ACPI_FAILURE (Status)) 296 { 297 return_ACPI_STATUS (Status); 298 } 299 } 300 301 return_ACPI_STATUS (Status); 302} 303 304/******************************************************************************* 305 * 306 * FUNCTION: AcpiInitializeObjects 307 * 308 * PARAMETERS: Flags - Init/enable Options 309 * 310 * RETURN: Status 311 * 312 * DESCRIPTION: Completes namespace initialization by initializing device 313 * objects and executing AML code for Regions, buffers, etc. 314 * 315 ******************************************************************************/ 316 317ACPI_STATUS 318AcpiInitializeObjects ( 319 UINT32 Flags) 320{ 321 ACPI_STATUS Status = AE_OK; 322 323 324 ACPI_FUNCTION_TRACE ("AcpiInitializeObjects"); 325 326 /* 327 * Initialize all device objects in the namespace 328 * This runs the _STA and _INI methods. 329 */ 330 if (!(Flags & ACPI_NO_DEVICE_INIT)) 331 { 332 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI Devices\n")); 333 334 Status = AcpiNsInitializeDevices (); 335 if (ACPI_FAILURE (Status)) 336 { 337 return_ACPI_STATUS (Status); 338 } 339 } 340 341 /* 342 * Initialize the objects that remain uninitialized. This 343 * runs the executable AML that is part of the declaration of OpRegions 344 * and Fields. 345 */ 346 if (!(Flags & ACPI_NO_OBJECT_INIT)) 347 { 348 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI Objects\n")); 349 350 Status = AcpiNsInitializeObjects (); 351 if (ACPI_FAILURE (Status)) 352 { 353 return_ACPI_STATUS (Status); 354 } 355 } 356 357 /* 358 * Empty the caches (delete the cached objects) on the assumption that 359 * the table load filled them up more than they will be at runtime -- 360 * thus wasting non-paged memory. 361 */ 362 Status = AcpiPurgeCachedObjects (); 363 364 AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK; 365 return_ACPI_STATUS (Status); 366} 367 368 369/******************************************************************************* 370 * 371 * FUNCTION: AcpiTerminate 372 * 373 * PARAMETERS: None 374 * 375 * RETURN: Status 376 * 377 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources. 378 * 379 ******************************************************************************/ 380 381ACPI_STATUS 382AcpiTerminate (void) 383{ 384 ACPI_STATUS Status; 385 386 387 ACPI_FUNCTION_TRACE ("AcpiTerminate"); 388 389 390 /* Terminate the AML Debugger if present */ 391 392 ACPI_DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE); 393 394 /* Shutdown and free all resources */ 395 396 AcpiUtSubsystemShutdown (); 397 398 399 /* Free the mutex objects */ 400 401 AcpiUtMutexTerminate (); 402 403 404#ifdef ENABLE_DEBUGGER 405 406 /* Shut down the debugger */ 407 408 AcpiDbTerminate (); 409#endif 410 411 /* Now we can shutdown the OS-dependent layer */ 412 413 Status = AcpiOsTerminate (); 414 return_ACPI_STATUS (Status); 415} 416 417 418/***************************************************************************** 419 * 420 * FUNCTION: AcpiSubsystemStatus 421 * 422 * PARAMETERS: None 423 * 424 * RETURN: Status of the ACPI subsystem 425 * 426 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this 427 * before making any other calls, to ensure the subsystem initial- 428 * ized successfully. 429 * 430 ****************************************************************************/ 431 432ACPI_STATUS 433AcpiSubsystemStatus (void) 434{ 435 if (AcpiGbl_StartupFlags & ACPI_INITIALIZED_OK) 436 { 437 return (AE_OK); 438 } 439 else 440 { 441 return (AE_ERROR); 442 } 443} 444 445 446/****************************************************************************** 447 * 448 * FUNCTION: AcpiGetSystemInfo 449 * 450 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 451 * resources for the device 452 * BufferLength - the number of bytes available in the buffer 453 * 454 * RETURN: Status - the status of the call 455 * 456 * DESCRIPTION: This function is called to get information about the current 457 * state of the ACPI subsystem. It will return system information 458 * in the OutBuffer. 459 * 460 * If the function fails an appropriate status will be returned 461 * and the value of OutBuffer is undefined. 462 * 463 ******************************************************************************/ 464 465ACPI_STATUS 466AcpiGetSystemInfo ( 467 ACPI_BUFFER *OutBuffer) 468{ 469 ACPI_SYSTEM_INFO *InfoPtr; 470 UINT32 i; 471 ACPI_STATUS Status; 472 473 474 ACPI_FUNCTION_TRACE ("AcpiGetSystemInfo"); 475 476 477 /* Parameter validation */ 478 479 Status = AcpiUtValidateBuffer (OutBuffer); 480 if (ACPI_FAILURE (Status)) 481 { 482 return_ACPI_STATUS (Status); 483 } 484 485 /* Validate/Allocate/Clear caller buffer */ 486 487 Status = AcpiUtInitializeBuffer (OutBuffer, sizeof (ACPI_SYSTEM_INFO)); 488 if (ACPI_FAILURE (Status)) 489 { 490 return_ACPI_STATUS (Status); 491 } 492 493 /* 494 * Populate the return buffer 495 */ 496 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer; 497 498 InfoPtr->AcpiCaVersion = ACPI_CA_VERSION; 499 500 /* System flags (ACPI capabilities) */ 501 502 InfoPtr->Flags = ACPI_SYS_MODE_ACPI; 503 504 /* Timer resolution - 24 or 32 bits */ 505 506 if (!AcpiGbl_FADT) 507 { 508 InfoPtr->TimerResolution = 0; 509 } 510 else if (AcpiGbl_FADT->TmrValExt == 0) 511 { 512 InfoPtr->TimerResolution = 24; 513 } 514 else 515 { 516 InfoPtr->TimerResolution = 32; 517 } 518 519 /* Clear the reserved fields */ 520 521 InfoPtr->Reserved1 = 0; 522 InfoPtr->Reserved2 = 0; 523 524 /* Current debug levels */ 525 526 InfoPtr->DebugLayer = AcpiDbgLayer; 527 InfoPtr->DebugLevel = AcpiDbgLevel; 528 529 /* Current status of the ACPI tables, per table type */ 530 531 InfoPtr->NumTableTypes = NUM_ACPI_TABLES; 532 for (i = 0; i < NUM_ACPI_TABLES; i++) 533 { 534 InfoPtr->TableInfo[i].Count = AcpiGbl_AcpiTables[i].Count; 535 } 536 537 return_ACPI_STATUS (AE_OK); 538} 539 540 541/***************************************************************************** 542 * 543 * FUNCTION: AcpiInstallInitializationHandler 544 * 545 * PARAMETERS: Handler - Callback procedure 546 * 547 * RETURN: Status 548 * 549 * DESCRIPTION: Install an initialization handler 550 * 551 * TBD: When a second function is added, must save the Function also. 552 * 553 ****************************************************************************/ 554 555ACPI_STATUS 556AcpiInstallInitializationHandler ( 557 ACPI_INIT_HANDLER Handler, 558 UINT32 Function) 559{ 560 561 if (!Handler) 562 { 563 return (AE_BAD_PARAMETER); 564 } 565 566 if (AcpiGbl_InitHandler) 567 { 568 return (AE_ALREADY_EXISTS); 569 } 570 571 AcpiGbl_InitHandler = Handler; 572 return AE_OK; 573} 574 575 576/***************************************************************************** 577 * 578 * FUNCTION: AcpiPurgeCachedObjects 579 * 580 * PARAMETERS: None 581 * 582 * RETURN: Status 583 * 584 * DESCRIPTION: Empty all caches (delete the cached objects) 585 * 586 ****************************************************************************/ 587 588ACPI_STATUS 589AcpiPurgeCachedObjects (void) 590{ 591 ACPI_FUNCTION_TRACE ("AcpiPurgeCachedObjects"); 592 593 594 AcpiUtDeleteGenericStateCache (); 595 AcpiUtDeleteObjectCache (); 596 AcpiDsDeleteWalkStateCache (); 597 AcpiPsDeleteParseCache (); 598 599 return_ACPI_STATUS (AE_OK); 600} 601