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