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 /* If configured, initialize the AML debugger */
115 ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
116 return_ACPI_STATUS(status);
119 /*******************************************************************************
121 * FUNCTION: acpi_enable_subsystem
123 * PARAMETERS: Flags - Init/enable Options
127 * DESCRIPTION: Completes the subsystem initialization including hardware.
128 * Puts system into ACPI mode if it isn't already.
130 ******************************************************************************/
131 acpi_status acpi_enable_subsystem(u32 flags)
133 acpi_status status = AE_OK;
135 ACPI_FUNCTION_TRACE(acpi_enable_subsystem);
137 /* Enable ACPI mode */
139 if (!(flags & ACPI_NO_ACPI_ENABLE)) {
140 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
141 "[Init] Going into ACPI mode\n"));
143 acpi_gbl_original_mode = acpi_hw_get_mode();
145 status = acpi_enable();
146 if (ACPI_FAILURE(status)) {
147 ACPI_WARNING((AE_INFO, "AcpiEnable failed"));
148 return_ACPI_STATUS(status);
153 * Obtain a permanent mapping for the FACS. This is required for the
154 * Global Lock and the Firmware Waking Vector
156 status = acpi_tb_initialize_facs();
157 if (ACPI_FAILURE(status)) {
158 ACPI_WARNING((AE_INFO, "Could not map the FACS table"));
159 return_ACPI_STATUS(status);
163 * Install the default op_region handlers. These are installed unless
164 * other handlers have already been installed via the
165 * install_address_space_handler interface.
167 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
168 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
169 "[Init] Installing default address space handlers\n"));
171 status = acpi_ev_install_region_handlers();
172 if (ACPI_FAILURE(status)) {
173 return_ACPI_STATUS(status);
178 * Initialize ACPI Event handling (Fixed and General Purpose)
180 * Note1: We must have the hardware and events initialized before we can
181 * execute any control methods safely. Any control method can require
182 * ACPI hardware support, so the hardware must be fully initialized before
183 * any method execution!
185 * Note2: Fixed events are initialized and enabled here. GPEs are
186 * initialized, but cannot be enabled until after the hardware is
187 * completely initialized (SCI and global_lock activated)
189 if (!(flags & ACPI_NO_EVENT_INIT)) {
190 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
191 "[Init] Initializing ACPI events\n"));
193 status = acpi_ev_initialize_events();
194 if (ACPI_FAILURE(status)) {
195 return_ACPI_STATUS(status);
200 * Install the SCI handler and Global Lock handler. This completes the
201 * hardware initialization.
203 if (!(flags & ACPI_NO_HANDLER_INIT)) {
204 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
205 "[Init] Installing SCI/GL handlers\n"));
207 status = acpi_ev_install_xrupt_handlers();
208 if (ACPI_FAILURE(status)) {
209 return_ACPI_STATUS(status);
213 return_ACPI_STATUS(status);
216 ACPI_EXPORT_SYMBOL(acpi_enable_subsystem)
218 /*******************************************************************************
220 * FUNCTION: acpi_initialize_objects
222 * PARAMETERS: Flags - Init/enable Options
226 * DESCRIPTION: Completes namespace initialization by initializing device
227 * objects and executing AML code for Regions, buffers, etc.
229 ******************************************************************************/
230 acpi_status acpi_initialize_objects(u32 flags)
232 acpi_status status = AE_OK;
234 ACPI_FUNCTION_TRACE(acpi_initialize_objects);
237 * Run all _REG methods
239 * Note: Any objects accessed by the _REG methods will be automatically
240 * initialized, even if they contain executable AML (see the call to
241 * acpi_ns_initialize_objects below).
243 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
244 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
245 "[Init] Executing _REG OpRegion methods\n"));
247 status = acpi_ev_initialize_op_regions();
248 if (ACPI_FAILURE(status)) {
249 return_ACPI_STATUS(status);
254 * Execute any module-level code that was detected during the table load
255 * phase. Although illegal since ACPI 2.0, there are many machines that
256 * contain this type of code. Each block of detected executable AML code
257 * outside of any control method is wrapped with a temporary control
258 * method object and placed on a global list. The methods on this list
259 * are executed below.
261 acpi_ns_exec_module_code_list();
264 * Initialize the objects that remain uninitialized. This runs the
265 * executable AML that may be part of the declaration of these objects:
266 * operation_regions, buffer_fields, Buffers, and Packages.
268 if (!(flags & ACPI_NO_OBJECT_INIT)) {
269 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
270 "[Init] Completing Initialization of ACPI Objects\n"));
272 status = acpi_ns_initialize_objects();
273 if (ACPI_FAILURE(status)) {
274 return_ACPI_STATUS(status);
279 * Initialize all device objects in the namespace. This runs the device
280 * _STA and _INI methods.
282 if (!(flags & ACPI_NO_DEVICE_INIT)) {
283 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
284 "[Init] Initializing ACPI Devices\n"));
286 status = acpi_ns_initialize_devices();
287 if (ACPI_FAILURE(status)) {
288 return_ACPI_STATUS(status);
293 * Complete the GPE initialization for the GPE blocks defined in the FADT
294 * (GPE block 0 and 1).
296 * NOTE: Currently, there seems to be no need to run the _REG methods
297 * before enabling the GPEs.
299 if (!(flags & ACPI_NO_EVENT_INIT)) {
300 status = acpi_ev_install_fadt_gpes();
301 if (ACPI_FAILURE(status))
306 * Empty the caches (delete the cached objects) on the assumption that
307 * the table load filled them up more than they will be at runtime --
308 * thus wasting non-paged memory.
310 status = acpi_purge_cached_objects();
312 acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
313 return_ACPI_STATUS(status);
316 ACPI_EXPORT_SYMBOL(acpi_initialize_objects)
319 /*******************************************************************************
321 * FUNCTION: acpi_terminate
327 * DESCRIPTION: Shutdown the ACPICA subsystem and release all resources.
329 ******************************************************************************/
330 acpi_status acpi_terminate(void)
334 ACPI_FUNCTION_TRACE(acpi_terminate);
336 /* Just exit if subsystem is already shutdown */
338 if (acpi_gbl_shutdown) {
339 ACPI_ERROR((AE_INFO, "ACPI Subsystem is already terminated"));
340 return_ACPI_STATUS(AE_OK);
343 /* Subsystem appears active, go ahead and shut it down */
345 acpi_gbl_shutdown = TRUE;
346 acpi_gbl_startup_flags = 0;
347 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
349 /* Terminate the AML Debugger if present */
351 ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
353 /* Shutdown and free all resources */
355 acpi_ut_subsystem_shutdown();
357 /* Free the mutex objects */
359 acpi_ut_mutex_terminate();
363 /* Shut down the debugger */
368 /* Now we can shutdown the OS-dependent layer */
370 status = acpi_os_terminate();
371 return_ACPI_STATUS(status);
374 ACPI_EXPORT_SYMBOL(acpi_terminate)
376 #ifndef ACPI_ASL_COMPILER
377 #ifdef ACPI_FUTURE_USAGE
378 /*******************************************************************************
380 * FUNCTION: acpi_subsystem_status
384 * RETURN: Status of the ACPI subsystem
386 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
387 * before making any other calls, to ensure the subsystem
388 * initialized successfully.
390 ******************************************************************************/
391 acpi_status acpi_subsystem_status(void)
394 if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
401 ACPI_EXPORT_SYMBOL(acpi_subsystem_status)
403 /*******************************************************************************
405 * FUNCTION: acpi_get_system_info
407 * PARAMETERS: out_buffer - A buffer to receive the resources for the
410 * RETURN: Status - the status of the call
412 * DESCRIPTION: This function is called to get information about the current
413 * state of the ACPI subsystem. It will return system information
416 * If the function fails an appropriate status will be returned
417 * and the value of out_buffer is undefined.
419 ******************************************************************************/
420 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
422 struct acpi_system_info *info_ptr;
425 ACPI_FUNCTION_TRACE(acpi_get_system_info);
427 /* Parameter validation */
429 status = acpi_ut_validate_buffer(out_buffer);
430 if (ACPI_FAILURE(status)) {
431 return_ACPI_STATUS(status);
434 /* Validate/Allocate/Clear caller buffer */
437 acpi_ut_initialize_buffer(out_buffer,
438 sizeof(struct acpi_system_info));
439 if (ACPI_FAILURE(status)) {
440 return_ACPI_STATUS(status);
444 * Populate the return buffer
446 info_ptr = (struct acpi_system_info *)out_buffer->pointer;
448 info_ptr->acpi_ca_version = ACPI_CA_VERSION;
450 /* System flags (ACPI capabilities) */
452 info_ptr->flags = ACPI_SYS_MODE_ACPI;
454 /* Timer resolution - 24 or 32 bits */
456 if (acpi_gbl_FADT.flags & ACPI_FADT_32BIT_TIMER) {
457 info_ptr->timer_resolution = 24;
459 info_ptr->timer_resolution = 32;
462 /* Clear the reserved fields */
464 info_ptr->reserved1 = 0;
465 info_ptr->reserved2 = 0;
467 /* Current debug levels */
469 info_ptr->debug_layer = acpi_dbg_layer;
470 info_ptr->debug_level = acpi_dbg_level;
472 return_ACPI_STATUS(AE_OK);
475 ACPI_EXPORT_SYMBOL(acpi_get_system_info)
477 /*****************************************************************************
479 * FUNCTION: acpi_install_initialization_handler
481 * PARAMETERS: Handler - Callback procedure
482 * Function - Not (currently) used, see below
486 * DESCRIPTION: Install an initialization handler
488 * TBD: When a second function is added, must save the Function also.
490 ****************************************************************************/
492 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
496 return (AE_BAD_PARAMETER);
499 if (acpi_gbl_init_handler) {
500 return (AE_ALREADY_EXISTS);
503 acpi_gbl_init_handler = handler;
507 ACPI_EXPORT_SYMBOL(acpi_install_initialization_handler)
508 #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)