1 /******************************************************************************
3 * Module Name: utxface - External interfaces for "global" ACPI functions
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, 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 /* Initialize the global OSI interfaces list with the static names */
198 Status = AcpiUtInitializeInterfaces ();
199 if (ACPI_FAILURE (Status))
201 ACPI_EXCEPTION ((AE_INFO, Status, "During OSI interfaces initialization"));
202 return_ACPI_STATUS (Status);
205 /* If configured, initialize the AML debugger */
207 ACPI_DEBUGGER_EXEC (Status = AcpiDbInitialize ());
208 return_ACPI_STATUS (Status);
211 ACPI_EXPORT_SYMBOL (AcpiInitializeSubsystem)
214 /*******************************************************************************
216 * FUNCTION: AcpiEnableSubsystem
218 * PARAMETERS: Flags - Init/enable Options
222 * DESCRIPTION: Completes the subsystem initialization including hardware.
223 * Puts system into ACPI mode if it isn't already.
225 ******************************************************************************/
228 AcpiEnableSubsystem (
231 ACPI_STATUS Status = AE_OK;
234 ACPI_FUNCTION_TRACE (AcpiEnableSubsystem);
237 /* Enable ACPI mode */
239 if (!(Flags & ACPI_NO_ACPI_ENABLE))
241 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Init] Going into ACPI mode\n"));
243 AcpiGbl_OriginalMode = AcpiHwGetMode();
245 Status = AcpiEnable ();
246 if (ACPI_FAILURE (Status))
248 ACPI_WARNING ((AE_INFO, "AcpiEnable failed"));
249 return_ACPI_STATUS (Status);
254 * Obtain a permanent mapping for the FACS. This is required for the
255 * Global Lock and the Firmware Waking Vector
257 Status = AcpiTbInitializeFacs ();
258 if (ACPI_FAILURE (Status))
260 ACPI_WARNING ((AE_INFO, "Could not map the FACS table"));
261 return_ACPI_STATUS (Status);
265 * Install the default OpRegion handlers. These are installed unless
266 * other handlers have already been installed via the
267 * InstallAddressSpaceHandler interface.
269 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
271 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
272 "[Init] Installing default address space handlers\n"));
274 Status = AcpiEvInstallRegionHandlers ();
275 if (ACPI_FAILURE (Status))
277 return_ACPI_STATUS (Status);
282 * Initialize ACPI Event handling (Fixed and General Purpose)
284 * Note1: We must have the hardware and events initialized before we can
285 * execute any control methods safely. Any control method can require
286 * ACPI hardware support, so the hardware must be fully initialized before
287 * any method execution!
289 * Note2: Fixed events are initialized and enabled here. GPEs are
290 * initialized, but cannot be enabled until after the hardware is
291 * completely initialized (SCI and GlobalLock activated) and the various
292 * initialization control methods are run (_REG, _STA, _INI) on the
295 if (!(Flags & ACPI_NO_EVENT_INIT))
297 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
298 "[Init] Initializing ACPI events\n"));
300 Status = AcpiEvInitializeEvents ();
301 if (ACPI_FAILURE (Status))
303 return_ACPI_STATUS (Status);
308 * Install the SCI handler and Global Lock handler. This completes the
309 * hardware initialization.
311 if (!(Flags & ACPI_NO_HANDLER_INIT))
313 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
314 "[Init] Installing SCI/GL handlers\n"));
316 Status = AcpiEvInstallXruptHandlers ();
317 if (ACPI_FAILURE (Status))
319 return_ACPI_STATUS (Status);
323 return_ACPI_STATUS (Status);
326 ACPI_EXPORT_SYMBOL (AcpiEnableSubsystem)
329 /*******************************************************************************
331 * FUNCTION: AcpiInitializeObjects
333 * PARAMETERS: Flags - Init/enable Options
337 * DESCRIPTION: Completes namespace initialization by initializing device
338 * objects and executing AML code for Regions, buffers, etc.
340 ******************************************************************************/
343 AcpiInitializeObjects (
346 ACPI_STATUS Status = AE_OK;
349 ACPI_FUNCTION_TRACE (AcpiInitializeObjects);
353 * Run all _REG methods
355 * Note: Any objects accessed by the _REG methods will be automatically
356 * initialized, even if they contain executable AML (see the call to
357 * AcpiNsInitializeObjects below).
359 if (!(Flags & ACPI_NO_ADDRESS_SPACE_INIT))
361 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
362 "[Init] Executing _REG OpRegion methods\n"));
364 Status = AcpiEvInitializeOpRegions ();
365 if (ACPI_FAILURE (Status))
367 return_ACPI_STATUS (Status);
372 * Execute any module-level code that was detected during the table load
373 * phase. Although illegal since ACPI 2.0, there are many machines that
374 * contain this type of code. Each block of detected executable AML code
375 * outside of any control method is wrapped with a temporary control
376 * method object and placed on a global list. The methods on this list
377 * are executed below.
379 AcpiNsExecModuleCodeList ();
382 * Initialize the objects that remain uninitialized. This runs the
383 * executable AML that may be part of the declaration of these objects:
384 * OperationRegions, BufferFields, Buffers, and Packages.
386 if (!(Flags & ACPI_NO_OBJECT_INIT))
388 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
389 "[Init] Completing Initialization of ACPI Objects\n"));
391 Status = AcpiNsInitializeObjects ();
392 if (ACPI_FAILURE (Status))
394 return_ACPI_STATUS (Status);
399 * Initialize all device objects in the namespace. This runs the device
400 * _STA and _INI methods.
402 if (!(Flags & ACPI_NO_DEVICE_INIT))
404 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
405 "[Init] Initializing ACPI Devices\n"));
407 Status = AcpiNsInitializeDevices ();
408 if (ACPI_FAILURE (Status))
410 return_ACPI_STATUS (Status);
415 * Empty the caches (delete the cached objects) on the assumption that
416 * the table load filled them up more than they will be at runtime --
417 * thus wasting non-paged memory.
419 Status = AcpiPurgeCachedObjects ();
421 AcpiGbl_StartupFlags |= ACPI_INITIALIZED_OK;
422 return_ACPI_STATUS (Status);
425 ACPI_EXPORT_SYMBOL (AcpiInitializeObjects)
430 /*******************************************************************************
432 * FUNCTION: AcpiTerminate
438 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
440 ******************************************************************************/
449 ACPI_FUNCTION_TRACE (AcpiTerminate);
452 /* Just exit if subsystem is already shutdown */
454 if (AcpiGbl_Shutdown)
456 ACPI_ERROR ((AE_INFO, "ACPI Subsystem is already terminated"));
457 return_ACPI_STATUS (AE_OK);
460 /* Subsystem appears active, go ahead and shut it down */
462 AcpiGbl_Shutdown = TRUE;
463 AcpiGbl_StartupFlags = 0;
464 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
466 /* Terminate the AML Debugger if present */
468 ACPI_DEBUGGER_EXEC (AcpiGbl_DbTerminateThreads = TRUE);
470 /* Shutdown and free all resources */
472 AcpiUtSubsystemShutdown ();
474 /* Free the mutex objects */
476 AcpiUtMutexTerminate ();
481 /* Shut down the debugger */
486 /* Now we can shutdown the OS-dependent layer */
488 Status = AcpiOsTerminate ();
489 return_ACPI_STATUS (Status);
492 ACPI_EXPORT_SYMBOL (AcpiTerminate)
495 #ifndef ACPI_ASL_COMPILER
496 /*******************************************************************************
498 * FUNCTION: AcpiSubsystemStatus
502 * RETURN: Status of the ACPI subsystem
504 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
505 * before making any other calls, to ensure the subsystem
506 * initialized successfully.
508 ******************************************************************************/
511 AcpiSubsystemStatus (
515 if (AcpiGbl_StartupFlags & ACPI_INITIALIZED_OK)
525 ACPI_EXPORT_SYMBOL (AcpiSubsystemStatus)
528 /*******************************************************************************
530 * FUNCTION: AcpiGetSystemInfo
532 * PARAMETERS: OutBuffer - A buffer to receive the resources for the
535 * RETURN: Status - the status of the call
537 * DESCRIPTION: This function is called to get information about the current
538 * state of the ACPI subsystem. It will return system information
541 * If the function fails an appropriate status will be returned
542 * and the value of OutBuffer is undefined.
544 ******************************************************************************/
548 ACPI_BUFFER *OutBuffer)
550 ACPI_SYSTEM_INFO *InfoPtr;
554 ACPI_FUNCTION_TRACE (AcpiGetSystemInfo);
557 /* Parameter validation */
559 Status = AcpiUtValidateBuffer (OutBuffer);
560 if (ACPI_FAILURE (Status))
562 return_ACPI_STATUS (Status);
565 /* Validate/Allocate/Clear caller buffer */
567 Status = AcpiUtInitializeBuffer (OutBuffer, sizeof (ACPI_SYSTEM_INFO));
568 if (ACPI_FAILURE (Status))
570 return_ACPI_STATUS (Status);
574 * Populate the return buffer
576 InfoPtr = (ACPI_SYSTEM_INFO *) OutBuffer->Pointer;
578 InfoPtr->AcpiCaVersion = ACPI_CA_VERSION;
580 /* System flags (ACPI capabilities) */
582 InfoPtr->Flags = ACPI_SYS_MODE_ACPI;
584 /* Timer resolution - 24 or 32 bits */
586 if (AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER)
588 InfoPtr->TimerResolution = 24;
592 InfoPtr->TimerResolution = 32;
595 /* Clear the reserved fields */
597 InfoPtr->Reserved1 = 0;
598 InfoPtr->Reserved2 = 0;
600 /* Current debug levels */
602 InfoPtr->DebugLayer = AcpiDbgLayer;
603 InfoPtr->DebugLevel = AcpiDbgLevel;
605 return_ACPI_STATUS (AE_OK);
608 ACPI_EXPORT_SYMBOL (AcpiGetSystemInfo)
611 /*******************************************************************************
613 * FUNCTION: AcpiGetStatistics
615 * PARAMETERS: Stats - Where the statistics are returned
617 * RETURN: Status - the status of the call
619 * DESCRIPTION: Get the contents of the various system counters
621 ******************************************************************************/
625 ACPI_STATISTICS *Stats)
627 ACPI_FUNCTION_TRACE (AcpiGetStatistics);
630 /* Parameter validation */
634 return_ACPI_STATUS (AE_BAD_PARAMETER);
637 /* Various interrupt-based event counters */
639 Stats->SciCount = AcpiSciCount;
640 Stats->GpeCount = AcpiGpeCount;
642 ACPI_MEMCPY (Stats->FixedEventCount, AcpiFixedEventCount,
643 sizeof (AcpiFixedEventCount));
648 Stats->MethodCount = AcpiMethodCount;
650 return_ACPI_STATUS (AE_OK);
653 ACPI_EXPORT_SYMBOL (AcpiGetStatistics)
656 /*****************************************************************************
658 * FUNCTION: AcpiInstallInitializationHandler
660 * PARAMETERS: Handler - Callback procedure
661 * Function - Not (currently) used, see below
665 * DESCRIPTION: Install an initialization handler
667 * TBD: When a second function is added, must save the Function also.
669 ****************************************************************************/
672 AcpiInstallInitializationHandler (
673 ACPI_INIT_HANDLER Handler,
679 return (AE_BAD_PARAMETER);
682 if (AcpiGbl_InitHandler)
684 return (AE_ALREADY_EXISTS);
687 AcpiGbl_InitHandler = Handler;
691 ACPI_EXPORT_SYMBOL (AcpiInstallInitializationHandler)
694 /*****************************************************************************
696 * FUNCTION: AcpiPurgeCachedObjects
702 * DESCRIPTION: Empty all caches (delete the cached objects)
704 ****************************************************************************/
707 AcpiPurgeCachedObjects (
710 ACPI_FUNCTION_TRACE (AcpiPurgeCachedObjects);
712 (void) AcpiOsPurgeCache (AcpiGbl_StateCache);
713 (void) AcpiOsPurgeCache (AcpiGbl_OperandCache);
714 (void) AcpiOsPurgeCache (AcpiGbl_PsNodeCache);
715 (void) AcpiOsPurgeCache (AcpiGbl_PsNodeExtCache);
716 return_ACPI_STATUS (AE_OK);
719 ACPI_EXPORT_SYMBOL (AcpiPurgeCachedObjects)
722 /*****************************************************************************
724 * FUNCTION: AcpiInstallInterface
726 * PARAMETERS: InterfaceName - The interface to install
730 * DESCRIPTION: Install an _OSI interface to the global list
732 ****************************************************************************/
735 AcpiInstallInterface (
736 ACPI_STRING InterfaceName)
739 ACPI_INTERFACE_INFO *InterfaceInfo;
742 /* Parameter validation */
744 if (!InterfaceName || (ACPI_STRLEN (InterfaceName) == 0))
746 return (AE_BAD_PARAMETER);
749 (void) AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
751 /* Check if the interface name is already in the global list */
753 InterfaceInfo = AcpiUtGetInterface (InterfaceName);
757 * The interface already exists in the list. This is OK if the
758 * interface has been marked invalid -- just clear the bit.
760 if (InterfaceInfo->Flags & ACPI_OSI_INVALID)
762 InterfaceInfo->Flags &= ~ACPI_OSI_INVALID;
767 Status = AE_ALREADY_EXISTS;
772 /* New interface name, install into the global list */
774 Status = AcpiUtInstallInterface (InterfaceName);
777 AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
781 ACPI_EXPORT_SYMBOL (AcpiInstallInterface)
784 /*****************************************************************************
786 * FUNCTION: AcpiRemoveInterface
788 * PARAMETERS: InterfaceName - The interface to remove
792 * DESCRIPTION: Remove an _OSI interface from the global list
794 ****************************************************************************/
797 AcpiRemoveInterface (
798 ACPI_STRING InterfaceName)
803 /* Parameter validation */
805 if (!InterfaceName || (ACPI_STRLEN (InterfaceName) == 0))
807 return (AE_BAD_PARAMETER);
810 (void) AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
812 Status = AcpiUtRemoveInterface (InterfaceName);
814 AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
818 ACPI_EXPORT_SYMBOL (AcpiRemoveInterface)
821 /*****************************************************************************
823 * FUNCTION: AcpiInstallInterfaceHandler
825 * PARAMETERS: Handler - The _OSI interface handler to install
826 * NULL means "remove existing handler"
830 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
831 * invoked during execution of the internal implementation of
832 * _OSI. A NULL handler simply removes any existing handler.
834 ****************************************************************************/
837 AcpiInstallInterfaceHandler (
838 ACPI_INTERFACE_HANDLER Handler)
840 ACPI_STATUS Status = AE_OK;
843 (void) AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
845 if (Handler && AcpiGbl_InterfaceHandler)
847 Status = AE_ALREADY_EXISTS;
851 AcpiGbl_InterfaceHandler = Handler;
854 AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
858 ACPI_EXPORT_SYMBOL (AcpiInstallInterfaceHandler)
860 #endif /* !ACPI_ASL_COMPILER */