1 /******************************************************************************
3 * Module Name: utxface - External interfaces for "global" ACPI functions
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 #define __UTXFACE_C__
119 #include <contrib/dev/acpica/include/acpi.h>
120 #include <contrib/dev/acpica/include/accommon.h>
121 #include <contrib/dev/acpica/include/acevents.h>
122 #include <contrib/dev/acpica/include/acnamesp.h>
123 #include <contrib/dev/acpica/include/acdebug.h>
124 #include <contrib/dev/acpica/include/actables.h>
126 #define _COMPONENT ACPI_UTILITIES
127 ACPI_MODULE_NAME ("utxface")
130 #ifndef ACPI_ASL_COMPILER
132 /*******************************************************************************
134 * FUNCTION: AcpiInitializeSubsystem
140 * DESCRIPTION: Initializes all global variables. This is the first function
141 * called, so any early initialization belongs here.
143 ******************************************************************************/
146 AcpiInitializeSubsystem (
152 ACPI_FUNCTION_TRACE (AcpiInitializeSubsystem);
155 AcpiGbl_StartupFlags = ACPI_SUBSYSTEM_INITIALIZE;
156 ACPI_DEBUG_EXEC (AcpiUtInitStackPtrTrace ());
158 /* Initialize the OS-Dependent layer */
160 Status = AcpiOsInitialize ();
161 if (ACPI_FAILURE (Status))
163 ACPI_EXCEPTION ((AE_INFO, Status, "During OSL initialization"));
164 return_ACPI_STATUS (Status);
167 /* Initialize all globals used by the subsystem */
169 Status = AcpiUtInitGlobals ();
170 if (ACPI_FAILURE (Status))
172 ACPI_EXCEPTION ((AE_INFO, Status, "During initialization of globals"));
173 return_ACPI_STATUS (Status);
176 /* Create the default mutex objects */
178 Status = AcpiUtMutexInitialize ();
179 if (ACPI_FAILURE (Status))
181 ACPI_EXCEPTION ((AE_INFO, Status, "During Global Mutex creation"));
182 return_ACPI_STATUS (Status);
186 * Initialize the namespace manager and
187 * the root of the namespace tree
189 Status = AcpiNsRootInitialize ();
190 if (ACPI_FAILURE (Status))
192 ACPI_EXCEPTION ((AE_INFO, Status, "During Namespace initialization"));
193 return_ACPI_STATUS (Status);
196 /* If configured, initialize the AML debugger */
198 ACPI_DEBUGGER_EXEC (Status = AcpiDbInitialize ());
199 return_ACPI_STATUS (Status);
202 ACPI_EXPORT_SYMBOL (AcpiInitializeSubsystem)
205 /*******************************************************************************
207 * FUNCTION: AcpiEnableSubsystem
209 * PARAMETERS: Flags - Init/enable Options
213 * DESCRIPTION: Completes the subsystem initialization including hardware.
214 * Puts system into ACPI mode if it isn't already.
216 ******************************************************************************/
219 AcpiEnableSubsystem (
222 ACPI_STATUS Status = AE_OK;
225 ACPI_FUNCTION_TRACE (AcpiEnableSubsystem);
228 /* Enable ACPI mode */
230 if (!(Flags & ACPI_NO_ACPI_ENABLE))
232 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Going into ACPI mode\n"));
234 AcpiGbl_OriginalMode = AcpiHwGetMode();
236 Status = AcpiEnable ();
237 if (ACPI_FAILURE (Status))
239 ACPI_WARNING ((AE_INFO, "AcpiEnable failed"));
240 return_ACPI_STATUS (Status);
245 * Obtain a permanent mapping for the FACS. This is required for the
246 * Global Lock and the Firmware Waking Vector
248 Status = AcpiTbInitializeFacs ();
249 if (ACPI_FAILURE (Status))
251 ACPI_WARNING ((AE_INFO, "Could not map the FACS table"));
252 return_ACPI_STATUS (Status);
256 * Install the default OpRegion handlers. These are installed unless
257 * other handlers have already been installed via the
258 * InstallAddressSpaceHandler interface.
260 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
262 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
263 "[Init] Installing default address space handlers\n"));
265 Status = AcpiEvInstallRegionHandlers ();
266 if (ACPI_FAILURE (Status))
268 return_ACPI_STATUS (Status);
273 * Initialize ACPI Event handling (Fixed and General Purpose)
275 * Note1: We must have the hardware and events initialized before we can
276 * execute any control methods safely. Any control method can require
277 * ACPI hardware support, so the hardware must be fully initialized before
278 * any method execution!
280 * Note2: Fixed events are initialized and enabled here. GPEs are
281 * initialized, but cannot be enabled until after the hardware is
282 * completely initialized (SCI and GlobalLock activated) and the various
283 * initialization control methods are run (_REG, _STA, _INI) on the
286 if (!(Flags & ACPI_NO_EVENT_INIT))
288 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
289 "[Init] Initializing ACPI events\n"));
291 Status = AcpiEvInitializeEvents ();
292 if (ACPI_FAILURE (Status))
294 return_ACPI_STATUS (Status);
299 * Install the SCI handler and Global Lock handler. This completes the
300 * hardware initialization.
302 if (!(Flags & ACPI_NO_HANDLER_INIT))
304 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
305 "[Init] Installing SCI/GL handlers\n"));
307 Status = AcpiEvInstallXruptHandlers ();
308 if (ACPI_FAILURE (Status))
310 return_ACPI_STATUS (Status);
314 return_ACPI_STATUS (Status);
317 ACPI_EXPORT_SYMBOL (AcpiEnableSubsystem)
320 /*******************************************************************************
322 * FUNCTION: AcpiInitializeObjects
324 * PARAMETERS: Flags - Init/enable Options
328 * DESCRIPTION: Completes namespace initialization by initializing device
329 * objects and executing AML code for Regions, buffers, etc.
331 ******************************************************************************/
334 AcpiInitializeObjects (
337 ACPI_STATUS Status = AE_OK;
340 ACPI_FUNCTION_TRACE (AcpiInitializeObjects);
344 * Run all _REG methods
346 * Note: Any objects accessed by the _REG methods will be automatically
347 * initialized, even if they contain executable AML (see the call to
348 * AcpiNsInitializeObjects below).
350 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
352 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
353 "[Init] Executing _REG OpRegion methods\n"));
355 Status = AcpiEvInitializeOpRegions ();
356 if (ACPI_FAILURE (Status))
358 return_ACPI_STATUS (Status);
363 * Initialize the objects that remain uninitialized. This runs the
364 * executable AML that may be part of the declaration of these objects:
365 * OperationRegions, BufferFields, Buffers, and Packages.
367 if (!(Flags & ACPI_NO_OBJECT_INIT))
369 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
370 "[Init] Completing Initialization of ACPI Objects\n"));
372 Status = AcpiNsInitializeObjects ();
373 if (ACPI_FAILURE (Status))
375 return_ACPI_STATUS (Status);
380 * Initialize all device objects in the namespace. This runs the device
381 * _STA and _INI methods.
383 if (!(Flags & ACPI_NO_DEVICE_INIT))
385 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
386 "[Init] Initializing ACPI Devices\n"));
388 Status = AcpiNsInitializeDevices ();
389 if (ACPI_FAILURE (Status))
391 return_ACPI_STATUS (Status);
396 * Initialize the GPE blocks defined in the FADT (GPE block 0 and 1).
397 * The runtime GPEs are enabled here.
399 * This is where the _PRW methods are executed for the GPEs. These
400 * methods can only be executed after the SCI and Global Lock handlers are
401 * installed and initialized.
403 * GPEs can only be enabled after the _REG, _STA, and _INI methods have
404 * been run. This ensures that all Operation Regions and all Devices have
405 * been initialized and are ready.
407 if (!(Flags & ACPI_NO_EVENT_INIT))
409 Status = AcpiEvInstallFadtGpes ();
410 if (ACPI_FAILURE (Status))
417 * Empty the caches (delete the cached objects) on the assumption that
418 * the table load filled them up more than they will be at runtime --
419 * thus wasting non-paged memory.
421 Status = AcpiPurgeCachedObjects ();
423 AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK;
424 return_ACPI_STATUS (Status);
427 ACPI_EXPORT_SYMBOL (AcpiInitializeObjects)
432 /*******************************************************************************
434 * FUNCTION: AcpiTerminate
440 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources.
442 ******************************************************************************/
451 ACPI_FUNCTION_TRACE (AcpiTerminate);
454 /* Terminate the AML Debugger if present */
456 ACPI_DEBUGGER_EXEC(AcpiGbl_DbTerminateThreads = TRUE);
458 /* Shutdown and free all resources */
460 AcpiUtSubsystemShutdown ();
463 /* Free the mutex objects */
465 AcpiUtMutexTerminate ();
470 /* Shut down the debugger */
475 /* Now we can shutdown the OS-dependent layer */
477 Status = AcpiOsTerminate ();
478 return_ACPI_STATUS (Status);
481 ACPI_EXPORT_SYMBOL (AcpiTerminate)
483 #ifndef ACPI_ASL_COMPILER
485 /*******************************************************************************
487 * FUNCTION: AcpiSubsystemStatus
491 * RETURN: Status of the ACPI subsystem
493 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
494 * before making any other calls, to ensure the subsystem
495 * initialized successfully.
497 ******************************************************************************/
500 AcpiSubsystemStatus (
504 if (AcpiGbl_StartupFlags & ACPI_INITIALIZED_OK)
514 ACPI_EXPORT_SYMBOL (AcpiSubsystemStatus)
517 /*******************************************************************************
519 * FUNCTION: AcpiGetSystemInfo
521 * PARAMETERS: OutBuffer - A buffer to receive the resources for the
524 * RETURN: Status - the status of the call
526 * DESCRIPTION: This function is called to get information about the current
527 * state of the ACPI subsystem. It will return system information
530 * If the function fails an appropriate status will be returned
531 * and the value of OutBuffer is undefined.
533 ******************************************************************************/
537 ACPI_BUFFER *OutBuffer)
539 ACPI_SYSTEM_INFO *InfoPtr;
543 ACPI_FUNCTION_TRACE (AcpiGetSystemInfo);
546 /* Parameter validation */
548 Status = AcpiUtValidateBuffer (OutBuffer);
549 if (ACPI_FAILURE (Status))
551 return_ACPI_STATUS (Status);
554 /* Validate/Allocate/Clear caller buffer */
556 Status = AcpiUtInitializeBuffer (OutBuffer, sizeof (ACPI_SYSTEM_INFO));
557 if (ACPI_FAILURE (Status))
559 return_ACPI_STATUS (Status);
563 * Populate the return buffer
565 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer;
567 InfoPtr->AcpiCaVersion = ACPI_CA_VERSION;
569 /* System flags (ACPI capabilities) */
571 InfoPtr->Flags = ACPI_SYS_MODE_ACPI;
573 /* Timer resolution - 24 or 32 bits */
575 if (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER)
577 InfoPtr->TimerResolution = 24;
581 InfoPtr->TimerResolution = 32;
584 /* Clear the reserved fields */
586 InfoPtr->Reserved1 = 0;
587 InfoPtr->Reserved2 = 0;
589 /* Current debug levels */
591 InfoPtr->DebugLayer = AcpiDbgLayer;
592 InfoPtr->DebugLevel = AcpiDbgLevel;
594 return_ACPI_STATUS (AE_OK);
597 ACPI_EXPORT_SYMBOL (AcpiGetSystemInfo)
600 /*******************************************************************************
602 * FUNCTION: AcpiGetStatistics
604 * PARAMETERS: Stats - Where the statistics are returned
606 * RETURN: Status - the status of the call
608 * DESCRIPTION: Get the contents of the various system counters
610 ******************************************************************************/
614 ACPI_STATISTICS *Stats)
616 ACPI_FUNCTION_TRACE (AcpiGetStatistics);
619 /* Parameter validation */
623 return_ACPI_STATUS (AE_BAD_PARAMETER);
626 /* Various interrupt-based event counters */
628 Stats->SciCount = AcpiSciCount;
629 Stats->GpeCount = AcpiGpeCount;
631 ACPI_MEMCPY (Stats->FixedEventCount, AcpiFixedEventCount,
632 sizeof (AcpiFixedEventCount));
637 Stats->MethodCount = AcpiMethodCount;
639 return_ACPI_STATUS (AE_OK);
642 ACPI_EXPORT_SYMBOL (AcpiGetStatistics)
645 /*****************************************************************************
647 * FUNCTION: AcpiInstallInitializationHandler
649 * PARAMETERS: Handler - Callback procedure
650 * Function - Not (currently) used, see below
654 * DESCRIPTION: Install an initialization handler
656 * TBD: When a second function is added, must save the Function also.
658 ****************************************************************************/
661 AcpiInstallInitializationHandler (
662 ACPI_INIT_HANDLER Handler,
668 return (AE_BAD_PARAMETER);
671 if (AcpiGbl_InitHandler)
673 return (AE_ALREADY_EXISTS);
676 AcpiGbl_InitHandler = Handler;
680 ACPI_EXPORT_SYMBOL (AcpiInstallInitializationHandler)
683 /*****************************************************************************
685 * FUNCTION: AcpiPurgeCachedObjects
691 * DESCRIPTION: Empty all caches (delete the cached objects)
693 ****************************************************************************/
696 AcpiPurgeCachedObjects (
699 ACPI_FUNCTION_TRACE (AcpiPurgeCachedObjects);
701 (void) AcpiOsPurgeCache (AcpiGbl_StateCache);
702 (void) AcpiOsPurgeCache (AcpiGbl_OperandCache);
703 (void) AcpiOsPurgeCache (AcpiGbl_PsNodeCache);
704 (void) AcpiOsPurgeCache (AcpiGbl_PsNodeExtCache);
705 return_ACPI_STATUS (AE_OK);
708 ACPI_EXPORT_SYMBOL (AcpiPurgeCachedObjects)
710 #endif /* ACPI_ASL_COMPILER */