utxface.c revision 99679
1/****************************************************************************** 2 * 3 * Module Name: utxface - External interfaces for "global" ACPI functions 4 * $Revision: 96 $ 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 /* 302 * Initialize all device objects in the namespace 303 * This runs the _STA and _INI methods. 304 */ 305 if (!(Flags & ACPI_NO_DEVICE_INIT)) 306 { 307 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI Devices\n")); 308 309 Status = AcpiNsInitializeDevices (); 310 if (ACPI_FAILURE (Status)) 311 { 312 return_ACPI_STATUS (Status); 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 if (!(Flags & ACPI_NO_OBJECT_INIT)) 322 { 323 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI Objects\n")); 324 325 Status = AcpiNsInitializeObjects (); 326 if (ACPI_FAILURE (Status)) 327 { 328 return_ACPI_STATUS (Status); 329 } 330 } 331 332 /* 333 * Empty the caches (delete the cached objects) on the assumption that 334 * the table load filled them up more than they will be at runtime -- 335 * thus wasting non-paged memory. 336 */ 337 Status = AcpiPurgeCachedObjects (); 338 339 AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK; 340 return_ACPI_STATUS (Status); 341} 342 343 344/******************************************************************************* 345 * 346 * FUNCTION: AcpiTerminate 347 * 348 * PARAMETERS: None 349 * 350 * RETURN: Status 351 * 352 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources. 353 * 354 ******************************************************************************/ 355 356ACPI_STATUS 357AcpiTerminate (void) 358{ 359 ACPI_STATUS Status; 360 361 362 ACPI_FUNCTION_TRACE ("AcpiTerminate"); 363 364 365 /* Terminate the AML Debugger if present */ 366 367 ACPI_DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE); 368 369 /* Shutdown and free all resources */ 370 371 AcpiUtSubsystemShutdown (); 372 373 374 /* Free the mutex objects */ 375 376 AcpiUtMutexTerminate (); 377 378 379#ifdef ENABLE_DEBUGGER 380 381 /* Shut down the debugger */ 382 383 AcpiDbTerminate (); 384#endif 385 386 /* Now we can shutdown the OS-dependent layer */ 387 388 Status = AcpiOsTerminate (); 389 return_ACPI_STATUS (Status); 390} 391 392 393/***************************************************************************** 394 * 395 * FUNCTION: AcpiSubsystemStatus 396 * 397 * PARAMETERS: None 398 * 399 * RETURN: Status of the ACPI subsystem 400 * 401 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this 402 * before making any other calls, to ensure the subsystem initial- 403 * ized successfully. 404 * 405 ****************************************************************************/ 406 407ACPI_STATUS 408AcpiSubsystemStatus (void) 409{ 410 if (AcpiGbl_StartupFlags & ACPI_INITIALIZED_OK) 411 { 412 return (AE_OK); 413 } 414 else 415 { 416 return (AE_ERROR); 417 } 418} 419 420 421/****************************************************************************** 422 * 423 * FUNCTION: AcpiGetSystemInfo 424 * 425 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 426 * resources for the device 427 * BufferLength - the number of bytes available in the buffer 428 * 429 * RETURN: Status - the status of the call 430 * 431 * DESCRIPTION: This function is called to get information about the current 432 * state of the ACPI subsystem. It will return system information 433 * in the OutBuffer. 434 * 435 * If the function fails an appropriate status will be returned 436 * and the value of OutBuffer is undefined. 437 * 438 ******************************************************************************/ 439 440ACPI_STATUS 441AcpiGetSystemInfo ( 442 ACPI_BUFFER *OutBuffer) 443{ 444 ACPI_SYSTEM_INFO *InfoPtr; 445 UINT32 i; 446 ACPI_STATUS Status; 447 448 449 ACPI_FUNCTION_TRACE ("AcpiGetSystemInfo"); 450 451 452 /* Parameter validation */ 453 454 Status = AcpiUtValidateBuffer (OutBuffer); 455 if (ACPI_FAILURE (Status)) 456 { 457 return_ACPI_STATUS (Status); 458 } 459 460 /* Validate/Allocate/Clear caller buffer */ 461 462 Status = AcpiUtInitializeBuffer (OutBuffer, sizeof (ACPI_SYSTEM_INFO)); 463 if (ACPI_FAILURE (Status)) 464 { 465 return_ACPI_STATUS (Status); 466 } 467 468 /* 469 * Populate the return buffer 470 */ 471 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer; 472 473 InfoPtr->AcpiCaVersion = ACPI_CA_VERSION; 474 475 /* System flags (ACPI capabilities) */ 476 477 InfoPtr->Flags = ACPI_SYS_MODE_ACPI; 478 479 /* Timer resolution - 24 or 32 bits */ 480 481 if (!AcpiGbl_FADT) 482 { 483 InfoPtr->TimerResolution = 0; 484 } 485 else if (AcpiGbl_FADT->TmrValExt == 0) 486 { 487 InfoPtr->TimerResolution = 24; 488 } 489 else 490 { 491 InfoPtr->TimerResolution = 32; 492 } 493 494 /* Clear the reserved fields */ 495 496 InfoPtr->Reserved1 = 0; 497 InfoPtr->Reserved2 = 0; 498 499 /* Current debug levels */ 500 501 InfoPtr->DebugLayer = AcpiDbgLayer; 502 InfoPtr->DebugLevel = AcpiDbgLevel; 503 504 /* Current status of the ACPI tables, per table type */ 505 506 InfoPtr->NumTableTypes = NUM_ACPI_TABLES; 507 for (i = 0; i < NUM_ACPI_TABLES; i++) 508 { 509 InfoPtr->TableInfo[i].Count = AcpiGbl_AcpiTables[i].Count; 510 } 511 512 return_ACPI_STATUS (AE_OK); 513} 514 515 516/***************************************************************************** 517 * 518 * FUNCTION: AcpiInstallInitializationHandler 519 * 520 * PARAMETERS: Handler - Callback procedure 521 * 522 * RETURN: Status 523 * 524 * DESCRIPTION: Install an initialization handler 525 * 526 * TBD: When a second function is added, must save the Function also. 527 * 528 ****************************************************************************/ 529 530ACPI_STATUS 531AcpiInstallInitializationHandler ( 532 ACPI_INIT_HANDLER Handler, 533 UINT32 Function) 534{ 535 536 if (!Handler) 537 { 538 return (AE_BAD_PARAMETER); 539 } 540 541 if (AcpiGbl_InitHandler) 542 { 543 return (AE_ALREADY_EXISTS); 544 } 545 546 AcpiGbl_InitHandler = Handler; 547 return AE_OK; 548} 549 550 551/***************************************************************************** 552 * 553 * FUNCTION: AcpiPurgeCachedObjects 554 * 555 * PARAMETERS: None 556 * 557 * RETURN: Status 558 * 559 * DESCRIPTION: Empty all caches (delete the cached objects) 560 * 561 ****************************************************************************/ 562 563ACPI_STATUS 564AcpiPurgeCachedObjects (void) 565{ 566 ACPI_FUNCTION_TRACE ("AcpiPurgeCachedObjects"); 567 568 569 AcpiUtDeleteGenericStateCache (); 570 AcpiUtDeleteObjectCache (); 571 AcpiDsDeleteWalkStateCache (); 572 AcpiPsDeleteParseCache (); 573 574 return_ACPI_STATUS (AE_OK); 575} 576