utxface.c revision 70243
1/****************************************************************************** 2 * 3 * Module Name: cmxface - External interfaces for "global" ACPI functions 4 * $Revision: 57 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 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 __CMXFACE_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 128 129#define _COMPONENT MISCELLANEOUS 130 MODULE_NAME ("cmxface") 131 132 133/******************************************************************************* 134 * 135 * FUNCTION: AcpiInitializeSubsystem 136 * 137 * PARAMETERS: None 138 * 139 * RETURN: Status 140 * 141 * DESCRIPTION: Initializes all global variables. This is the first function 142 * called, so any early initialization belongs here. 143 * 144 ******************************************************************************/ 145 146ACPI_STATUS 147AcpiInitializeSubsystem ( 148 void) 149{ 150 ACPI_STATUS Status; 151 152 153 FUNCTION_TRACE ("AcpiInitializeSubsystem"); 154 155 DEBUG_PRINT_RAW (ACPI_OK, 156 ("ACPI: Core Subsystem version [%s]\n", ACPI_CA_VERSION)); 157 DEBUG_PRINT (ACPI_INFO, ("Initializing ACPI Subsystem...\n")); 158 159 160 /* Initialize all globals used by the subsystem */ 161 162 AcpiCmInitGlobals (); 163 164 /* Initialize the OS-Dependent layer */ 165 166 Status = AcpiOsInitialize (); 167 if (ACPI_FAILURE (Status)) 168 { 169 REPORT_ERROR (("OSD failed to initialize, %s\n", 170 AcpiCmFormatException (Status))); 171 return_ACPI_STATUS (Status); 172 } 173 174 /* Create the default mutex objects */ 175 176 Status = AcpiCmMutexInitialize (); 177 if (ACPI_FAILURE (Status)) 178 { 179 REPORT_ERROR (("Global mutex creation failure, %s\n", 180 AcpiCmFormatException (Status))); 181 return_ACPI_STATUS (Status); 182 } 183 184 /* 185 * Initialize the namespace manager and 186 * the root of the namespace tree 187 */ 188 189 Status = AcpiNsRootInitialize (); 190 if (ACPI_FAILURE (Status)) 191 { 192 REPORT_ERROR (("Namespace initialization failure, %s\n", 193 AcpiCmFormatException (Status))); 194 return_ACPI_STATUS (Status); 195 } 196 197 198 /* If configured, initialize the AML debugger */ 199 200 DEBUGGER_EXEC (AcpiDbInitialize ()); 201 202 return_ACPI_STATUS (Status); 203} 204 205 206/******************************************************************************* 207 * 208 * FUNCTION: AcpiEnableSubsystem 209 * 210 * PARAMETERS: Flags - Init/enable Options 211 * 212 * RETURN: Status 213 * 214 * DESCRIPTION: Completes the subsystem initialization including hardware. 215 * Puts system into ACPI mode if it isn't already. 216 * 217 ******************************************************************************/ 218 219ACPI_STATUS 220AcpiEnableSubsystem ( 221 UINT32 Flags) 222{ 223 ACPI_STATUS Status = AE_OK; 224 225 226 FUNCTION_TRACE ("AcpiEnableSubsystem"); 227 228 229 /* Sanity check the FADT for valid values */ 230 231 Status = AcpiCmValidateFadt (); 232 if (ACPI_FAILURE (Status)) 233 { 234 return_ACPI_STATUS (Status); 235 } 236 237 /* 238 * Install the default OpRegion handlers. These are 239 * installed unless other handlers have already been 240 * installed via the InstallAddressSpaceHandler interface 241 */ 242 243 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT)) 244 { 245 DEBUG_PRINT (TRACE_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 258 if (!(Flags & ACPI_NO_HARDWARE_INIT)) 259 { 260 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI hardware\n")); 261 262 Status = AcpiHwInitialize (); 263 if (ACPI_FAILURE (Status)) 264 { 265 return_ACPI_STATUS (Status); 266 } 267 } 268 269 /* 270 * Enable ACPI on this platform 271 */ 272 273 if (!(Flags & ACPI_NO_ACPI_ENABLE)) 274 { 275 DEBUG_PRINT (TRACE_EXEC, ("[Init] Going into ACPI mode\n")); 276 277 Status = AcpiEnable (); 278 if (ACPI_FAILURE (Status)) 279 { 280 /* TBD: workaround. Old Lions don't enable properly */ 281 DEBUG_PRINT(ACPI_WARN, ("AcpiEnable failed.\n")); 282 /*return_ACPI_STATUS (Status);*/ 283 } 284 } 285 286 /* 287 * Note: 288 * We must have the hardware AND events initialized before we can execute 289 * ANY control methods SAFELY. Any control method can require ACPI hardware 290 * support, so the hardware MUST be initialized before execution! 291 */ 292 293 if (!(Flags & ACPI_NO_EVENT_INIT)) 294 { 295 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI events\n")); 296 297 Status = AcpiEvInitialize (); 298 if (ACPI_FAILURE (Status)) 299 { 300 return_ACPI_STATUS (Status); 301 } 302 } 303 304 305 /* 306 * Initialize all device objects in the namespace 307 * This runs the _STA, _INI, and _HID methods, and detects 308 * the PCI root bus(es) 309 */ 310 311 if (!(Flags & ACPI_NO_DEVICE_INIT)) 312 { 313 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI Devices\n")); 314 315 Status = AcpiNsInitializeDevices (Flags & ACPI_NO_PCI_INIT); 316 if (ACPI_FAILURE (Status)) 317 { 318 return_ACPI_STATUS (Status); 319 } 320 } 321 322 323 /* 324 * Initialize the objects that remain unitialized. This 325 * runs the executable AML that is part of the declaration of OpRegions 326 * and Fields. 327 */ 328 329 if (!(Flags & ACPI_NO_OBJECT_INIT)) 330 { 331 DEBUG_PRINT (TRACE_EXEC, ("[Init] Initializing ACPI Objects\n")); 332 333 Status = AcpiNsInitializeObjects (); 334 if (ACPI_FAILURE (Status)) 335 { 336 return_ACPI_STATUS (Status); 337 } 338 } 339 340 341 return_ACPI_STATUS (Status); 342} 343 344 345/******************************************************************************* 346 * 347 * FUNCTION: AcpiTerminate 348 * 349 * PARAMETERS: None 350 * 351 * RETURN: Status 352 * 353 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources. 354 * 355 ******************************************************************************/ 356 357ACPI_STATUS 358AcpiTerminate (void) 359{ 360 361 FUNCTION_TRACE ("AcpiTerminate"); 362 363 /* Terminate the AML Debuger if present */ 364 365 DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE); 366 367 /* TBD: [Investigate] This is no longer needed?*/ 368/* AcpiCmReleaseMutex (ACPI_MTX_DEBUG_CMD_READY); */ 369 370 371 /* Shutdown and free all resources */ 372 373 AcpiCmSubsystemShutdown (); 374 375 376 /* Free the mutex objects */ 377 378 AcpiCmMutexTerminate (); 379 380 381 /* Now we can shutdown the OS-dependent layer */ 382 383 AcpiOsTerminate (); 384 385 return_ACPI_STATUS (AE_OK); 386} 387 388 389/****************************************************************************** 390 * 391 * FUNCTION: AcpiGetSystemInfo 392 * 393 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 394 * resources for the device 395 * BufferLength - the number of bytes available in the buffer 396 * 397 * RETURN: Status - the status of the call 398 * 399 * DESCRIPTION: This function is called to get information about the current 400 * state of the ACPI subsystem. It will return system information 401 * in the OutBuffer. 402 * 403 * If the function fails an appropriate status will be returned 404 * and the value of OutBuffer is undefined. 405 * 406 ******************************************************************************/ 407 408ACPI_STATUS 409AcpiGetSystemInfo ( 410 ACPI_BUFFER *OutBuffer) 411{ 412 ACPI_SYSTEM_INFO *InfoPtr; 413 UINT32 i; 414 415 416 FUNCTION_TRACE ("AcpiGetSystemInfo"); 417 418 419 /* 420 * Must have a valid buffer 421 */ 422 if ((!OutBuffer) || 423 (!OutBuffer->Pointer)) 424 { 425 return_ACPI_STATUS (AE_BAD_PARAMETER); 426 } 427 428 if (OutBuffer->Length < sizeof (ACPI_SYSTEM_INFO)) 429 { 430 /* 431 * Caller's buffer is too small 432 */ 433 OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO); 434 435 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 436 } 437 438 439 /* 440 * Set return length and get data 441 */ 442 OutBuffer->Length = sizeof (ACPI_SYSTEM_INFO); 443 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer; 444 445 /* TBD [Future]: need a version number, or use the version string */ 446 InfoPtr->AcpiCaVersion = 0x1234; 447 448 /* System flags (ACPI capabilities) */ 449 450 InfoPtr->Flags = AcpiGbl_SystemFlags; 451 452 /* Timer resolution - 24 or 32 bits */ 453 454 InfoPtr->TimerResolution = AcpiHwPmtResolution (); 455 456 /* Clear the reserved fields */ 457 458 InfoPtr->Reserved1 = 0; 459 InfoPtr->Reserved2 = 0; 460 461 /* Current debug levels */ 462 463 InfoPtr->DebugLayer = AcpiDbgLayer; 464 InfoPtr->DebugLevel = AcpiDbgLevel; 465 466 /* Current status of the ACPI tables, per table type */ 467 468 InfoPtr->NumTableTypes = NUM_ACPI_TABLES; 469 for (i = 0; i < NUM_ACPI_TABLES; i++) 470 { 471 InfoPtr->TableInfo[i].Count = AcpiGbl_AcpiTables[i].Count; 472 } 473 474 return_ACPI_STATUS (AE_OK); 475} 476 477 478/****************************************************************************** 479 * 480 * FUNCTION: AcpiFormatException 481 * 482 * PARAMETERS: OutBuffer - a pointer to a buffer to receive the 483 * exception name 484 * 485 * RETURN: Status - the status of the call 486 * 487 * DESCRIPTION: This function translates an ACPI exception into an ASCII string. 488 * 489 ******************************************************************************/ 490 491ACPI_STATUS 492AcpiFormatException ( 493 ACPI_STATUS Exception, 494 ACPI_BUFFER *OutBuffer) 495{ 496 UINT32 Length; 497 NATIVE_CHAR *FormattedException; 498 499 500 FUNCTION_TRACE ("AcpiFormatException"); 501 502 503 /* 504 * Must have a valid buffer 505 */ 506 if ((!OutBuffer) || 507 (!OutBuffer->Pointer)) 508 { 509 return_ACPI_STATUS (AE_BAD_PARAMETER); 510 } 511 512 513 /* Convert the exception code (Handles bad exception codes) */ 514 515 FormattedException = AcpiCmFormatException (Exception); 516 517 /* 518 * Get length of string and check if it will fit in caller's buffer 519 */ 520 521 Length = STRLEN (FormattedException); 522 if (OutBuffer->Length < Length) 523 { 524 OutBuffer->Length = Length; 525 return_ACPI_STATUS (AE_BUFFER_OVERFLOW); 526 } 527 528 529 /* Copy the string, all done */ 530 531 STRCPY (OutBuffer->Pointer, FormattedException); 532 533 return_ACPI_STATUS (AE_OK); 534} 535 536