ACPICA: create acpica/ directory
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / acpi / acpica / hwsleep.c
blob54dd3ee0760c8ed05613c47e5ca534bd587331c6
2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
8 /*
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
31 * NO WARRANTY
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/accommon.h>
47 #include <acpi/actables.h>
49 #define _COMPONENT ACPI_HARDWARE
50 ACPI_MODULE_NAME("hwsleep")
52 /*******************************************************************************
54 * FUNCTION: acpi_set_firmware_waking_vector
56 * PARAMETERS: physical_address - 32-bit physical address of ACPI real mode
57 * entry point.
59 * RETURN: Status
61 * DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
63 ******************************************************************************/
64 acpi_status
65 acpi_set_firmware_waking_vector(u32 physical_address)
67 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
71 * According to the ACPI specification 2.0c and later, the 64-bit
72 * waking vector should be cleared and the 32-bit waking vector should
73 * be used, unless we want the wake-up code to be called by the BIOS in
74 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
75 * to fail to resume if the 64-bit vector is used.
78 /* Set the 32-bit vector */
80 acpi_gbl_FACS->firmware_waking_vector = physical_address;
82 /* Clear the 64-bit vector if it exists */
84 if ((acpi_gbl_FACS->length > 32) && (acpi_gbl_FACS->version >= 1)) {
85 acpi_gbl_FACS->xfirmware_waking_vector = 0;
88 return_ACPI_STATUS(AE_OK);
91 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
93 /*******************************************************************************
95 * FUNCTION: acpi_set_firmware_waking_vector64
97 * PARAMETERS: physical_address - 64-bit physical address of ACPI protected
98 * mode entry point.
100 * RETURN: Status
102 * DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
103 * it exists in the table.
105 ******************************************************************************/
106 acpi_status
107 acpi_set_firmware_waking_vector64(u64 physical_address)
109 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);
112 /* Determine if the 64-bit vector actually exists */
114 if ((acpi_gbl_FACS->length <= 32) || (acpi_gbl_FACS->version < 1)) {
115 return_ACPI_STATUS(AE_NOT_EXIST);
118 /* Clear 32-bit vector, set the 64-bit X_ vector */
120 acpi_gbl_FACS->firmware_waking_vector = 0;
121 acpi_gbl_FACS->xfirmware_waking_vector = physical_address;
123 return_ACPI_STATUS(AE_OK);
126 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
128 /*******************************************************************************
130 * FUNCTION: acpi_enter_sleep_state_prep
132 * PARAMETERS: sleep_state - Which sleep state to enter
134 * RETURN: Status
136 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
137 * This function must execute with interrupts enabled.
138 * We break sleeping into 2 stages so that OSPM can handle
139 * various OS-specific tasks between the two steps.
141 ******************************************************************************/
142 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
144 acpi_status status;
145 struct acpi_object_list arg_list;
146 union acpi_object arg;
148 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
151 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
153 status = acpi_get_sleep_type_data(sleep_state,
154 &acpi_gbl_sleep_type_a,
155 &acpi_gbl_sleep_type_b);
156 if (ACPI_FAILURE(status)) {
157 return_ACPI_STATUS(status);
160 /* Setup parameter object */
162 arg_list.count = 1;
163 arg_list.pointer = &arg;
165 arg.type = ACPI_TYPE_INTEGER;
166 arg.integer.value = sleep_state;
168 /* Run the _PTS method */
170 status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
171 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
172 return_ACPI_STATUS(status);
175 /* Setup the argument to _SST */
177 switch (sleep_state) {
178 case ACPI_STATE_S0:
179 arg.integer.value = ACPI_SST_WORKING;
180 break;
182 case ACPI_STATE_S1:
183 case ACPI_STATE_S2:
184 case ACPI_STATE_S3:
185 arg.integer.value = ACPI_SST_SLEEPING;
186 break;
188 case ACPI_STATE_S4:
189 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
190 break;
192 default:
193 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
194 break;
198 * Set the system indicators to show the desired sleep state.
199 * _SST is an optional method (return no error if not found)
201 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
202 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
203 ACPI_EXCEPTION((AE_INFO, status,
204 "While executing method _SST"));
207 return_ACPI_STATUS(AE_OK);
210 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
212 /*******************************************************************************
214 * FUNCTION: acpi_enter_sleep_state
216 * PARAMETERS: sleep_state - Which sleep state to enter
218 * RETURN: Status
220 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
221 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
223 ******************************************************************************/
224 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
226 u32 PM1Acontrol;
227 u32 PM1Bcontrol;
228 struct acpi_bit_register_info *sleep_type_reg_info;
229 struct acpi_bit_register_info *sleep_enable_reg_info;
230 u32 in_value;
231 struct acpi_object_list arg_list;
232 union acpi_object arg;
233 acpi_status status;
235 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
237 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
238 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
239 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
240 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
241 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
244 sleep_type_reg_info =
245 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
246 sleep_enable_reg_info =
247 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
249 /* Clear wake status */
251 status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
252 if (ACPI_FAILURE(status)) {
253 return_ACPI_STATUS(status);
256 /* Clear all fixed and general purpose status bits */
258 status = acpi_hw_clear_acpi_status();
259 if (ACPI_FAILURE(status)) {
260 return_ACPI_STATUS(status);
264 * 1) Disable/Clear all GPEs
265 * 2) Enable all wakeup GPEs
267 status = acpi_hw_disable_all_gpes();
268 if (ACPI_FAILURE(status)) {
269 return_ACPI_STATUS(status);
271 acpi_gbl_system_awake_and_running = FALSE;
273 status = acpi_hw_enable_all_wakeup_gpes();
274 if (ACPI_FAILURE(status)) {
275 return_ACPI_STATUS(status);
278 /* Execute the _GTS method */
280 arg_list.count = 1;
281 arg_list.pointer = &arg;
282 arg.type = ACPI_TYPE_INTEGER;
283 arg.integer.value = sleep_state;
285 status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
286 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
287 return_ACPI_STATUS(status);
290 /* Get current value of PM1A control */
292 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
293 if (ACPI_FAILURE(status)) {
294 return_ACPI_STATUS(status);
296 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
297 "Entering sleep state [S%d]\n", sleep_state));
299 /* Clear SLP_EN and SLP_TYP fields */
301 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
302 sleep_enable_reg_info->access_bit_mask);
303 PM1Bcontrol = PM1Acontrol;
305 /* Insert SLP_TYP bits */
307 PM1Acontrol |=
308 (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
309 PM1Bcontrol |=
310 (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
313 * We split the writes of SLP_TYP and SLP_EN to workaround
314 * poorly implemented hardware.
317 /* Write #1: fill in SLP_TYP data */
319 status = acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL,
320 PM1Acontrol);
321 if (ACPI_FAILURE(status)) {
322 return_ACPI_STATUS(status);
325 status = acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL,
326 PM1Bcontrol);
327 if (ACPI_FAILURE(status)) {
328 return_ACPI_STATUS(status);
331 /* Insert SLP_ENABLE bit */
333 PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
334 PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
336 /* Write #2: SLP_TYP + SLP_EN */
338 ACPI_FLUSH_CPU_CACHE();
340 status = acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL,
341 PM1Acontrol);
342 if (ACPI_FAILURE(status)) {
343 return_ACPI_STATUS(status);
346 status = acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL,
347 PM1Bcontrol);
348 if (ACPI_FAILURE(status)) {
349 return_ACPI_STATUS(status);
352 if (sleep_state > ACPI_STATE_S3) {
354 * We wanted to sleep > S3, but it didn't happen (by virtue of the
355 * fact that we are still executing!)
357 * Wait ten seconds, then try again. This is to get S4/S5 to work on
358 * all machines.
360 * We wait so long to allow chipsets that poll this reg very slowly to
361 * still read the right value. Ideally, this block would go
362 * away entirely.
364 acpi_os_stall(10000000);
366 status = acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL,
367 sleep_enable_reg_info->
368 access_bit_mask);
369 if (ACPI_FAILURE(status)) {
370 return_ACPI_STATUS(status);
374 /* Wait until we enter sleep state */
376 do {
377 status = acpi_get_register_unlocked(ACPI_BITREG_WAKE_STATUS,
378 &in_value);
379 if (ACPI_FAILURE(status)) {
380 return_ACPI_STATUS(status);
383 /* Spin until we wake */
385 } while (!in_value);
387 return_ACPI_STATUS(AE_OK);
390 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
392 /*******************************************************************************
394 * FUNCTION: acpi_enter_sleep_state_s4bios
396 * PARAMETERS: None
398 * RETURN: Status
400 * DESCRIPTION: Perform a S4 bios request.
401 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
403 ******************************************************************************/
404 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
406 u32 in_value;
407 acpi_status status;
409 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
411 status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
412 if (ACPI_FAILURE(status)) {
413 return_ACPI_STATUS(status);
416 status = acpi_hw_clear_acpi_status();
417 if (ACPI_FAILURE(status)) {
418 return_ACPI_STATUS(status);
422 * 1) Disable/Clear all GPEs
423 * 2) Enable all wakeup GPEs
425 status = acpi_hw_disable_all_gpes();
426 if (ACPI_FAILURE(status)) {
427 return_ACPI_STATUS(status);
429 acpi_gbl_system_awake_and_running = FALSE;
431 status = acpi_hw_enable_all_wakeup_gpes();
432 if (ACPI_FAILURE(status)) {
433 return_ACPI_STATUS(status);
436 ACPI_FLUSH_CPU_CACHE();
438 status = acpi_os_write_port(acpi_gbl_FADT.smi_command,
439 (u32) acpi_gbl_FADT.S4bios_request, 8);
441 do {
442 acpi_os_stall(1000);
443 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
444 if (ACPI_FAILURE(status)) {
445 return_ACPI_STATUS(status);
447 } while (!in_value);
449 return_ACPI_STATUS(AE_OK);
452 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
454 /*******************************************************************************
456 * FUNCTION: acpi_leave_sleep_state_prep
458 * PARAMETERS: sleep_state - Which sleep state we are exiting
460 * RETURN: Status
462 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
463 * sleep.
464 * Called with interrupts DISABLED.
466 ******************************************************************************/
467 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
469 struct acpi_object_list arg_list;
470 union acpi_object arg;
471 acpi_status status;
472 struct acpi_bit_register_info *sleep_type_reg_info;
473 struct acpi_bit_register_info *sleep_enable_reg_info;
474 u32 PM1Acontrol;
475 u32 PM1Bcontrol;
477 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
480 * Set SLP_TYPE and SLP_EN to state S0.
481 * This is unclear from the ACPI Spec, but it is required
482 * by some machines.
484 status = acpi_get_sleep_type_data(ACPI_STATE_S0,
485 &acpi_gbl_sleep_type_a,
486 &acpi_gbl_sleep_type_b);
487 if (ACPI_SUCCESS(status)) {
488 sleep_type_reg_info =
489 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
490 sleep_enable_reg_info =
491 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
493 /* Get current value of PM1A control */
495 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
496 &PM1Acontrol);
497 if (ACPI_SUCCESS(status)) {
499 /* Clear SLP_EN and SLP_TYP fields */
501 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
502 sleep_enable_reg_info->
503 access_bit_mask);
504 PM1Bcontrol = PM1Acontrol;
506 /* Insert SLP_TYP bits */
508 PM1Acontrol |=
509 (acpi_gbl_sleep_type_a << sleep_type_reg_info->
510 bit_position);
511 PM1Bcontrol |=
512 (acpi_gbl_sleep_type_b << sleep_type_reg_info->
513 bit_position);
515 /* Just ignore any errors */
517 (void)acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL,
518 PM1Acontrol);
519 (void)acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL,
520 PM1Bcontrol);
524 /* Execute the _BFS method */
526 arg_list.count = 1;
527 arg_list.pointer = &arg;
528 arg.type = ACPI_TYPE_INTEGER;
529 arg.integer.value = sleep_state;
531 status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
532 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
533 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
536 return_ACPI_STATUS(status);
539 /*******************************************************************************
541 * FUNCTION: acpi_leave_sleep_state
543 * PARAMETERS: sleep_state - Which sleep state we just exited
545 * RETURN: Status
547 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
548 * Called with interrupts ENABLED.
550 ******************************************************************************/
551 acpi_status acpi_leave_sleep_state(u8 sleep_state)
553 struct acpi_object_list arg_list;
554 union acpi_object arg;
555 acpi_status status;
557 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
559 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
561 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
563 /* Setup parameter object */
565 arg_list.count = 1;
566 arg_list.pointer = &arg;
567 arg.type = ACPI_TYPE_INTEGER;
569 /* Ignore any errors from these methods */
571 arg.integer.value = ACPI_SST_WAKING;
572 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
573 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
574 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
578 * GPEs must be enabled before _WAK is called as GPEs
579 * might get fired there
581 * Restore the GPEs:
582 * 1) Disable/Clear all GPEs
583 * 2) Enable all runtime GPEs
585 status = acpi_hw_disable_all_gpes();
586 if (ACPI_FAILURE(status)) {
587 return_ACPI_STATUS(status);
589 status = acpi_hw_enable_all_runtime_gpes();
590 if (ACPI_FAILURE(status)) {
591 return_ACPI_STATUS(status);
594 arg.integer.value = sleep_state;
595 status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
596 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
597 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
599 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
602 * Some BIOSes assume that WAK_STS will be cleared on resume and use
603 * it to determine whether the system is rebooting or resuming. Clear
604 * it for compatibility.
606 acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
608 acpi_gbl_system_awake_and_running = TRUE;
610 /* Enable power button */
612 (void)
613 acpi_set_register(acpi_gbl_fixed_event_info
614 [ACPI_EVENT_POWER_BUTTON].enable_register_id, 1);
616 (void)
617 acpi_set_register(acpi_gbl_fixed_event_info
618 [ACPI_EVENT_POWER_BUTTON].status_register_id, 1);
620 arg.integer.value = ACPI_SST_WORKING;
621 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
622 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
623 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
626 return_ACPI_STATUS(status);
629 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)