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