1 /******************************************************************************
3 * Module Name: utxface - External interfaces for "global" ACPI functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2010, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <acpi/acpi.h>
51 #define _COMPONENT ACPI_UTILITIES
52 ACPI_MODULE_NAME("utxface")
54 #ifndef ACPI_ASL_COMPILER
55 /*******************************************************************************
57 * FUNCTION: acpi_initialize_subsystem
63 * DESCRIPTION: Initializes all global variables. This is the first function
64 * called, so any early initialization belongs here.
66 ******************************************************************************/
67 acpi_status __init acpi_initialize_subsystem(void)
71 ACPI_FUNCTION_TRACE(acpi_initialize_subsystem);
73 acpi_gbl_startup_flags = ACPI_SUBSYSTEM_INITIALIZE;
74 ACPI_DEBUG_EXEC(acpi_ut_init_stack_ptr_trace());
76 /* Initialize the OS-Dependent layer */
78 status = acpi_os_initialize();
79 if (ACPI_FAILURE(status)) {
80 ACPI_EXCEPTION((AE_INFO, status, "During OSL initialization"));
81 return_ACPI_STATUS(status);
84 /* Initialize all globals used by the subsystem */
86 status = acpi_ut_init_globals();
87 if (ACPI_FAILURE(status)) {
88 ACPI_EXCEPTION((AE_INFO, status,
89 "During initialization of globals"));
90 return_ACPI_STATUS(status);
93 /* Create the default mutex objects */
95 status = acpi_ut_mutex_initialize();
96 if (ACPI_FAILURE(status)) {
97 ACPI_EXCEPTION((AE_INFO, status,
98 "During Global Mutex creation"));
99 return_ACPI_STATUS(status);
103 * Initialize the namespace manager and
104 * the root of the namespace tree
106 status = acpi_ns_root_initialize();
107 if (ACPI_FAILURE(status)) {
108 ACPI_EXCEPTION((AE_INFO, status,
109 "During Namespace initialization"));
110 return_ACPI_STATUS(status);
113 /* Initialize the global OSI interfaces list with the static names */
115 status = acpi_ut_initialize_interfaces();
116 if (ACPI_FAILURE(status)) {
117 ACPI_EXCEPTION((AE_INFO, status,
118 "During OSI interfaces initialization"));
119 return_ACPI_STATUS(status);
122 /* If configured, initialize the AML debugger */
124 ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
125 return_ACPI_STATUS(status);
128 /*******************************************************************************
130 * FUNCTION: acpi_enable_subsystem
132 * PARAMETERS: Flags - Init/enable Options
136 * DESCRIPTION: Completes the subsystem initialization including hardware.
137 * Puts system into ACPI mode if it isn't already.
139 ******************************************************************************/
140 acpi_status acpi_enable_subsystem(u32 flags)
142 acpi_status status = AE_OK;
144 ACPI_FUNCTION_TRACE(acpi_enable_subsystem);
146 /* Enable ACPI mode */
148 if (!(flags & ACPI_NO_ACPI_ENABLE)) {
149 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
150 "[Init] Going into ACPI mode\n"));
152 acpi_gbl_original_mode = acpi_hw_get_mode();
154 status = acpi_enable();
155 if (ACPI_FAILURE(status)) {
156 ACPI_WARNING((AE_INFO, "AcpiEnable failed"));
157 return_ACPI_STATUS(status);
162 * Obtain a permanent mapping for the FACS. This is required for the
163 * Global Lock and the Firmware Waking Vector
165 status = acpi_tb_initialize_facs();
166 if (ACPI_FAILURE(status)) {
167 ACPI_WARNING((AE_INFO, "Could not map the FACS table"));
168 return_ACPI_STATUS(status);
172 * Install the default op_region handlers. These are installed unless
173 * other handlers have already been installed via the
174 * install_address_space_handler interface.
176 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
177 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
178 "[Init] Installing default address space handlers\n"));
180 status = acpi_ev_install_region_handlers();
181 if (ACPI_FAILURE(status)) {
182 return_ACPI_STATUS(status);
187 * Initialize ACPI Event handling (Fixed and General Purpose)
189 * Note1: We must have the hardware and events initialized before we can
190 * execute any control methods safely. Any control method can require
191 * ACPI hardware support, so the hardware must be fully initialized before
192 * any method execution!
194 * Note2: Fixed events are initialized and enabled here. GPEs are
195 * initialized, but cannot be enabled until after the hardware is
196 * completely initialized (SCI and global_lock activated)
198 if (!(flags & ACPI_NO_EVENT_INIT)) {
199 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
200 "[Init] Initializing ACPI events\n"));
202 status = acpi_ev_initialize_events();
203 if (ACPI_FAILURE(status)) {
204 return_ACPI_STATUS(status);
209 * Install the SCI handler and Global Lock handler. This completes the
210 * hardware initialization.
212 if (!(flags & ACPI_NO_HANDLER_INIT)) {
213 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
214 "[Init] Installing SCI/GL handlers\n"));
216 status = acpi_ev_install_xrupt_handlers();
217 if (ACPI_FAILURE(status)) {
218 return_ACPI_STATUS(status);
222 return_ACPI_STATUS(status);
225 ACPI_EXPORT_SYMBOL(acpi_enable_subsystem)
227 /*******************************************************************************
229 * FUNCTION: acpi_initialize_objects
231 * PARAMETERS: Flags - Init/enable Options
235 * DESCRIPTION: Completes namespace initialization by initializing device
236 * objects and executing AML code for Regions, buffers, etc.
238 ******************************************************************************/
239 acpi_status acpi_initialize_objects(u32 flags)
241 acpi_status status = AE_OK;
243 ACPI_FUNCTION_TRACE(acpi_initialize_objects);
246 * Run all _REG methods
248 * Note: Any objects accessed by the _REG methods will be automatically
249 * initialized, even if they contain executable AML (see the call to
250 * acpi_ns_initialize_objects below).
252 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
253 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
254 "[Init] Executing _REG OpRegion methods\n"));
256 status = acpi_ev_initialize_op_regions();
257 if (ACPI_FAILURE(status)) {
258 return_ACPI_STATUS(status);
263 * Execute any module-level code that was detected during the table load
264 * phase. Although illegal since ACPI 2.0, there are many machines that
265 * contain this type of code. Each block of detected executable AML code
266 * outside of any control method is wrapped with a temporary control
267 * method object and placed on a global list. The methods on this list
268 * are executed below.
270 acpi_ns_exec_module_code_list();
273 * Initialize the objects that remain uninitialized. This runs the
274 * executable AML that may be part of the declaration of these objects:
275 * operation_regions, buffer_fields, Buffers, and Packages.
277 if (!(flags & ACPI_NO_OBJECT_INIT)) {
278 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
279 "[Init] Completing Initialization of ACPI Objects\n"));
281 status = acpi_ns_initialize_objects();
282 if (ACPI_FAILURE(status)) {
283 return_ACPI_STATUS(status);
288 * Initialize all device objects in the namespace. This runs the device
289 * _STA and _INI methods.
291 if (!(flags & ACPI_NO_DEVICE_INIT)) {
292 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
293 "[Init] Initializing ACPI Devices\n"));
295 status = acpi_ns_initialize_devices();
296 if (ACPI_FAILURE(status)) {
297 return_ACPI_STATUS(status);
302 * Complete the GPE initialization for the GPE blocks defined in the FADT
303 * (GPE block 0 and 1).
305 * NOTE: Currently, there seems to be no need to run the _REG methods
306 * before enabling the GPEs.
308 if (!(flags & ACPI_NO_EVENT_INIT)) {
309 status = acpi_ev_install_fadt_gpes();
310 if (ACPI_FAILURE(status))
315 * Empty the caches (delete the cached objects) on the assumption that
316 * the table load filled them up more than they will be at runtime --
317 * thus wasting non-paged memory.
319 status = acpi_purge_cached_objects();
321 acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
322 return_ACPI_STATUS(status);
325 ACPI_EXPORT_SYMBOL(acpi_initialize_objects)
328 /*******************************************************************************
330 * FUNCTION: acpi_terminate
336 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
338 ******************************************************************************/
339 acpi_status acpi_terminate(void)
343 ACPI_FUNCTION_TRACE(acpi_terminate);
345 /* Just exit if subsystem is already shutdown */
347 if (acpi_gbl_shutdown) {
348 ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
349 return_ACPI_STATUS(AE_OK);
352 /* Subsystem appears active, go ahead and shut it down */
354 acpi_gbl_shutdown = TRUE;
355 acpi_gbl_startup_flags = 0;
356 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
358 /* Terminate the AML Debugger if present */
360 ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
362 /* Shutdown and free all resources */
364 acpi_ut_subsystem_shutdown();
366 /* Free the mutex objects */
368 acpi_ut_mutex_terminate();
372 /* Shut down the debugger */
377 /* Now we can shutdown the OS-dependent layer */
379 status = acpi_os_terminate();
380 return_ACPI_STATUS(status);
383 ACPI_EXPORT_SYMBOL(acpi_terminate)
385 #ifndef ACPI_ASL_COMPILER
386 #ifdef ACPI_FUTURE_USAGE
387 /*******************************************************************************
389 * FUNCTION: acpi_subsystem_status
393 * RETURN: Status of the ACPI subsystem
395 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
396 * before making any other calls, to ensure the subsystem
397 * initialized successfully.
399 ******************************************************************************/
400 acpi_status acpi_subsystem_status(void)
403 if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
410 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
412 /*******************************************************************************
414 * FUNCTION: acpi_get_system_info
416 * PARAMETERS: out_buffer - A buffer to receive the resources for the
419 * RETURN: Status - the status of the call
421 * DESCRIPTION: This function is called to get information about the current
422 * state of the ACPI subsystem. It will return system information
425 * If the function fails an appropriate status will be returned
426 * and the value of out_buffer is undefined.
428 ******************************************************************************/
429 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
431 struct acpi_system_info *info_ptr;
434 ACPI_FUNCTION_TRACE(acpi_get_system_info);
436 /* Parameter validation */
438 status = acpi_ut_validate_buffer(out_buffer);
439 if (ACPI_FAILURE(status)) {
440 return_ACPI_STATUS(status);
443 /* Validate/Allocate/Clear caller buffer */
446 acpi_ut_initialize_buffer(out_buffer,
447 sizeof(struct acpi_system_info));
448 if (ACPI_FAILURE(status)) {
449 return_ACPI_STATUS(status);
453 * Populate the return buffer
455 info_ptr = (struct acpi_system_info *)out_buffer->pointer;
457 info_ptr->acpi_ca_version = ACPI_CA_VERSION;
459 /* System flags (ACPI capabilities) */
461 info_ptr->flags = ACPI_SYS_MODE_ACPI;
463 /* Timer resolution - 24 or 32 bits */
465 if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
466 info_ptr->timer_resolution = 24;
468 info_ptr->timer_resolution = 32;
471 /* Clear the reserved fields */
473 info_ptr->reserved1 = 0;
474 info_ptr->reserved2 = 0;
476 /* Current debug levels */
478 info_ptr->debug_layer = acpi_dbg_layer;
479 info_ptr->debug_level = acpi_dbg_level;
481 return_ACPI_STATUS(AE_OK);
484 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
486 /*****************************************************************************
488 * FUNCTION: acpi_install_initialization_handler
490 * PARAMETERS: Handler - Callback procedure
491 * Function - Not (currently) used, see below
495 * DESCRIPTION: Install an initialization handler
497 * TBD: When a second function is added, must save the Function also.
499 ****************************************************************************/
501 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
505 return (AE_BAD_PARAMETER);
508 if (acpi_gbl_init_handler) {
509 return (AE_ALREADY_EXISTS);
512 acpi_gbl_init_handler = handler;
516 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
517 #endif /* ACPI_FUTURE_USAGE */
519 /*****************************************************************************
521 * FUNCTION: acpi_purge_cached_objects
527 * DESCRIPTION: Empty all caches (delete the cached objects)
529 ****************************************************************************/
530 acpi_status acpi_purge_cached_objects(void)
532 ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
534 (void)acpi_os_purge_cache(acpi_gbl_state_cache);
535 (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
536 (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
537 (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
538 return_ACPI_STATUS(AE_OK);
541 ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
543 /*****************************************************************************
545 * FUNCTION: acpi_install_interface
547 * PARAMETERS: interface_name - The interface to install
551 * DESCRIPTION: Install an _OSI interface to the global list
553 ****************************************************************************/
554 acpi_status acpi_install_interface(acpi_string interface_name)
557 struct acpi_interface_info *interface_info;
559 /* Parameter validation */
561 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
562 return (AE_BAD_PARAMETER);
565 (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
567 /* Check if the interface name is already in the global list */
569 interface_info = acpi_ut_get_interface(interface_name);
570 if (interface_info) {
572 * The interface already exists in the list. This is OK if the
573 * interface has been marked invalid -- just clear the bit.
575 if (interface_info->flags & ACPI_OSI_INVALID) {
576 interface_info->flags &= ~ACPI_OSI_INVALID;
579 status = AE_ALREADY_EXISTS;
582 /* New interface name, install into the global list */
584 status = acpi_ut_install_interface(interface_name);
587 acpi_os_release_mutex(acpi_gbl_osi_mutex);
591 ACPI_EXPORT_SYMBOL(acpi_install_interface)
593 /*****************************************************************************
595 * FUNCTION: acpi_remove_interface
597 * PARAMETERS: interface_name - The interface to remove
601 * DESCRIPTION: Remove an _OSI interface from the global list
603 ****************************************************************************/
604 acpi_status acpi_remove_interface(acpi_string interface_name)
608 /* Parameter validation */
610 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
611 return (AE_BAD_PARAMETER);
614 (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
616 status = acpi_ut_remove_interface(interface_name);
618 acpi_os_release_mutex(acpi_gbl_osi_mutex);
622 ACPI_EXPORT_SYMBOL(acpi_remove_interface)
624 /*****************************************************************************
626 * FUNCTION: acpi_install_interface_handler
628 * PARAMETERS: Handler - The _OSI interface handler to install
629 * NULL means "remove existing handler"
633 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
634 * invoked during execution of the internal implementation of
635 * _OSI. A NULL handler simply removes any existing handler.
637 ****************************************************************************/
638 acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
640 acpi_status status = AE_OK;
642 (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
644 if (handler && acpi_gbl_interface_handler) {
645 status = AE_ALREADY_EXISTS;
647 acpi_gbl_interface_handler = handler;
650 acpi_os_release_mutex(acpi_gbl_osi_mutex);
654 ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
655 #endif /* !ACPI_ASL_COMPILER */