utxface.c revision 82367
1/****************************************************************************** 2 * 3 * Module Name: utxface - External interfaces for "global" ACPI functions 4 * $Revision: 77 $ 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 /* 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 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 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 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 DEBUGGER_EXEC (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 FUNCTION_TRACE ("AcpiEnableSubsystem"); 223 224 225 /* Sanity check the FADT for valid values */ 226 227 Status = AcpiUtValidateFadt (); 228 if (ACPI_FAILURE (Status)) 229 { 230 return_ACPI_STATUS (Status); 231 } 232 233 /* 234 * Install the default OpRegion handlers. These are 235 * installed unless other handlers have already been 236 * installed via the InstallAddressSpaceHandler interface 237 */ 238 239 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT)) 240 { 241 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Installing default address space handlers\n")); 242 243 Status = AcpiEvInstallDefaultAddressSpaceHandlers (); 244 if (ACPI_FAILURE (Status)) 245 { 246 return_ACPI_STATUS (Status); 247 } 248 } 249 250 /* 251 * We must initialize the hardware before we can enable ACPI. 252 */ 253 254 if (!(Flags & ACPI_NO_HARDWARE_INIT)) 255 { 256 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI hardware\n")); 257 258 Status = AcpiHwInitialize (); 259 if (ACPI_FAILURE (Status)) 260 { 261 return_ACPI_STATUS (Status); 262 } 263 } 264 265 /* 266 * Enable ACPI on this platform 267 */ 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 288 if (!(Flags & ACPI_NO_EVENT_INIT)) 289 { 290 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI events\n")); 291 292 Status = AcpiEvInitialize (); 293 if (ACPI_FAILURE (Status)) 294 { 295 return_ACPI_STATUS (Status); 296 } 297 } 298 299 300 /* 301 * Initialize all device objects in the namespace 302 * This runs the _STA and _INI methods. 303 */ 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 /* 318 * Initialize the objects that remain uninitialized. This 319 * runs the executable AML that is part of the declaration of OpRegions 320 * and Fields. 321 */ 322 323 if (!(Flags & ACPI_NO_OBJECT_INIT)) 324 { 325 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Initializing ACPI Objects\n")); 326 327 Status = AcpiNsInitializeObjects (); 328 if (ACPI_FAILURE (Status)) 329 { 330 return_ACPI_STATUS (Status); 331 } 332 } 333 334 AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK; 335 336 return_ACPI_STATUS (Status); 337} 338 339 340/******************************************************************************* 341 * 342 * FUNCTION: AcpiTerminate 343 * 344 * PARAMETERS: None 345 * 346 * RETURN: Status 347 * 348 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources. 349 * 350 ******************************************************************************/ 351 352ACPI_STATUS 353AcpiTerminate (void) 354{ 355 ACPI_STATUS Status; 356 357 358 FUNCTION_TRACE ("AcpiTerminate"); 359 360 361 /* Ensure that ACPI has been initialized */ 362 363 ACPI_IS_INITIALIZATION_COMPLETE (Status); 364 if (ACPI_FAILURE (Status)) 365 { 366 return_ACPI_STATUS (Status); 367 } 368 369 /* Terminate the AML Debugger if present */ 370 371 DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE); 372 373 /* TBD: [Investigate] This is no longer needed?*/ 374/* AcpiUtReleaseMutex (ACPI_MTX_DEBUG_CMD_READY); */ 375 376 377 /* Shutdown and free all resources */ 378 379 AcpiUtSubsystemShutdown (); 380 381 382 /* Free the mutex objects */ 383 384 AcpiUtMutexTerminate (); 385 386 387 /* Now we can shutdown the OS-dependent layer */ 388 389 AcpiOsTerminate (); 390 391 return_ACPI_STATUS (AE_OK); 392} 393 394 395/***************************************************************************** 396 * 397 * FUNCTION: AcpiSubsystemStatus 398 * 399 * PARAMETERS: None 400 * 401 * RETURN: Status of the ACPI subsystem 402 * 403 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this 404 * before making any other calls, to ensure the subsystem initial- 405 * ized successfully. 406 * 407 ****************************************************************************/ 408 409ACPI_STATUS 410AcpiSubsystemStatus (void) 411{ 412 if (AcpiGbl_StartupFlags & ACPI_INITIALIZED_OK) 413 { 414 return (AE_OK); 415 } 416 else 417 { 418 return (AE_ERROR); 419 } 420} 421 422 423/****************************************************************************** 424 * 425 * FUNCTION: AcpiGetSystemInfo 426 * 427 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 428 * resources for the device 429 * BufferLength - the number of bytes available in the buffer 430 * 431 * RETURN: Status - the status of the call 432 * 433 * DESCRIPTION: This function is called to get information about the current 434 * state of the ACPI subsystem. It will return system information 435 * in the OutBuffer. 436 * 437 * If the function fails an appropriate status will be returned 438 * and the value of OutBuffer is undefined. 439 * 440 ******************************************************************************/ 441 442ACPI_STATUS 443AcpiGetSystemInfo ( 444 ACPI_BUFFER *OutBuffer) 445{ 446 ACPI_SYSTEM_INFO *InfoPtr; 447 UINT32 i; 448 ACPI_STATUS Status; 449 450 451 FUNCTION_TRACE ("AcpiGetSystemInfo"); 452 453 454 /* Ensure that ACPI has been initialized */ 455 456 ACPI_IS_INITIALIZATION_COMPLETE (Status); 457 if (ACPI_FAILURE (Status)) 458 { 459 return_ACPI_STATUS (Status); 460 } 461 462 /* 463 * Must have a valid buffer 464 */ 465 if ((!OutBuffer) || 466 (!OutBuffer->Pointer)) 467 { 468 return_ACPI_STATUS (AE_BAD_PARAMETER); 469 } 470 471 if (OutBuffer->Length < sizeof (ACPI_SYSTEM_INFO)) 472 { 473 /* 474 * Caller's buffer is too small 475 */ 476 OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO); 477 478 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 479 } 480 481 482 /* 483 * Set return length and get data 484 */ 485 OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO); 486 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer; 487 488 InfoPtr->AcpiCaVersion = ACPI_CA_VERSION; 489 490 /* System flags (ACPI capabilities) */ 491 492 InfoPtr->Flags = AcpiGbl_SystemFlags; 493 494 /* Timer resolution - 24 or 32 bits */ 495 if (!AcpiGbl_FADT) 496 { 497 InfoPtr->TimerResolution = 0; 498 } 499 else if (AcpiGbl_FADT->TmrValExt == 0) 500 { 501 InfoPtr->TimerResolution = 24; 502 } 503 else 504 { 505 InfoPtr->TimerResolution = 32; 506 } 507 508 /* Clear the reserved fields */ 509 510 InfoPtr->Reserved1 = 0; 511 InfoPtr->Reserved2 = 0; 512 513 /* Current debug levels */ 514 515 InfoPtr->DebugLayer = AcpiDbgLayer; 516 InfoPtr->DebugLevel = AcpiDbgLevel; 517 518 /* Current status of the ACPI tables, per table type */ 519 520 InfoPtr->NumTableTypes = NUM_ACPI_TABLES; 521 for (i = 0; i < NUM_ACPI_TABLES; i++) 522 { 523 InfoPtr->TableInfo[i].Count = AcpiGbl_AcpiTables[i].Count; 524 } 525 526 return_ACPI_STATUS (AE_OK); 527} 528 529 530