usb: fix a typo in a comment
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / acpi / acpica / hwsleep.c
blob2ac28bbe8827822f975755b3b7dd7cabab0882a3
2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
8 /*
9 * Copyright (C) 2000 - 2011, 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 "accommon.h"
47 #include "actables.h"
48 #include <linux/tboot.h>
50 #define _COMPONENT ACPI_HARDWARE
51 ACPI_MODULE_NAME("hwsleep")
53 /*******************************************************************************
55 * FUNCTION: acpi_set_firmware_waking_vector
57 * PARAMETERS: physical_address - 32-bit physical address of ACPI real mode
58 * entry point.
60 * RETURN: Status
62 * DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
64 ******************************************************************************/
65 acpi_status
66 acpi_set_firmware_waking_vector(u32 physical_address)
68 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
72 * According to the ACPI specification 2.0c and later, the 64-bit
73 * waking vector should be cleared and the 32-bit waking vector should
74 * be used, unless we want the wake-up code to be called by the BIOS in
75 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
76 * to fail to resume if the 64-bit vector is used.
79 /* Set the 32-bit vector */
81 acpi_gbl_FACS->firmware_waking_vector = physical_address;
83 /* Clear the 64-bit vector if it exists */
85 if ((acpi_gbl_FACS->length > 32) && (acpi_gbl_FACS->version >= 1)) {
86 acpi_gbl_FACS->xfirmware_waking_vector = 0;
89 return_ACPI_STATUS(AE_OK);
92 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
94 #if ACPI_MACHINE_WIDTH == 64
95 /*******************************************************************************
97 * FUNCTION: acpi_set_firmware_waking_vector64
99 * PARAMETERS: physical_address - 64-bit physical address of ACPI protected
100 * mode entry point.
102 * RETURN: Status
104 * DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
105 * it exists in the table. This function is intended for use with
106 * 64-bit host operating systems.
108 ******************************************************************************/
109 acpi_status
110 acpi_set_firmware_waking_vector64(u64 physical_address)
112 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);
115 /* Determine if the 64-bit vector actually exists */
117 if ((acpi_gbl_FACS->length <= 32) || (acpi_gbl_FACS->version < 1)) {
118 return_ACPI_STATUS(AE_NOT_EXIST);
121 /* Clear 32-bit vector, set the 64-bit X_ vector */
123 acpi_gbl_FACS->firmware_waking_vector = 0;
124 acpi_gbl_FACS->xfirmware_waking_vector = physical_address;
126 return_ACPI_STATUS(AE_OK);
129 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
130 #endif
132 /*******************************************************************************
134 * FUNCTION: acpi_enter_sleep_state_prep
136 * PARAMETERS: sleep_state - Which sleep state to enter
138 * RETURN: Status
140 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
141 * This function must execute with interrupts enabled.
142 * We break sleeping into 2 stages so that OSPM can handle
143 * various OS-specific tasks between the two steps.
145 ******************************************************************************/
146 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
148 acpi_status status;
149 struct acpi_object_list arg_list;
150 union acpi_object arg;
152 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
154 /* _PSW methods could be run here to enable wake-on keyboard, LAN, etc. */
156 status = acpi_get_sleep_type_data(sleep_state,
157 &acpi_gbl_sleep_type_a,
158 &acpi_gbl_sleep_type_b);
159 if (ACPI_FAILURE(status)) {
160 return_ACPI_STATUS(status);
163 /* Setup parameter object */
165 arg_list.count = 1;
166 arg_list.pointer = &arg;
168 arg.type = ACPI_TYPE_INTEGER;
169 arg.integer.value = sleep_state;
171 /* Run the _PTS method */
173 status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
174 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
175 return_ACPI_STATUS(status);
178 /* Setup the argument to _SST */
180 switch (sleep_state) {
181 case ACPI_STATE_S0:
182 arg.integer.value = ACPI_SST_WORKING;
183 break;
185 case ACPI_STATE_S1:
186 case ACPI_STATE_S2:
187 case ACPI_STATE_S3:
188 arg.integer.value = ACPI_SST_SLEEPING;
189 break;
191 case ACPI_STATE_S4:
192 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
193 break;
195 default:
196 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
197 break;
201 * Set the system indicators to show the desired sleep state.
202 * _SST is an optional method (return no error if not found)
204 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
205 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
206 ACPI_EXCEPTION((AE_INFO, status,
207 "While executing method _SST"));
210 return_ACPI_STATUS(AE_OK);
213 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
215 static unsigned int gts, bfs;
216 module_param(gts, uint, 0644);
217 module_param(bfs, uint, 0644);
218 MODULE_PARM_DESC(gts, "Enable evaluation of _GTS on suspend.");
219 MODULE_PARM_DESC(bfs, "Enable evaluation of _BFS on resume".);
221 /*******************************************************************************
223 * FUNCTION: acpi_enter_sleep_state
225 * PARAMETERS: sleep_state - Which sleep state to enter
227 * RETURN: Status
229 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
230 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
232 ******************************************************************************/
233 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
235 u32 pm1a_control;
236 u32 pm1b_control;
237 struct acpi_bit_register_info *sleep_type_reg_info;
238 struct acpi_bit_register_info *sleep_enable_reg_info;
239 u32 in_value;
240 struct acpi_object_list arg_list;
241 union acpi_object arg;
242 acpi_status status;
244 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
246 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
247 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
248 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
249 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
250 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
253 sleep_type_reg_info =
254 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
255 sleep_enable_reg_info =
256 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
258 /* Clear wake status */
260 status =
261 acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
262 if (ACPI_FAILURE(status)) {
263 return_ACPI_STATUS(status);
266 /* Clear all fixed and general purpose status bits */
268 status = acpi_hw_clear_acpi_status();
269 if (ACPI_FAILURE(status)) {
270 return_ACPI_STATUS(status);
274 * 1) Disable/Clear all GPEs
275 * 2) Enable all wakeup GPEs
277 status = acpi_hw_disable_all_gpes();
278 if (ACPI_FAILURE(status)) {
279 return_ACPI_STATUS(status);
281 acpi_gbl_system_awake_and_running = FALSE;
283 status = acpi_hw_enable_all_wakeup_gpes();
284 if (ACPI_FAILURE(status)) {
285 return_ACPI_STATUS(status);
288 if (gts) {
289 /* Execute the _GTS method */
291 arg_list.count = 1;
292 arg_list.pointer = &arg;
293 arg.type = ACPI_TYPE_INTEGER;
294 arg.integer.value = sleep_state;
296 status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
297 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
298 return_ACPI_STATUS(status);
302 /* Get current value of PM1A control */
304 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
305 &pm1a_control);
306 if (ACPI_FAILURE(status)) {
307 return_ACPI_STATUS(status);
309 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
310 "Entering sleep state [S%u]\n", sleep_state));
312 /* Clear the SLP_EN and SLP_TYP fields */
314 pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
315 sleep_enable_reg_info->access_bit_mask);
316 pm1b_control = pm1a_control;
318 /* Insert the SLP_TYP bits */
320 pm1a_control |=
321 (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
322 pm1b_control |=
323 (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
326 * We split the writes of SLP_TYP and SLP_EN to workaround
327 * poorly implemented hardware.
330 /* Write #1: write the SLP_TYP data to the PM1 Control registers */
332 status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
333 if (ACPI_FAILURE(status)) {
334 return_ACPI_STATUS(status);
337 /* Insert the sleep enable (SLP_EN) bit */
339 pm1a_control |= sleep_enable_reg_info->access_bit_mask;
340 pm1b_control |= sleep_enable_reg_info->access_bit_mask;
342 /* Flush caches, as per ACPI specification */
344 ACPI_FLUSH_CPU_CACHE();
346 tboot_sleep(sleep_state, pm1a_control, pm1b_control);
348 /* Write #2: Write both SLP_TYP + SLP_EN */
350 status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
351 if (ACPI_FAILURE(status)) {
352 return_ACPI_STATUS(status);
355 if (sleep_state > ACPI_STATE_S3) {
357 * We wanted to sleep > S3, but it didn't happen (by virtue of the
358 * fact that we are still executing!)
360 * Wait ten seconds, then try again. This is to get S4/S5 to work on
361 * all machines.
363 * We wait so long to allow chipsets that poll this reg very slowly
364 * to still read the right value. Ideally, this block would go
365 * away entirely.
367 acpi_os_stall(10000000);
369 status = acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL,
370 sleep_enable_reg_info->
371 access_bit_mask);
372 if (ACPI_FAILURE(status)) {
373 return_ACPI_STATUS(status);
377 /* Wait until we enter sleep state */
379 do {
380 status = acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS,
381 &in_value);
382 if (ACPI_FAILURE(status)) {
383 return_ACPI_STATUS(status);
386 /* Spin until we wake */
388 } while (!in_value);
390 return_ACPI_STATUS(AE_OK);
393 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
395 /*******************************************************************************
397 * FUNCTION: acpi_enter_sleep_state_s4bios
399 * PARAMETERS: None
401 * RETURN: Status
403 * DESCRIPTION: Perform a S4 bios request.
404 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
406 ******************************************************************************/
407 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
409 u32 in_value;
410 acpi_status status;
412 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
414 /* Clear the wake status bit (PM1) */
416 status =
417 acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
418 if (ACPI_FAILURE(status)) {
419 return_ACPI_STATUS(status);
422 status = acpi_hw_clear_acpi_status();
423 if (ACPI_FAILURE(status)) {
424 return_ACPI_STATUS(status);
428 * 1) Disable/Clear all GPEs
429 * 2) Enable all wakeup GPEs
431 status = acpi_hw_disable_all_gpes();
432 if (ACPI_FAILURE(status)) {
433 return_ACPI_STATUS(status);
435 acpi_gbl_system_awake_and_running = FALSE;
437 status = acpi_hw_enable_all_wakeup_gpes();
438 if (ACPI_FAILURE(status)) {
439 return_ACPI_STATUS(status);
442 ACPI_FLUSH_CPU_CACHE();
444 status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
445 (u32) acpi_gbl_FADT.S4bios_request, 8);
447 do {
448 acpi_os_stall(1000);
449 status =
450 acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
451 if (ACPI_FAILURE(status)) {
452 return_ACPI_STATUS(status);
454 } while (!in_value);
456 return_ACPI_STATUS(AE_OK);
459 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
461 /*******************************************************************************
463 * FUNCTION: acpi_leave_sleep_state_prep
465 * PARAMETERS: sleep_state - Which sleep state we are exiting
467 * RETURN: Status
469 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
470 * sleep.
471 * Called with interrupts DISABLED.
473 ******************************************************************************/
474 acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
476 struct acpi_object_list arg_list;
477 union acpi_object arg;
478 acpi_status status;
479 struct acpi_bit_register_info *sleep_type_reg_info;
480 struct acpi_bit_register_info *sleep_enable_reg_info;
481 u32 pm1a_control;
482 u32 pm1b_control;
484 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
487 * Set SLP_TYPE and SLP_EN to state S0.
488 * This is unclear from the ACPI Spec, but it is required
489 * by some machines.
491 status = acpi_get_sleep_type_data(ACPI_STATE_S0,
492 &acpi_gbl_sleep_type_a,
493 &acpi_gbl_sleep_type_b);
494 if (ACPI_SUCCESS(status)) {
495 sleep_type_reg_info =
496 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
497 sleep_enable_reg_info =
498 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
500 /* Get current value of PM1A control */
502 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
503 &pm1a_control);
504 if (ACPI_SUCCESS(status)) {
506 /* Clear the SLP_EN and SLP_TYP fields */
508 pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
509 sleep_enable_reg_info->
510 access_bit_mask);
511 pm1b_control = pm1a_control;
513 /* Insert the SLP_TYP bits */
515 pm1a_control |= (acpi_gbl_sleep_type_a <<
516 sleep_type_reg_info->bit_position);
517 pm1b_control |= (acpi_gbl_sleep_type_b <<
518 sleep_type_reg_info->bit_position);
520 /* Write the control registers and ignore any errors */
522 (void)acpi_hw_write_pm1_control(pm1a_control,
523 pm1b_control);
527 if (bfs) {
528 /* Execute the _BFS method */
530 arg_list.count = 1;
531 arg_list.pointer = &arg;
532 arg.type = ACPI_TYPE_INTEGER;
533 arg.integer.value = sleep_state;
535 status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
536 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
537 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
540 return_ACPI_STATUS(status);
543 /*******************************************************************************
545 * FUNCTION: acpi_leave_sleep_state
547 * PARAMETERS: sleep_state - Which sleep state we just exited
549 * RETURN: Status
551 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
552 * Called with interrupts ENABLED.
554 ******************************************************************************/
555 acpi_status acpi_leave_sleep_state(u8 sleep_state)
557 struct acpi_object_list arg_list;
558 union acpi_object arg;
559 acpi_status status;
561 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
563 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
565 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
567 /* Setup parameter object */
569 arg_list.count = 1;
570 arg_list.pointer = &arg;
571 arg.type = ACPI_TYPE_INTEGER;
573 /* Ignore any errors from these methods */
575 arg.integer.value = ACPI_SST_WAKING;
576 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
577 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
578 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
582 * GPEs must be enabled before _WAK is called as GPEs
583 * might get fired there
585 * Restore the GPEs:
586 * 1) Disable/Clear all GPEs
587 * 2) Enable all runtime GPEs
589 status = acpi_hw_disable_all_gpes();
590 if (ACPI_FAILURE(status)) {
591 return_ACPI_STATUS(status);
593 status = acpi_hw_enable_all_runtime_gpes();
594 if (ACPI_FAILURE(status)) {
595 return_ACPI_STATUS(status);
598 arg.integer.value = sleep_state;
599 status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
600 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
601 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
603 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
606 * Some BIOSes assume that WAK_STS will be cleared on resume and use
607 * it to determine whether the system is rebooting or resuming. Clear
608 * it for compatibility.
610 acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, 1);
612 acpi_gbl_system_awake_and_running = TRUE;
614 /* Enable power button */
616 (void)
617 acpi_write_bit_register(acpi_gbl_fixed_event_info
618 [ACPI_EVENT_POWER_BUTTON].
619 enable_register_id, ACPI_ENABLE_EVENT);
621 (void)
622 acpi_write_bit_register(acpi_gbl_fixed_event_info
623 [ACPI_EVENT_POWER_BUTTON].
624 status_register_id, ACPI_CLEAR_STATUS);
626 arg.integer.value = ACPI_SST_WORKING;
627 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
628 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
629 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
632 return_ACPI_STATUS(status);
635 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)