[ACPI] ACPICA 20051117
[linux-2.6] / drivers / acpi / utilities / utxface.c
1 /******************************************************************************
2  *
3  * Module Name: utxface - External interfaces for "global" ACPI functions
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2005, R. Byron Moore
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43
44 #include <linux/module.h>
45
46 #include <acpi/acpi.h>
47 #include <acpi/acevents.h>
48 #include <acpi/acnamesp.h>
49 #include <acpi/acdebug.h>
50
51 #define _COMPONENT          ACPI_UTILITIES
52 ACPI_MODULE_NAME("utxface")
53
54 /*******************************************************************************
55  *
56  * FUNCTION:    acpi_initialize_subsystem
57  *
58  * PARAMETERS:  None
59  *
60  * RETURN:      Status
61  *
62  * DESCRIPTION: Initializes all global variables.  This is the first function
63  *              called, so any early initialization belongs here.
64  *
65  ******************************************************************************/
66 acpi_status acpi_initialize_subsystem(void)
67 {
68         acpi_status status;
69
70         ACPI_FUNCTION_TRACE("acpi_initialize_subsystem");
71
72         ACPI_DEBUG_EXEC(acpi_ut_init_stack_ptr_trace());
73
74         /* Initialize the OS-Dependent layer */
75
76         status = acpi_os_initialize();
77         if (ACPI_FAILURE(status)) {
78                 ACPI_REPORT_ERROR(("OSD failed to initialize, %s\n",
79                                    acpi_format_exception(status)));
80                 return_ACPI_STATUS(status);
81         }
82
83         /* Initialize all globals used by the subsystem */
84
85         acpi_ut_init_globals();
86
87         /* Create the default mutex objects */
88
89         status = acpi_ut_mutex_initialize();
90         if (ACPI_FAILURE(status)) {
91                 ACPI_REPORT_ERROR(("Global mutex creation failure, %s\n",
92                                    acpi_format_exception(status)));
93                 return_ACPI_STATUS(status);
94         }
95
96         /*
97          * Initialize the namespace manager and
98          * the root of the namespace tree
99          */
100         status = acpi_ns_root_initialize();
101         if (ACPI_FAILURE(status)) {
102                 ACPI_REPORT_ERROR(("Namespace initialization failure, %s\n",
103                                    acpi_format_exception(status)));
104                 return_ACPI_STATUS(status);
105         }
106
107         /* If configured, initialize the AML debugger */
108
109         ACPI_DEBUGGER_EXEC(status = acpi_db_initialize());
110
111         return_ACPI_STATUS(status);
112 }
113
114 /*******************************************************************************
115  *
116  * FUNCTION:    acpi_enable_subsystem
117  *
118  * PARAMETERS:  Flags           - Init/enable Options
119  *
120  * RETURN:      Status
121  *
122  * DESCRIPTION: Completes the subsystem initialization including hardware.
123  *              Puts system into ACPI mode if it isn't already.
124  *
125  ******************************************************************************/
126
127 acpi_status acpi_enable_subsystem(u32 flags)
128 {
129         acpi_status status = AE_OK;
130
131         ACPI_FUNCTION_TRACE("acpi_enable_subsystem");
132
133         /*
134          * We must initialize the hardware before we can enable ACPI.
135          * The values from the FADT are validated here.
136          */
137         if (!(flags & ACPI_NO_HARDWARE_INIT)) {
138                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
139                                   "[Init] Initializing ACPI hardware\n"));
140
141                 status = acpi_hw_initialize();
142                 if (ACPI_FAILURE(status)) {
143                         return_ACPI_STATUS(status);
144                 }
145         }
146
147         /* Enable ACPI mode */
148
149         if (!(flags & ACPI_NO_ACPI_ENABLE)) {
150                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
151                                   "[Init] Going into ACPI mode\n"));
152
153                 acpi_gbl_original_mode = acpi_hw_get_mode();
154
155                 status = acpi_enable();
156                 if (ACPI_FAILURE(status)) {
157                         ACPI_DEBUG_PRINT((ACPI_DB_WARN,
158                                           "acpi_enable failed.\n"));
159                         return_ACPI_STATUS(status);
160                 }
161         }
162
163         /*
164          * Install the default op_region handlers. These are installed unless
165          * other handlers have already been installed via the
166          * install_address_space_handler interface.
167          */
168         if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
169                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
170                                   "[Init] Installing default address space handlers\n"));
171
172                 status = acpi_ev_install_region_handlers();
173                 if (ACPI_FAILURE(status)) {
174                         return_ACPI_STATUS(status);
175                 }
176         }
177
178         /*
179          * Initialize ACPI Event handling (Fixed and General Purpose)
180          *
181          * Note1: We must have the hardware and events initialized before we can
182          * execute any control methods safely. Any control method can require
183          * ACPI hardware support, so the hardware must be fully initialized before
184          * any method execution!
185          *
186          * Note2: Fixed events are initialized and enabled here. GPEs are
187          * initialized, but cannot be enabled until after the hardware is
188          * completely initialized (SCI and global_lock activated)
189          */
190         if (!(flags & ACPI_NO_EVENT_INIT)) {
191                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
192                                   "[Init] Initializing ACPI events\n"));
193
194                 status = acpi_ev_initialize_events();
195                 if (ACPI_FAILURE(status)) {
196                         return_ACPI_STATUS(status);
197                 }
198         }
199
200         /*
201          * Install the SCI handler and Global Lock handler. This completes the
202          * hardware initialization.
203          */
204         if (!(flags & ACPI_NO_HANDLER_INIT)) {
205                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
206                                   "[Init] Installing SCI/GL handlers\n"));
207
208                 status = acpi_ev_install_xrupt_handlers();
209                 if (ACPI_FAILURE(status)) {
210                         return_ACPI_STATUS(status);
211                 }
212         }
213
214         /*
215          * Complete the GPE initialization for the GPE blocks defined in the FADT
216          * (GPE block 0 and 1).
217          *
218          * Note1: This is where the _PRW methods are executed for the GPEs. These
219          * methods can only be executed after the SCI and Global Lock handlers are
220          * installed and initialized.
221          *
222          * Note2: Currently, there seems to be no need to run the _REG methods
223          * before execution of the _PRW methods and enabling of the GPEs.
224          */
225         if (!(flags & ACPI_NO_EVENT_INIT)) {
226                 status = acpi_ev_install_fadt_gpes();
227                 if (ACPI_FAILURE(status)) {
228                         return (status);
229                 }
230         }
231
232         return_ACPI_STATUS(status);
233 }
234
235 /*******************************************************************************
236  *
237  * FUNCTION:    acpi_initialize_objects
238  *
239  * PARAMETERS:  Flags           - Init/enable Options
240  *
241  * RETURN:      Status
242  *
243  * DESCRIPTION: Completes namespace initialization by initializing device
244  *              objects and executing AML code for Regions, buffers, etc.
245  *
246  ******************************************************************************/
247
248 acpi_status acpi_initialize_objects(u32 flags)
249 {
250         acpi_status status = AE_OK;
251
252         ACPI_FUNCTION_TRACE("acpi_initialize_objects");
253
254         /*
255          * Run all _REG methods
256          *
257          * Note: Any objects accessed by the _REG methods will be automatically
258          * initialized, even if they contain executable AML (see the call to
259          * acpi_ns_initialize_objects below).
260          */
261         if (!(flags & ACPI_NO_ADDRESS_SPACE_INIT)) {
262                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
263                                   "[Init] Executing _REG op_region methods\n"));
264
265                 status = acpi_ev_initialize_op_regions();
266                 if (ACPI_FAILURE(status)) {
267                         return_ACPI_STATUS(status);
268                 }
269         }
270
271         /*
272          * Initialize the objects that remain uninitialized. This runs the
273          * executable AML that may be part of the declaration of these objects:
274          * operation_regions, buffer_fields, Buffers, and Packages.
275          */
276         if (!(flags & ACPI_NO_OBJECT_INIT)) {
277                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
278                                   "[Init] Completing Initialization of ACPI Objects\n"));
279
280                 status = acpi_ns_initialize_objects();
281                 if (ACPI_FAILURE(status)) {
282                         return_ACPI_STATUS(status);
283                 }
284         }
285
286         /*
287          * Initialize all device objects in the namespace. This runs the device
288          * _STA and _INI methods.
289          */
290         if (!(flags & ACPI_NO_DEVICE_INIT)) {
291                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
292                                   "[Init] Initializing ACPI Devices\n"));
293
294                 status = acpi_ns_initialize_devices();
295                 if (ACPI_FAILURE(status)) {
296                         return_ACPI_STATUS(status);
297                 }
298         }
299
300         /*
301          * Empty the caches (delete the cached objects) on the assumption that
302          * the table load filled them up more than they will be at runtime --
303          * thus wasting non-paged memory.
304          */
305         status = acpi_purge_cached_objects();
306
307         acpi_gbl_startup_flags |= ACPI_INITIALIZED_OK;
308         return_ACPI_STATUS(status);
309 }
310
311 /*******************************************************************************
312  *
313  * FUNCTION:    acpi_terminate
314  *
315  * PARAMETERS:  None
316  *
317  * RETURN:      Status
318  *
319  * DESCRIPTION: Shutdown the ACPI subsystem.  Release all resources.
320  *
321  ******************************************************************************/
322
323 acpi_status acpi_terminate(void)
324 {
325         acpi_status status;
326
327         ACPI_FUNCTION_TRACE("acpi_terminate");
328
329         /* Terminate the AML Debugger if present */
330
331         ACPI_DEBUGGER_EXEC(acpi_gbl_db_terminate_threads = TRUE);
332
333         /* Shutdown and free all resources */
334
335         acpi_ut_subsystem_shutdown();
336
337         /* Free the mutex objects */
338
339         acpi_ut_mutex_terminate();
340
341 #ifdef ACPI_DEBUGGER
342
343         /* Shut down the debugger */
344
345         acpi_db_terminate();
346 #endif
347
348         /* Now we can shutdown the OS-dependent layer */
349
350         status = acpi_os_terminate();
351         return_ACPI_STATUS(status);
352 }
353
354 #ifdef ACPI_FUTURE_USAGE
355 /*******************************************************************************
356  *
357  * FUNCTION:    acpi_subsystem_status
358  *
359  * PARAMETERS:  None
360  *
361  * RETURN:      Status of the ACPI subsystem
362  *
363  * DESCRIPTION: Other drivers that use the ACPI subsystem should call this
364  *              before making any other calls, to ensure the subsystem
365  *              initialized successfully.
366  *
367  ******************************************************************************/
368
369 acpi_status acpi_subsystem_status(void)
370 {
371
372         if (acpi_gbl_startup_flags & ACPI_INITIALIZED_OK) {
373                 return (AE_OK);
374         } else {
375                 return (AE_ERROR);
376         }
377 }
378
379 /*******************************************************************************
380  *
381  * FUNCTION:    acpi_get_system_info
382  *
383  * PARAMETERS:  out_buffer      - A buffer to receive the resources for the
384  *                                device
385  *
386  * RETURN:      Status          - the status of the call
387  *
388  * DESCRIPTION: This function is called to get information about the current
389  *              state of the ACPI subsystem.  It will return system information
390  *              in the out_buffer.
391  *
392  *              If the function fails an appropriate status will be returned
393  *              and the value of out_buffer is undefined.
394  *
395  ******************************************************************************/
396
397 acpi_status acpi_get_system_info(struct acpi_buffer * out_buffer)
398 {
399         struct acpi_system_info *info_ptr;
400         acpi_status status;
401         u32 i;
402
403         ACPI_FUNCTION_TRACE("acpi_get_system_info");
404
405         /* Parameter validation */
406
407         status = acpi_ut_validate_buffer(out_buffer);
408         if (ACPI_FAILURE(status)) {
409                 return_ACPI_STATUS(status);
410         }
411
412         /* Validate/Allocate/Clear caller buffer */
413
414         status =
415             acpi_ut_initialize_buffer(out_buffer,
416                                       sizeof(struct acpi_system_info));
417         if (ACPI_FAILURE(status)) {
418                 return_ACPI_STATUS(status);
419         }
420
421         /*
422          * Populate the return buffer
423          */
424         info_ptr = (struct acpi_system_info *)out_buffer->pointer;
425
426         info_ptr->acpi_ca_version = ACPI_CA_VERSION;
427
428         /* System flags (ACPI capabilities) */
429
430         info_ptr->flags = ACPI_SYS_MODE_ACPI;
431
432         /* Timer resolution - 24 or 32 bits  */
433
434         if (!acpi_gbl_FADT) {
435                 info_ptr->timer_resolution = 0;
436         } else if (acpi_gbl_FADT->tmr_val_ext == 0) {
437                 info_ptr->timer_resolution = 24;
438         } else {
439                 info_ptr->timer_resolution = 32;
440         }
441
442         /* Clear the reserved fields */
443
444         info_ptr->reserved1 = 0;
445         info_ptr->reserved2 = 0;
446
447         /* Current debug levels */
448
449         info_ptr->debug_layer = acpi_dbg_layer;
450         info_ptr->debug_level = acpi_dbg_level;
451
452         /* Current status of the ACPI tables, per table type */
453
454         info_ptr->num_table_types = NUM_ACPI_TABLE_TYPES;
455         for (i = 0; i < NUM_ACPI_TABLE_TYPES; i++) {
456                 info_ptr->table_info[i].count = acpi_gbl_table_lists[i].count;
457         }
458
459         return_ACPI_STATUS(AE_OK);
460 }
461
462 EXPORT_SYMBOL(acpi_get_system_info);
463
464 /*****************************************************************************
465  *
466  * FUNCTION:    acpi_install_initialization_handler
467  *
468  * PARAMETERS:  Handler             - Callback procedure
469  *              Function            - Not (currently) used, see below
470  *
471  * RETURN:      Status
472  *
473  * DESCRIPTION: Install an initialization handler
474  *
475  * TBD: When a second function is added, must save the Function also.
476  *
477  ****************************************************************************/
478
479 acpi_status
480 acpi_install_initialization_handler(acpi_init_handler handler, u32 function)
481 {
482
483         if (!handler) {
484                 return (AE_BAD_PARAMETER);
485         }
486
487         if (acpi_gbl_init_handler) {
488                 return (AE_ALREADY_EXISTS);
489         }
490
491         acpi_gbl_init_handler = handler;
492         return AE_OK;
493 }
494
495 #endif                          /*  ACPI_FUTURE_USAGE  */
496
497 /*****************************************************************************
498  *
499  * FUNCTION:    acpi_purge_cached_objects
500  *
501  * PARAMETERS:  None
502  *
503  * RETURN:      Status
504  *
505  * DESCRIPTION: Empty all caches (delete the cached objects)
506  *
507  ****************************************************************************/
508
509 acpi_status acpi_purge_cached_objects(void)
510 {
511         ACPI_FUNCTION_TRACE("acpi_purge_cached_objects");
512
513         (void)acpi_os_purge_cache(acpi_gbl_state_cache);
514         (void)acpi_os_purge_cache(acpi_gbl_operand_cache);
515         (void)acpi_os_purge_cache(acpi_gbl_ps_node_cache);
516         (void)acpi_os_purge_cache(acpi_gbl_ps_node_ext_cache);
517         return_ACPI_STATUS(AE_OK);
518 }