2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2007, R. Byron Moore
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
);
74 acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
75 (struct acpi_table_header
**)&facs
);
76 if (ACPI_FAILURE(status
)) {
77 return_ACPI_STATUS(status
);
82 if ((facs
->length
< 32) || (!(facs
->xfirmware_waking_vector
))) {
84 * ACPI 1.0 FACS or short table or optional X_ field is zero
86 facs
->firmware_waking_vector
= (u32
) physical_address
;
89 * ACPI 2.0 FACS with valid X_ field
91 facs
->xfirmware_waking_vector
= physical_address
;
94 return_ACPI_STATUS(AE_OK
);
97 ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector
)
99 /*******************************************************************************
101 * FUNCTION: acpi_get_firmware_waking_vector
103 * PARAMETERS: *physical_address - Where the contents of
104 * the firmware_waking_vector field of
105 * the FACS will be returned.
107 * RETURN: Status, vector
109 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
111 ******************************************************************************/
112 #ifdef ACPI_FUTURE_USAGE
114 acpi_get_firmware_waking_vector(acpi_physical_address
* physical_address
)
116 struct acpi_table_facs
*facs
;
119 ACPI_FUNCTION_TRACE(acpi_get_firmware_waking_vector
);
121 if (!physical_address
) {
122 return_ACPI_STATUS(AE_BAD_PARAMETER
);
128 acpi_get_table_by_index(ACPI_TABLE_INDEX_FACS
,
129 (struct acpi_table_header
**)&facs
);
130 if (ACPI_FAILURE(status
)) {
131 return_ACPI_STATUS(status
);
136 if ((facs
->length
< 32) || (!(facs
->xfirmware_waking_vector
))) {
138 * ACPI 1.0 FACS or short table or optional X_ field is zero
141 (acpi_physical_address
) facs
->firmware_waking_vector
;
144 * ACPI 2.0 FACS with valid X_ field
147 (acpi_physical_address
) facs
->xfirmware_waking_vector
;
150 return_ACPI_STATUS(AE_OK
);
153 ACPI_EXPORT_SYMBOL(acpi_get_firmware_waking_vector
)
155 /*******************************************************************************
157 * FUNCTION: acpi_enter_sleep_state_prep
159 * PARAMETERS: sleep_state - Which sleep state to enter
163 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
164 * This function must execute with interrupts enabled.
165 * We break sleeping into 2 stages so that OSPM can handle
166 * various OS-specific tasks between the two steps.
168 ******************************************************************************/
169 acpi_status
acpi_enter_sleep_state_prep(u8 sleep_state
)
172 struct acpi_object_list arg_list
;
173 union acpi_object arg
;
175 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep
);
178 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
180 status
= acpi_get_sleep_type_data(sleep_state
,
181 &acpi_gbl_sleep_type_a
,
182 &acpi_gbl_sleep_type_b
);
183 if (ACPI_FAILURE(status
)) {
184 return_ACPI_STATUS(status
);
187 /* Setup parameter object */
190 arg_list
.pointer
= &arg
;
192 arg
.type
= ACPI_TYPE_INTEGER
;
193 arg
.integer
.value
= sleep_state
;
195 /* Run the _PTS and _GTS methods */
197 status
= acpi_evaluate_object(NULL
, METHOD_NAME__PTS
, &arg_list
, NULL
);
198 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
199 return_ACPI_STATUS(status
);
202 status
= acpi_evaluate_object(NULL
, METHOD_NAME__GTS
, &arg_list
, NULL
);
203 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
204 return_ACPI_STATUS(status
);
207 /* Setup the argument to _SST */
209 switch (sleep_state
) {
211 arg
.integer
.value
= ACPI_SST_WORKING
;
217 arg
.integer
.value
= ACPI_SST_SLEEPING
;
221 arg
.integer
.value
= ACPI_SST_SLEEP_CONTEXT
;
225 arg
.integer
.value
= ACPI_SST_INDICATOR_OFF
; /* Default is off */
229 /* Set the system indicators to show the desired sleep state. */
231 status
= acpi_evaluate_object(NULL
, METHOD_NAME__SST
, &arg_list
, NULL
);
232 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
233 ACPI_EXCEPTION((AE_INFO
, status
,
234 "While executing method _SST"));
237 /* Disable/Clear all GPEs */
239 status
= acpi_hw_disable_all_gpes();
241 return_ACPI_STATUS(status
);
244 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep
)
246 /*******************************************************************************
248 * FUNCTION: acpi_enter_sleep_state
250 * PARAMETERS: sleep_state - Which sleep state to enter
254 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
255 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
257 ******************************************************************************/
258 acpi_status asmlinkage
acpi_enter_sleep_state(u8 sleep_state
)
262 struct acpi_bit_register_info
*sleep_type_reg_info
;
263 struct acpi_bit_register_info
*sleep_enable_reg_info
;
267 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state
);
269 if ((acpi_gbl_sleep_type_a
> ACPI_SLEEP_TYPE_MAX
) ||
270 (acpi_gbl_sleep_type_b
> ACPI_SLEEP_TYPE_MAX
)) {
271 ACPI_ERROR((AE_INFO
, "Sleep values out of range: A=%X B=%X",
272 acpi_gbl_sleep_type_a
, acpi_gbl_sleep_type_b
));
273 return_ACPI_STATUS(AE_AML_OPERAND_VALUE
);
276 sleep_type_reg_info
=
277 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A
);
278 sleep_enable_reg_info
=
279 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE
);
281 /* Clear wake status */
283 status
= acpi_set_register(ACPI_BITREG_WAKE_STATUS
, 1);
284 if (ACPI_FAILURE(status
)) {
285 return_ACPI_STATUS(status
);
288 /* Clear all fixed and general purpose status bits */
290 status
= acpi_hw_clear_acpi_status();
291 if (ACPI_FAILURE(status
)) {
292 return_ACPI_STATUS(status
);
296 * 2) Enable all wakeup GPEs
298 status
= acpi_hw_disable_all_gpes();
299 if (ACPI_FAILURE(status
)) {
300 return_ACPI_STATUS(status
);
303 acpi_gbl_system_awake_and_running
= FALSE
;
305 status
= acpi_hw_enable_all_wakeup_gpes();
306 if (ACPI_FAILURE(status
)) {
307 return_ACPI_STATUS(status
);
310 /* Get current value of PM1A control */
312 status
= acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK
,
313 ACPI_REGISTER_PM1_CONTROL
, &PM1Acontrol
);
314 if (ACPI_FAILURE(status
)) {
315 return_ACPI_STATUS(status
);
317 ACPI_DEBUG_PRINT((ACPI_DB_INIT
,
318 "Entering sleep state [S%d]\n", sleep_state
));
320 /* Clear SLP_EN and SLP_TYP fields */
322 PM1Acontrol
&= ~(sleep_type_reg_info
->access_bit_mask
|
323 sleep_enable_reg_info
->access_bit_mask
);
324 PM1Bcontrol
= PM1Acontrol
;
326 /* Insert SLP_TYP bits */
329 (acpi_gbl_sleep_type_a
<< sleep_type_reg_info
->bit_position
);
331 (acpi_gbl_sleep_type_b
<< sleep_type_reg_info
->bit_position
);
334 * We split the writes of SLP_TYP and SLP_EN to workaround
335 * poorly implemented hardware.
338 /* Write #1: fill in SLP_TYP data */
340 status
= acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
341 ACPI_REGISTER_PM1A_CONTROL
,
343 if (ACPI_FAILURE(status
)) {
344 return_ACPI_STATUS(status
);
347 status
= acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
348 ACPI_REGISTER_PM1B_CONTROL
,
350 if (ACPI_FAILURE(status
)) {
351 return_ACPI_STATUS(status
);
354 /* Insert SLP_ENABLE bit */
356 PM1Acontrol
|= sleep_enable_reg_info
->access_bit_mask
;
357 PM1Bcontrol
|= sleep_enable_reg_info
->access_bit_mask
;
359 /* Write #2: SLP_TYP + SLP_EN */
361 ACPI_FLUSH_CPU_CACHE();
363 status
= acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
364 ACPI_REGISTER_PM1A_CONTROL
,
366 if (ACPI_FAILURE(status
)) {
367 return_ACPI_STATUS(status
);
370 status
= acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
371 ACPI_REGISTER_PM1B_CONTROL
,
373 if (ACPI_FAILURE(status
)) {
374 return_ACPI_STATUS(status
);
377 if (sleep_state
> ACPI_STATE_S3
) {
379 * We wanted to sleep > S3, but it didn't happen (by virtue of the
380 * fact that we are still executing!)
382 * Wait ten seconds, then try again. This is to get S4/S5 to work on
385 * We wait so long to allow chipsets that poll this reg very slowly to
386 * still read the right value. Ideally, this block would go
389 acpi_os_stall(10000000);
391 status
= acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
392 ACPI_REGISTER_PM1_CONTROL
,
393 sleep_enable_reg_info
->
395 if (ACPI_FAILURE(status
)) {
396 return_ACPI_STATUS(status
);
400 /* Wait until we enter sleep state */
403 status
= acpi_get_register(ACPI_BITREG_WAKE_STATUS
, &in_value
);
404 if (ACPI_FAILURE(status
)) {
405 return_ACPI_STATUS(status
);
408 /* Spin until we wake */
412 return_ACPI_STATUS(AE_OK
);
415 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state
)
417 /*******************************************************************************
419 * FUNCTION: acpi_enter_sleep_state_s4bios
425 * DESCRIPTION: Perform a S4 bios request.
426 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
428 ******************************************************************************/
429 acpi_status asmlinkage
acpi_enter_sleep_state_s4bios(void)
434 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios
);
436 status
= acpi_set_register(ACPI_BITREG_WAKE_STATUS
, 1);
437 if (ACPI_FAILURE(status
)) {
438 return_ACPI_STATUS(status
);
441 status
= acpi_hw_clear_acpi_status();
442 if (ACPI_FAILURE(status
)) {
443 return_ACPI_STATUS(status
);
447 * 1) Disable/Clear all GPEs
448 * 2) Enable all wakeup GPEs
450 status
= acpi_hw_disable_all_gpes();
451 if (ACPI_FAILURE(status
)) {
452 return_ACPI_STATUS(status
);
454 acpi_gbl_system_awake_and_running
= FALSE
;
456 status
= acpi_hw_enable_all_wakeup_gpes();
457 if (ACPI_FAILURE(status
)) {
458 return_ACPI_STATUS(status
);
461 ACPI_FLUSH_CPU_CACHE();
463 status
= acpi_os_write_port(acpi_gbl_FADT
.smi_command
,
464 (u32
) acpi_gbl_FADT
.S4bios_request
, 8);
468 status
= acpi_get_register(ACPI_BITREG_WAKE_STATUS
, &in_value
);
469 if (ACPI_FAILURE(status
)) {
470 return_ACPI_STATUS(status
);
474 return_ACPI_STATUS(AE_OK
);
477 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios
)
479 /*******************************************************************************
481 * FUNCTION: acpi_leave_sleep_state
483 * PARAMETERS: sleep_state - Which sleep state we just exited
487 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
488 * Called with interrupts ENABLED.
490 ******************************************************************************/
491 acpi_status
acpi_leave_sleep_state(u8 sleep_state
)
493 struct acpi_object_list arg_list
;
494 union acpi_object arg
;
496 struct acpi_bit_register_info
*sleep_type_reg_info
;
497 struct acpi_bit_register_info
*sleep_enable_reg_info
;
501 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state
);
504 * Set SLP_TYPE and SLP_EN to state S0.
505 * This is unclear from the ACPI Spec, but it is required
508 status
= acpi_get_sleep_type_data(ACPI_STATE_S0
,
509 &acpi_gbl_sleep_type_a
,
510 &acpi_gbl_sleep_type_b
);
511 if (ACPI_SUCCESS(status
)) {
512 sleep_type_reg_info
=
513 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A
);
514 sleep_enable_reg_info
=
515 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE
);
517 /* Get current value of PM1A control */
519 status
= acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK
,
520 ACPI_REGISTER_PM1_CONTROL
,
522 if (ACPI_SUCCESS(status
)) {
524 /* Clear SLP_EN and SLP_TYP fields */
526 PM1Acontrol
&= ~(sleep_type_reg_info
->access_bit_mask
|
527 sleep_enable_reg_info
->
529 PM1Bcontrol
= PM1Acontrol
;
531 /* Insert SLP_TYP bits */
534 (acpi_gbl_sleep_type_a
<< sleep_type_reg_info
->
537 (acpi_gbl_sleep_type_b
<< sleep_type_reg_info
->
540 /* Just ignore any errors */
542 (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
543 ACPI_REGISTER_PM1A_CONTROL
,
545 (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK
,
546 ACPI_REGISTER_PM1B_CONTROL
,
551 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
553 acpi_gbl_sleep_type_a
= ACPI_SLEEP_TYPE_INVALID
;
555 /* Setup parameter object */
558 arg_list
.pointer
= &arg
;
559 arg
.type
= ACPI_TYPE_INTEGER
;
561 /* Ignore any errors from these methods */
563 arg
.integer
.value
= ACPI_SST_WAKING
;
564 status
= acpi_evaluate_object(NULL
, METHOD_NAME__SST
, &arg_list
, NULL
);
565 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
566 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _SST"));
569 arg
.integer
.value
= sleep_state
;
570 status
= acpi_evaluate_object(NULL
, METHOD_NAME__BFS
, &arg_list
, NULL
);
571 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
572 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _BFS"));
576 * GPEs must be enabled before _WAK is called as GPEs
577 * might get fired there
580 * 1) Disable/Clear all GPEs
581 * 2) Enable all runtime GPEs
583 status
= acpi_hw_disable_all_gpes();
584 if (ACPI_FAILURE(status
)) {
585 return_ACPI_STATUS(status
);
587 status
= acpi_hw_enable_all_runtime_gpes();
588 if (ACPI_FAILURE(status
)) {
589 return_ACPI_STATUS(status
);
592 status
= acpi_evaluate_object(NULL
, METHOD_NAME__WAK
, &arg_list
, NULL
);
593 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
594 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _WAK"));
596 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
598 acpi_gbl_system_awake_and_running
= TRUE
;
600 /* Enable power button */
603 acpi_set_register(acpi_gbl_fixed_event_info
604 [ACPI_EVENT_POWER_BUTTON
].enable_register_id
, 1);
607 acpi_set_register(acpi_gbl_fixed_event_info
608 [ACPI_EVENT_POWER_BUTTON
].status_register_id
, 1);
610 arg
.integer
.value
= ACPI_SST_WORKING
;
611 status
= acpi_evaluate_object(NULL
, METHOD_NAME__SST
, &arg_list
, NULL
);
612 if (ACPI_FAILURE(status
) && status
!= AE_NOT_FOUND
) {
613 ACPI_EXCEPTION((AE_INFO
, status
, "During Method _SST"));
616 return_ACPI_STATUS(status
);
619 ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state
)