2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
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
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.
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/actables.h>
48 #define _COMPONENT ACPI_HARDWARE
49 ACPI_MODULE_NAME("hwsleep")
51 /*******************************************************************************
53 * FUNCTION: acpi_set_firmware_waking_vector
55 * PARAMETERS: physical_address - Physical address of ACPI real mode
60 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
62 ******************************************************************************/
64 acpi_set_firmware_waking_vector(acpi_physical_address physical_address
)
66 struct acpi_table_facs
*facs
;
69 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector
);
73 status
= acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
74 ACPI_CAST_INDIRECT_PTR(struct
77 if (ACPI_FAILURE(status
)) {
78 return_ACPI_STATUS(status
);
83 if ((facs
->length
< 32) || (!(facs
->xfirmware_waking_vector
))) {
85 * ACPI 1.0 FACS or short table or optional X_ field is zero
87 facs
->firmware_waking_vector
= (u32
) physical_address
;
90 * ACPI 2.0 FACS with valid X_ field
92 facs
->xfirmware_waking_vector
= physical_address
;
95 return_ACPI_STATUS(AE_OK
);
98 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector
)
100 /*******************************************************************************
102 * FUNCTION: acpi_get_firmware_waking_vector
104 * PARAMETERS: *physical_address - Where the contents of
105 * the firmware_waking_vector field of
106 * the FACS will be returned.
108 * RETURN: Status, vector
110 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
112 ******************************************************************************/
113 #ifdef ACPI_FUTURE_USAGE
115 acpi_get_firmware_waking_vector(acpi_physical_address
* physical_address
)
117 struct acpi_table_facs
*facs
;
120 ACPI_FUNCTION_TRACE(acpi_get_firmware_waking_vector
);
122 if (!physical_address
) {
123 return_ACPI_STATUS(AE_BAD_PARAMETER
);
128 status
= acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
129 ACPI_CAST_INDIRECT_PTR(struct
132 if (ACPI_FAILURE(status
)) {
133 return_ACPI_STATUS(status
);
138 if ((facs
->length
< 32) || (!(facs
->xfirmware_waking_vector
))) {
140 * ACPI 1.0 FACS or short table or optional X_ field is zero
143 (acpi_physical_address
) facs
->firmware_waking_vector
;
146 * ACPI 2.0 FACS with valid X_ field
149 (acpi_physical_address
) facs
->xfirmware_waking_vector
;
152 return_ACPI_STATUS(AE_OK
);
155 ACPI_EXPORT_SYMBOL(acpi_get_firmware_waking_vector
)
157 /*******************************************************************************
159 * FUNCTION: acpi_enter_sleep_state_prep
161 * PARAMETERS: sleep_state - Which sleep state to enter
165 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
166 * This function must execute with interrupts enabled.
167 * We break sleeping into 2 stages so that OSPM can handle
168 * various OS-specific tasks between the two steps.
170 ******************************************************************************/
171 acpi_status
acpi_enter_sleep_state_prep(u8 sleep_state
)
174 struct acpi_object_list arg_list
;
175 union acpi_object arg
;
177 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep
);
180 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
182 status
= acpi_get_sleep_type_data(sleep_state
,
183 &acpi_gbl_sleep_type_a
,
184 &acpi_gbl_sleep_type_b
);
185 if (ACPI_FAILURE(status
)) {
186 return_ACPI_STATUS(status
);
189 /* Setup parameter object */
192 arg_list
.pointer
= &arg
;
194 arg
.type
= ACPI_TYPE_INTEGER
;
195 arg
.integer
.value
= sleep_state
;
197 /* Run the _PTS method */
199 status
= acpi_evaluate_object(NULL
, METHOD_NAME__PTS
, &arg_list
, NULL
);
200 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
201 return_ACPI_STATUS(status
);
204 /* Setup the argument to _SST */
206 switch (sleep_state
) {
208 arg
.integer
.value
= ACPI_SST_WORKING
;
214 arg
.integer
.value
= ACPI_SST_SLEEPING
;
218 arg
.integer
.value
= ACPI_SST_SLEEP_CONTEXT
;
222 arg
.integer
.value
= ACPI_SST_INDICATOR_OFF
; /* Default is off */
226 /* Set the system indicators to show the desired sleep state. */
228 status
= acpi_evaluate_object(NULL
, METHOD_NAME__SST
, &arg_list
, NULL
);
229 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
230 ACPI_EXCEPTION((AE_INFO
, status
,
231 "While executing method _SST"));
234 return_ACPI_STATUS(status
);
237 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep
)
239 /*******************************************************************************
241 * FUNCTION: acpi_enter_sleep_state
243 * PARAMETERS: sleep_state - Which sleep state to enter
247 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
248 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
250 ******************************************************************************/
251 acpi_status asmlinkage
acpi_enter_sleep_state(u8 sleep_state
)
255 struct acpi_bit_register_info
*sleep_type_reg_info
;
256 struct acpi_bit_register_info
*sleep_enable_reg_info
;
258 struct acpi_object_list arg_list
;
259 union acpi_object arg
;
262 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state
);
264 if ((acpi_gbl_sleep_type_a
> ACPI_SLEEP_TYPE_MAX
) ||
265 (acpi_gbl_sleep_type_b
> ACPI_SLEEP_TYPE_MAX
)) {
266 ACPI_ERROR((AE_INFO
, "Sleep values out of range: A=%X B=%X",
267 acpi_gbl_sleep_type_a
, acpi_gbl_sleep_type_b
));
268 return_ACPI_STATUS(AE_AML_OPERAND_VALUE
);
271 sleep_type_reg_info
=
272 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A
);
273 sleep_enable_reg_info
=
274 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE
);
276 /* Clear wake status */
278 status
= acpi_set_register(ACPI_BITREG_WAKE_STATUS
, 1);
279 if (ACPI_FAILURE(status
)) {
280 return_ACPI_STATUS(status
);
283 /* Clear all fixed and general purpose status bits */
285 status
= acpi_hw_clear_acpi_status();
286 if (ACPI_FAILURE(status
)) {
287 return_ACPI_STATUS(status
);
291 * 1) Disable/Clear all GPEs
292 * 2) Enable all wakeup GPEs
294 status
= acpi_hw_disable_all_gpes();
295 if (ACPI_FAILURE(status
)) {
296 return_ACPI_STATUS(status
);
298 acpi_gbl_system_awake_and_running
= FALSE
;
300 status
= acpi_hw_enable_all_wakeup_gpes();
301 if (ACPI_FAILURE(status
)) {
302 return_ACPI_STATUS(status
);
305 /* Execute the _GTS method */
308 arg_list
.pointer
= &arg
;
309 arg
.type
= ACPI_TYPE_INTEGER
;
310 arg
.integer
.value
= sleep_state
;
312 status
= acpi_evaluate_object(NULL
, METHOD_NAME__GTS
, &arg_list
, NULL
);
313 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
314 return_ACPI_STATUS(status
);
317 /* Get current value of PM1A control */
319 status
= acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL
, &PM1Acontrol
);
320 if (ACPI_FAILURE(status
)) {
321 return_ACPI_STATUS(status
);
323 ACPI_DEBUG_PRINT((ACPI_DB_INIT
,
324 "Entering sleep state [S%d]\n", sleep_state
));
326 /* Clear SLP_EN and SLP_TYP fields */
328 PM1Acontrol
&= ~(sleep_type_reg_info
->access_bit_mask
|
329 sleep_enable_reg_info
->access_bit_mask
);
330 PM1Bcontrol
= PM1Acontrol
;
332 /* Insert SLP_TYP bits */
335 (acpi_gbl_sleep_type_a
<< sleep_type_reg_info
->bit_position
);
337 (acpi_gbl_sleep_type_b
<< sleep_type_reg_info
->bit_position
);
340 * We split the writes of SLP_TYP and SLP_EN to workaround
341 * poorly implemented hardware.
344 /* Write #1: fill in SLP_TYP data */
346 status
= acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL
,
348 if (ACPI_FAILURE(status
)) {
349 return_ACPI_STATUS(status
);
352 status
= acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL
,
354 if (ACPI_FAILURE(status
)) {
355 return_ACPI_STATUS(status
);
358 /* Insert SLP_ENABLE bit */
360 PM1Acontrol
|= sleep_enable_reg_info
->access_bit_mask
;
361 PM1Bcontrol
|= sleep_enable_reg_info
->access_bit_mask
;
363 /* Write #2: SLP_TYP + SLP_EN */
365 ACPI_FLUSH_CPU_CACHE();
367 status
= acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL
,
369 if (ACPI_FAILURE(status
)) {
370 return_ACPI_STATUS(status
);
373 status
= acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL
,
375 if (ACPI_FAILURE(status
)) {
376 return_ACPI_STATUS(status
);
379 if (sleep_state
> ACPI_STATE_S3
) {
381 * We wanted to sleep > S3, but it didn't happen (by virtue of the
382 * fact that we are still executing!)
384 * Wait ten seconds, then try again. This is to get S4/S5 to work on
387 * We wait so long to allow chipsets that poll this reg very slowly to
388 * still read the right value. Ideally, this block would go
391 acpi_os_stall(10000000);
393 status
= acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL
,
394 sleep_enable_reg_info
->
396 if (ACPI_FAILURE(status
)) {
397 return_ACPI_STATUS(status
);
401 /* Wait until we enter sleep state */
404 status
= acpi_get_register_unlocked(ACPI_BITREG_WAKE_STATUS
,
406 if (ACPI_FAILURE(status
)) {
407 return_ACPI_STATUS(status
);
410 /* Spin until we wake */
414 return_ACPI_STATUS(AE_OK
);
417 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state
)
419 /*******************************************************************************
421 * FUNCTION: acpi_enter_sleep_state_s4bios
427 * DESCRIPTION: Perform a S4 bios request.
428 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
430 ******************************************************************************/
431 acpi_status asmlinkage
acpi_enter_sleep_state_s4bios(void)
436 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios
);
438 status
= acpi_set_register(ACPI_BITREG_WAKE_STATUS
, 1);
439 if (ACPI_FAILURE(status
)) {
440 return_ACPI_STATUS(status
);
443 status
= acpi_hw_clear_acpi_status();
444 if (ACPI_FAILURE(status
)) {
445 return_ACPI_STATUS(status
);
449 * 1) Disable/Clear all GPEs
450 * 2) Enable all wakeup GPEs
452 status
= acpi_hw_disable_all_gpes();
453 if (ACPI_FAILURE(status
)) {
454 return_ACPI_STATUS(status
);
456 acpi_gbl_system_awake_and_running
= FALSE
;
458 status
= acpi_hw_enable_all_wakeup_gpes();
459 if (ACPI_FAILURE(status
)) {
460 return_ACPI_STATUS(status
);
463 ACPI_FLUSH_CPU_CACHE();
465 status
= acpi_os_write_port(acpi_gbl_FADT
.smi_command
,
466 (u32
) acpi_gbl_FADT
.S4bios_request
, 8);
470 status
= acpi_get_register(ACPI_BITREG_WAKE_STATUS
, &in_value
);
471 if (ACPI_FAILURE(status
)) {
472 return_ACPI_STATUS(status
);
476 return_ACPI_STATUS(AE_OK
);
479 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios
)
481 /*******************************************************************************
483 * FUNCTION: acpi_leave_sleep_state_prep
485 * PARAMETERS: sleep_state - Which sleep state we are exiting
489 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
491 * Called with interrupts DISABLED.
493 ******************************************************************************/
494 acpi_status
acpi_leave_sleep_state_prep(u8 sleep_state
)
496 struct acpi_object_list arg_list
;
497 union acpi_object arg
;
499 struct acpi_bit_register_info
*sleep_type_reg_info
;
500 struct acpi_bit_register_info
*sleep_enable_reg_info
;
504 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep
);
507 * Set SLP_TYPE and SLP_EN to state S0.
508 * This is unclear from the ACPI Spec, but it is required
511 status
= acpi_get_sleep_type_data(ACPI_STATE_S0
,
512 &acpi_gbl_sleep_type_a
,
513 &acpi_gbl_sleep_type_b
);
514 if (ACPI_SUCCESS(status
)) {
515 sleep_type_reg_info
=
516 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A
);
517 sleep_enable_reg_info
=
518 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE
);
520 /* Get current value of PM1A control */
522 status
= acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL
,
524 if (ACPI_SUCCESS(status
)) {
526 /* Clear SLP_EN and SLP_TYP fields */
528 PM1Acontrol
&= ~(sleep_type_reg_info
->access_bit_mask
|
529 sleep_enable_reg_info
->
531 PM1Bcontrol
= PM1Acontrol
;
533 /* Insert SLP_TYP bits */
536 (acpi_gbl_sleep_type_a
<< sleep_type_reg_info
->
539 (acpi_gbl_sleep_type_b
<< sleep_type_reg_info
->
542 /* Just ignore any errors */
544 (void)acpi_hw_register_write(ACPI_REGISTER_PM1A_CONTROL
,
546 (void)acpi_hw_register_write(ACPI_REGISTER_PM1B_CONTROL
,
551 /* Execute the _BFS method */
554 arg_list
.pointer
= &arg
;
555 arg
.type
= ACPI_TYPE_INTEGER
;
556 arg
.integer
.value
= sleep_state
;
558 status
= acpi_evaluate_object(NULL
, METHOD_NAME__BFS
, &arg_list
, NULL
);
559 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
560 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _BFS"));
563 return_ACPI_STATUS(status
);
566 /*******************************************************************************
568 * FUNCTION: acpi_leave_sleep_state
570 * PARAMETERS: sleep_state - Which sleep state we just exited
574 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
575 * Called with interrupts ENABLED.
577 ******************************************************************************/
578 acpi_status
acpi_leave_sleep_state(u8 sleep_state
)
580 struct acpi_object_list arg_list
;
581 union acpi_object arg
;
584 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state
);
586 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
588 acpi_gbl_sleep_type_a
= ACPI_SLEEP_TYPE_INVALID
;
590 /* Setup parameter object */
593 arg_list
.pointer
= &arg
;
594 arg
.type
= ACPI_TYPE_INTEGER
;
596 /* Ignore any errors from these methods */
598 arg
.integer
.value
= ACPI_SST_WAKING
;
599 status
= acpi_evaluate_object(NULL
, METHOD_NAME__SST
, &arg_list
, NULL
);
600 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
601 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _SST"));
605 * GPEs must be enabled before _WAK is called as GPEs
606 * might get fired there
609 * 1) Disable/Clear all GPEs
610 * 2) Enable all runtime GPEs
612 status
= acpi_hw_disable_all_gpes();
613 if (ACPI_FAILURE(status
)) {
614 return_ACPI_STATUS(status
);
616 status
= acpi_hw_enable_all_runtime_gpes();
617 if (ACPI_FAILURE(status
)) {
618 return_ACPI_STATUS(status
);
621 arg
.integer
.value
= sleep_state
;
622 status
= acpi_evaluate_object(NULL
, METHOD_NAME__WAK
, &arg_list
, NULL
);
623 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
624 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _WAK"));
626 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
628 acpi_gbl_system_awake_and_running
= TRUE
;
630 /* Enable power button */
633 acpi_set_register(acpi_gbl_fixed_event_info
634 [ACPI_EVENT_POWER_BUTTON
].enable_register_id
, 1);
637 acpi_set_register(acpi_gbl_fixed_event_info
638 [ACPI_EVENT_POWER_BUTTON
].status_register_id
, 1);
640 arg
.integer
.value
= ACPI_SST_WORKING
;
641 status
= acpi_evaluate_object(NULL
, METHOD_NAME__SST
, &arg_list
, NULL
);
642 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
643 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _SST"));
646 return_ACPI_STATUS(status
);
649 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state
)