1 /******************************************************************************
3 * Module Name: utxface - External interfaces for "global" ACPI functions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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/module.h>
46 #include <acpi/acpi.h>
47 #include <acpi/acevents.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acdebug.h>
51 #define _COMPONENT ACPI_UTILITIES
52 ACPI_MODULE_NAME("utxface")
54 /*******************************************************************************
56 * FUNCTION: acpi_initialize_subsystem
62 * DESCRIPTION: Initializes all global variables. This is the first function
63 * called, so any early initialization belongs here.
65 ******************************************************************************/
66 acpi_status acpi_initialize_subsystem(void)
70 ACPI_FUNCTION_TRACE("acpi_initialize_subsystem");
72 ACPI_DEBUG_EXEC(acpi_ut_init_stack_ptr_trace());
74 /* Initialize the OS-Dependent layer */
76 status = acpi_os_initialize();
77 if (ACPI_FAILURE(status)) {
78 ACPI_EXCEPTION((AE_INFO, status, "During OSL initialization"));
79 return_ACPI_STATUS(status);
82 /* Initialize all globals used by the subsystem */
84 acpi_ut_init_globals();
86 /* Create the default mutex objects */
88 status = acpi_ut_mutex_initialize();
89 if (ACPI_FAILURE(status)) {
90 ACPI_EXCEPTION((AE_INFO, status,
91 "During Global Mutex creation"));
92 return_ACPI_STATUS(status);
96 * Initialize the namespace manager and
97 * the root of the namespace tree
99 status = acpi_ns_root_initialize();
100 if (ACPI_FAILURE(status)) {
101 ACPI_EXCEPTION((AE_INFO, status,
102 "During Namespace initialization"));
103 return_ACPI_STATUS(status);
106 /* If configured, initialize the AML debugger */
108 ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
109 return_ACPI_STATUS(status);
112 /*******************************************************************************
114 * FUNCTION: acpi_enable_subsystem
116 * PARAMETERS: Flags - Init/enable Options
120 * DESCRIPTION: Completes the subsystem initialization including hardware.
121 * Puts system into ACPI mode if it isn't already.
123 ******************************************************************************/
125 acpi_status acpi_enable_subsystem(u32 flags)
127 acpi_status status = AE_OK;
129 ACPI_FUNCTION_TRACE("acpi_enable_subsystem");
132 * We must initialize the hardware before we can enable ACPI.
133 * The values from the FADT are validated here.
135 if (!(flags & ACPI_NO_HARDWARE_INIT)) {
136 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
137 "[Init] Initializing ACPI hardware\n"));
139 status = acpi_hw_initialize();
140 if (ACPI_FAILURE(status)) {
141 return_ACPI_STATUS(status);
145 /* Enable ACPI mode */
147 if (!(flags & ACPI_NO_ACPI_ENABLE)) {
148 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
149 "[Init] Going into ACPI mode\n"));
151 acpi_gbl_original_mode = acpi_hw_get_mode();
153 status = acpi_enable();
154 if (ACPI_FAILURE(status)) {
155 ACPI_WARNING((AE_INFO, "acpi_enable failed"));
156 return_ACPI_STATUS(status);
161 * Install the default op_region handlers. These are installed unless
162 * other handlers have already been installed via the
163 * install_address_space_handler interface.
165 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
166 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
167 "[Init] Installing default address space handlers\n"));
169 status = acpi_ev_install_region_handlers();
170 if (ACPI_FAILURE(status)) {
171 return_ACPI_STATUS(status);
176 * Initialize ACPI Event handling (Fixed and General Purpose)
178 * Note1: We must have the hardware and events initialized before we can
179 * execute any control methods safely. Any control method can require
180 * ACPI hardware support, so the hardware must be fully initialized before
181 * any method execution!
183 * Note2: Fixed events are initialized and enabled here. GPEs are
184 * initialized, but cannot be enabled until after the hardware is
185 * completely initialized (SCI and global_lock activated)
187 if (!(flags & ACPI_NO_EVENT_INIT)) {
188 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
189 "[Init] Initializing ACPI events\n"));
191 status = acpi_ev_initialize_events();
192 if (ACPI_FAILURE(status)) {
193 return_ACPI_STATUS(status);
198 * Install the SCI handler and Global Lock handler. This completes the
199 * hardware initialization.
201 if (!(flags & ACPI_NO_HANDLER_INIT)) {
202 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
203 "[Init] Installing SCI/GL handlers\n"));
205 status = acpi_ev_install_xrupt_handlers();
206 if (ACPI_FAILURE(status)) {
207 return_ACPI_STATUS(status);
212 * Complete the GPE initialization for the GPE blocks defined in the FADT
213 * (GPE block 0 and 1).
215 * Note1: This is where the _PRW methods are executed for the GPEs. These
216 * methods can only be executed after the SCI and Global Lock handlers are
217 * installed and initialized.
219 * Note2: Currently, there seems to be no need to run the _REG methods
220 * before execution of the _PRW methods and enabling of the GPEs.
222 if (!(flags & ACPI_NO_EVENT_INIT)) {
223 status = acpi_ev_install_fadt_gpes();
224 if (ACPI_FAILURE(status)) {
229 return_ACPI_STATUS(status);
232 /*******************************************************************************
234 * FUNCTION: acpi_initialize_objects
236 * PARAMETERS: Flags - Init/enable Options
240 * DESCRIPTION: Completes namespace initialization by initializing device
241 * objects and executing AML code for Regions, buffers, etc.
243 ******************************************************************************/
245 acpi_status acpi_initialize_objects(u32 flags)
247 acpi_status status = AE_OK;
249 ACPI_FUNCTION_TRACE("acpi_initialize_objects");
252 * Run all _REG methods
254 * Note: Any objects accessed by the _REG methods will be automatically
255 * initialized, even if they contain executable AML (see the call to
256 * acpi_ns_initialize_objects below).
258 if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
259 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
260 "[Init] Executing _REG op_region methods\n"));
262 status = acpi_ev_initialize_op_regions();
263 if (ACPI_FAILURE(status)) {
264 return_ACPI_STATUS(status);
269 * Initialize the objects that remain uninitialized. This runs the
270 * executable AML that may be part of the declaration of these objects:
271 * operation_regions, buffer_fields, Buffers, and Packages.
273 if (!(flags & ACPI_NO_OBJECT_INIT)) {
274 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
275 "[Init] Completing Initialization of ACPI Objects\n"));
277 status = acpi_ns_initialize_objects();
278 if (ACPI_FAILURE(status)) {
279 return_ACPI_STATUS(status);
284 * Initialize all device objects in the namespace. This runs the device
285 * _STA and _INI methods.
287 if (!(flags & ACPI_NO_DEVICE_INIT)) {
288 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
289 "[Init] Initializing ACPI Devices\n"));
291 status = acpi_ns_initialize_devices();
292 if (ACPI_FAILURE(status)) {
293 return_ACPI_STATUS(status);
298 * Empty the caches (delete the cached objects) on the assumption that
299 * the table load filled them up more than they will be at runtime --
300 * thus wasting non-paged memory.
302 status = acpi_purge_cached_objects();
304 acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
305 return_ACPI_STATUS(status);
308 /*******************************************************************************
310 * FUNCTION: acpi_terminate
316 * DESCRIPTION: Shutdown the ACPI subsystem. Release all resources.
318 ******************************************************************************/
320 acpi_status acpi_terminate(void)
324 ACPI_FUNCTION_TRACE("acpi_terminate");
326 /* Terminate the AML Debugger if present */
328 ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
330 /* Shutdown and free all resources */
332 acpi_ut_subsystem_shutdown();
334 /* Free the mutex objects */
336 acpi_ut_mutex_terminate();
340 /* Shut down the debugger */
345 /* Now we can shutdown the OS-dependent layer */
347 status = acpi_os_terminate();
348 return_ACPI_STATUS(status);
351 #ifdef ACPI_FUTURE_USAGE
352 /*******************************************************************************
354 * FUNCTION: acpi_subsystem_status
358 * RETURN: Status of the ACPI subsystem
360 * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
361 * before making any other calls, to ensure the subsystem
362 * initialized successfully.
364 ******************************************************************************/
366 acpi_status acpi_subsystem_status(void)
369 if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
376 /*******************************************************************************
378 * FUNCTION: acpi_get_system_info
380 * PARAMETERS: out_buffer - A buffer to receive the resources for the
383 * RETURN: Status - the status of the call
385 * DESCRIPTION: This function is called to get information about the current
386 * state of the ACPI subsystem. It will return system information
389 * If the function fails an appropriate status will be returned
390 * and the value of out_buffer is undefined.
392 ******************************************************************************/
394 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
396 struct acpi_system_info *info_ptr;
400 ACPI_FUNCTION_TRACE("acpi_get_system_info");
402 /* Parameter validation */
404 status = acpi_ut_validate_buffer(out_buffer);
405 if (ACPI_FAILURE(status)) {
406 return_ACPI_STATUS(status);
409 /* Validate/Allocate/Clear caller buffer */
412 acpi_ut_initialize_buffer(out_buffer,
413 sizeof(struct acpi_system_info));
414 if (ACPI_FAILURE(status)) {
415 return_ACPI_STATUS(status);
419 * Populate the return buffer
421 info_ptr = (struct acpi_system_info *)out_buffer->pointer;
423 info_ptr->acpi_ca_version = ACPI_CA_VERSION;
425 /* System flags (ACPI capabilities) */
427 info_ptr->flags = ACPI_SYS_MODE_ACPI;
429 /* Timer resolution - 24 or 32 bits */
431 if (!acpi_gbl_FADT) {
432 info_ptr->timer_resolution = 0;
433 } else if (acpi_gbl_FADT->tmr_val_ext == 0) {
434 info_ptr->timer_resolution = 24;
436 info_ptr->timer_resolution = 32;
439 /* Clear the reserved fields */
441 info_ptr->reserved1 = 0;
442 info_ptr->reserved2 = 0;
444 /* Current debug levels */
446 info_ptr->debug_layer = acpi_dbg_layer;
447 info_ptr->debug_level = acpi_dbg_level;
449 /* Current status of the ACPI tables, per table type */
451 info_ptr->num_table_types = NUM_ACPI_TABLE_TYPES;
452 for (i = 0; i < NUM_ACPI_TABLE_TYPES; i++) {
453 info_ptr->table_info[i].count = acpi_gbl_table_lists[i].count;
456 return_ACPI_STATUS(AE_OK);
459 EXPORT_SYMBOL(acpi_get_system_info);
461 /*****************************************************************************
463 * FUNCTION: acpi_install_initialization_handler
465 * PARAMETERS: Handler - Callback procedure
466 * Function - Not (currently) used, see below
470 * DESCRIPTION: Install an initialization handler
472 * TBD: When a second function is added, must save the Function also.
474 ****************************************************************************/
477 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
481 return (AE_BAD_PARAMETER);
484 if (acpi_gbl_init_handler) {
485 return (AE_ALREADY_EXISTS);
488 acpi_gbl_init_handler = handler;
492 #endif /* ACPI_FUTURE_USAGE */
494 /*****************************************************************************
496 * FUNCTION: acpi_purge_cached_objects
502 * DESCRIPTION: Empty all caches (delete the cached objects)
504 ****************************************************************************/
506 acpi_status acpi_purge_cached_objects(void)
508 ACPI_FUNCTION_TRACE("acpi_purge_cached_objects");
510 (void)acpi_os_purge_cache(acpi_gbl_state_cache);
511 (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
512 (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
513 (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
514 return_ACPI_STATUS(AE_OK);