1 /******************************************************************************
3 * Module Name: utxface - External interfaces for "global" ACPI functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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 <linux/export.h>
45 #include <acpi/acpi.h>
52 #define _COMPONENT ACPI_UTILITIES
53 ACPI_MODULE_NAME("utxface")
55 #ifndef ACPI_ASL_COMPILER
56 /*******************************************************************************
58 * FUNCTION: acpi_initialize_subsystem
64 * DESCRIPTION: Initializes all global variables. This is the first function
65 * called, so any early initialization belongs here.
67 ******************************************************************************/
68 acpi_status __init acpi_initialize_subsystem(void)
72 ACPI_FUNCTION_TRACE(acpi_initialize_subsystem);
74 acpi_gbl_startup_flags = ACPI_SUBSYSTEM_INITIALIZE;
75 ACPI_DEBUG_EXEC(acpi_ut_init_stack_ptr_trace());
77 /* Initialize the OS-Dependent layer */
79 status = acpi_os_initialize();
80 if (ACPI_FAILURE(status)) {
81 ACPI_EXCEPTION((AE_INFO, status, "During OSL initialization"));
82 return_ACPI_STATUS(status);
85 /* Initialize all globals used by the subsystem */
87 status = acpi_ut_init_globals();
88 if (ACPI_FAILURE(status)) {
89 ACPI_EXCEPTION((AE_INFO, status,
90 "During initialization of globals"));
91 return_ACPI_STATUS(status);
94 /* Create the default mutex objects */
96 status = acpi_ut_mutex_initialize();
97 if (ACPI_FAILURE(status)) {
98 ACPI_EXCEPTION((AE_INFO, status,
99 "During Global Mutex creation"));
100 return_ACPI_STATUS(status);
104 * Initialize the namespace manager and
105 * the root of the namespace tree
107 status = acpi_ns_root_initialize();
108 if (ACPI_FAILURE(status)) {
109 ACPI_EXCEPTION((AE_INFO, status,
110 "During Namespace initialization"));
111 return_ACPI_STATUS(status);
114 /* Initialize the global OSI interfaces list with the static names */
116 status = acpi_ut_initialize_interfaces();
117 if (ACPI_FAILURE(status)) {
118 ACPI_EXCEPTION((AE_INFO, status,
119 "During OSI interfaces initialization"));
120 return_ACPI_STATUS(status);
123 /* If configured, initialize the AML debugger */
125 ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
126 return_ACPI_STATUS(status);
129 /*******************************************************************************
131 * FUNCTION: acpi_enable_subsystem
133 * PARAMETERS: Flags - Init/enable Options
137 * DESCRIPTION: Completes the subsystem initialization including hardware.
138 * Puts system into ACPI mode if it isn't already.
140 ******************************************************************************/
141 acpi_status acpi_enable_subsystem(u32 flags)
143 acpi_status status = AE_OK;
145 ACPI_FUNCTION_TRACE(acpi_enable_subsystem);
147 /* Enable ACPI mode */
149 if (!(flags & ACPI_NO_ACPI_ENABLE)) {
150 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
151 "[Init] Going into ACPI mode\n"));
153 acpi_gbl_original_mode = acpi_hw_get_mode();
155 status = acpi_enable();
156 if (ACPI_FAILURE(status)) {
157 ACPI_WARNING((AE_INFO, "AcpiEnable failed"));
158 return_ACPI_STATUS(status);
163 * Obtain a permanent mapping for the FACS. This is required for the
164 * Global Lock and the Firmware Waking Vector
166 if (!(flags & ACPI_NO_FACS_INIT)) {
167 status = acpi_tb_initialize_facs();
168 if (ACPI_FAILURE(status)) {
169 ACPI_WARNING((AE_INFO, "Could not map the FACS table"));
170 return_ACPI_STATUS(status);
175 * Install the default op_region handlers. These are installed unless
176 * other handlers have already been installed via the
177 * install_address_space_handler interface.
179 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
180 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
181 "[Init] Installing default address space handlers\n"));
183 status = acpi_ev_install_region_handlers();
184 if (ACPI_FAILURE(status)) {
185 return_ACPI_STATUS(status);
190 * Initialize ACPI Event handling (Fixed and General Purpose)
192 * Note1: We must have the hardware and events initialized before we can
193 * execute any control methods safely. Any control method can require
194 * ACPI hardware support, so the hardware must be fully initialized before
195 * any method execution!
197 * Note2: Fixed events are initialized and enabled here. GPEs are
198 * initialized, but cannot be enabled until after the hardware is
199 * completely initialized (SCI and global_lock activated)
201 if (!(flags & ACPI_NO_EVENT_INIT)) {
202 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
203 "[Init] Initializing ACPI events\n"));
205 status = acpi_ev_initialize_events();
206 if (ACPI_FAILURE(status)) {
207 return_ACPI_STATUS(status);
212 * Install the SCI handler and Global Lock handler. This completes the
213 * hardware initialization.
215 if (!(flags & ACPI_NO_HANDLER_INIT)) {
216 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
217 "[Init] Installing SCI/GL handlers\n"));
219 status = acpi_ev_install_xrupt_handlers();
220 if (ACPI_FAILURE(status)) {
221 return_ACPI_STATUS(status);
225 return_ACPI_STATUS(status);
228 ACPI_EXPORT_SYMBOL(acpi_enable_subsystem)
230 /*******************************************************************************
232 * FUNCTION: acpi_initialize_objects
234 * PARAMETERS: Flags - Init/enable Options
238 * DESCRIPTION: Completes namespace initialization by initializing device
239 * objects and executing AML code for Regions, buffers, etc.
241 ******************************************************************************/
242 acpi_status acpi_initialize_objects(u32 flags)
244 acpi_status status = AE_OK;
246 ACPI_FUNCTION_TRACE(acpi_initialize_objects);
249 * Run all _REG methods
251 * Note: Any objects accessed by the _REG methods will be automatically
252 * initialized, even if they contain executable AML (see the call to
253 * acpi_ns_initialize_objects below).
255 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
256 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
257 "[Init] Executing _REG OpRegion methods\n"));
259 status = acpi_ev_initialize_op_regions();
260 if (ACPI_FAILURE(status)) {
261 return_ACPI_STATUS(status);
266 * Execute any module-level code that was detected during the table load
267 * phase. Although illegal since ACPI 2.0, there are many machines that
268 * contain this type of code. Each block of detected executable AML code
269 * outside of any control method is wrapped with a temporary control
270 * method object and placed on a global list. The methods on this list
271 * are executed below.
273 acpi_ns_exec_module_code_list();
276 * Initialize the objects that remain uninitialized. This runs the
277 * executable AML that may be part of the declaration of these objects:
278 * operation_regions, buffer_fields, Buffers, and Packages.
280 if (!(flags & ACPI_NO_OBJECT_INIT)) {
281 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
282 "[Init] Completing Initialization of ACPI Objects\n"));
284 status = acpi_ns_initialize_objects();
285 if (ACPI_FAILURE(status)) {
286 return_ACPI_STATUS(status);
291 * Initialize all device objects in the namespace. This runs the device
292 * _STA and _INI methods.
294 if (!(flags & ACPI_NO_DEVICE_INIT)) {
295 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
296 "[Init] Initializing ACPI Devices\n"));
298 status = acpi_ns_initialize_devices();
299 if (ACPI_FAILURE(status)) {
300 return_ACPI_STATUS(status);
305 * Empty the caches (delete the cached objects) on the assumption that
306 * the table load filled them up more than they will be at runtime --
307 * thus wasting non-paged memory.
309 status = acpi_purge_cached_objects();
311 acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
312 return_ACPI_STATUS(status);
315 ACPI_EXPORT_SYMBOL(acpi_initialize_objects)
318 /*******************************************************************************
320 * FUNCTION: acpi_terminate
326 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
328 ******************************************************************************/
329 acpi_status acpi_terminate(void)
333 ACPI_FUNCTION_TRACE(acpi_terminate);
335 /* Just exit if subsystem is already shutdown */
337 if (acpi_gbl_shutdown) {
338 ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
339 return_ACPI_STATUS(AE_OK);
342 /* Subsystem appears active, go ahead and shut it down */
344 acpi_gbl_shutdown = TRUE;
345 acpi_gbl_startup_flags = 0;
346 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
348 /* Terminate the AML Debugger if present */
350 ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
352 /* Shutdown and free all resources */
354 acpi_ut_subsystem_shutdown();
356 /* Free the mutex objects */
358 acpi_ut_mutex_terminate();
362 /* Shut down the debugger */
367 /* Now we can shutdown the OS-dependent layer */
369 status = acpi_os_terminate();
370 return_ACPI_STATUS(status);
373 ACPI_EXPORT_SYMBOL(acpi_terminate)
375 #ifndef ACPI_ASL_COMPILER
376 #ifdef ACPI_FUTURE_USAGE
377 /*******************************************************************************
379 * FUNCTION: acpi_subsystem_status
383 * RETURN: Status of the ACPI subsystem
385 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
386 * before making any other calls, to ensure the subsystem
387 * initialized successfully.
389 ******************************************************************************/
390 acpi_status acpi_subsystem_status(void)
393 if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
400 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
402 /*******************************************************************************
404 * FUNCTION: acpi_get_system_info
406 * PARAMETERS: out_buffer - A buffer to receive the resources for the
409 * RETURN: Status - the status of the call
411 * DESCRIPTION: This function is called to get information about the current
412 * state of the ACPI subsystem. It will return system information
415 * If the function fails an appropriate status will be returned
416 * and the value of out_buffer is undefined.
418 ******************************************************************************/
419 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
421 struct acpi_system_info *info_ptr;
424 ACPI_FUNCTION_TRACE(acpi_get_system_info);
426 /* Parameter validation */
428 status = acpi_ut_validate_buffer(out_buffer);
429 if (ACPI_FAILURE(status)) {
430 return_ACPI_STATUS(status);
433 /* Validate/Allocate/Clear caller buffer */
436 acpi_ut_initialize_buffer(out_buffer,
437 sizeof(struct acpi_system_info));
438 if (ACPI_FAILURE(status)) {
439 return_ACPI_STATUS(status);
443 * Populate the return buffer
445 info_ptr = (struct acpi_system_info *)out_buffer->pointer;
447 info_ptr->acpi_ca_version = ACPI_CA_VERSION;
449 /* System flags (ACPI capabilities) */
451 info_ptr->flags = ACPI_SYS_MODE_ACPI;
453 /* Timer resolution - 24 or 32 bits */
455 if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
456 info_ptr->timer_resolution = 24;
458 info_ptr->timer_resolution = 32;
461 /* Clear the reserved fields */
463 info_ptr->reserved1 = 0;
464 info_ptr->reserved2 = 0;
466 /* Current debug levels */
468 info_ptr->debug_layer = acpi_dbg_layer;
469 info_ptr->debug_level = acpi_dbg_level;
471 return_ACPI_STATUS(AE_OK);
474 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
476 /*****************************************************************************
478 * FUNCTION: acpi_install_initialization_handler
480 * PARAMETERS: Handler - Callback procedure
481 * Function - Not (currently) used, see below
485 * DESCRIPTION: Install an initialization handler
487 * TBD: When a second function is added, must save the Function also.
489 ****************************************************************************/
491 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
495 return (AE_BAD_PARAMETER);
498 if (acpi_gbl_init_handler) {
499 return (AE_ALREADY_EXISTS);
502 acpi_gbl_init_handler = handler;
506 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
507 #endif /* ACPI_FUTURE_USAGE */
509 /*****************************************************************************
511 * FUNCTION: acpi_purge_cached_objects
517 * DESCRIPTION: Empty all caches (delete the cached objects)
519 ****************************************************************************/
520 acpi_status acpi_purge_cached_objects(void)
522 ACPI_FUNCTION_TRACE(acpi_purge_cached_objects);
524 (void)acpi_os_purge_cache(acpi_gbl_state_cache);
525 (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
526 (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
527 (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
528 return_ACPI_STATUS(AE_OK);
531 ACPI_EXPORT_SYMBOL(acpi_purge_cached_objects)
533 /*****************************************************************************
535 * FUNCTION: acpi_install_interface
537 * PARAMETERS: interface_name - The interface to install
541 * DESCRIPTION: Install an _OSI interface to the global list
543 ****************************************************************************/
544 acpi_status acpi_install_interface(acpi_string interface_name)
547 struct acpi_interface_info *interface_info;
549 /* Parameter validation */
551 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
552 return (AE_BAD_PARAMETER);
555 (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
557 /* Check if the interface name is already in the global list */
559 interface_info = acpi_ut_get_interface(interface_name);
560 if (interface_info) {
562 * The interface already exists in the list. This is OK if the
563 * interface has been marked invalid -- just clear the bit.
565 if (interface_info->flags & ACPI_OSI_INVALID) {
566 interface_info->flags &= ~ACPI_OSI_INVALID;
569 status = AE_ALREADY_EXISTS;
572 /* New interface name, install into the global list */
574 status = acpi_ut_install_interface(interface_name);
577 acpi_os_release_mutex(acpi_gbl_osi_mutex);
581 ACPI_EXPORT_SYMBOL(acpi_install_interface)
583 /*****************************************************************************
585 * FUNCTION: acpi_remove_interface
587 * PARAMETERS: interface_name - The interface to remove
591 * DESCRIPTION: Remove an _OSI interface from the global list
593 ****************************************************************************/
594 acpi_status acpi_remove_interface(acpi_string interface_name)
598 /* Parameter validation */
600 if (!interface_name || (ACPI_STRLEN(interface_name) == 0)) {
601 return (AE_BAD_PARAMETER);
604 (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
606 status = acpi_ut_remove_interface(interface_name);
608 acpi_os_release_mutex(acpi_gbl_osi_mutex);
612 ACPI_EXPORT_SYMBOL(acpi_remove_interface)
614 /*****************************************************************************
616 * FUNCTION: acpi_install_interface_handler
618 * PARAMETERS: Handler - The _OSI interface handler to install
619 * NULL means "remove existing handler"
623 * DESCRIPTION: Install a handler for the predefined _OSI ACPI method.
624 * invoked during execution of the internal implementation of
625 * _OSI. A NULL handler simply removes any existing handler.
627 ****************************************************************************/
628 acpi_status acpi_install_interface_handler(acpi_interface_handler handler)
630 acpi_status status = AE_OK;
632 (void)acpi_os_acquire_mutex(acpi_gbl_osi_mutex, ACPI_WAIT_FOREVER);
634 if (handler && acpi_gbl_interface_handler) {
635 status = AE_ALREADY_EXISTS;
637 acpi_gbl_interface_handler = handler;
640 acpi_os_release_mutex(acpi_gbl_osi_mutex);
644 ACPI_EXPORT_SYMBOL(acpi_install_interface_handler)
645 #endif /* !ACPI_ASL_COMPILER */