2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, 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)
156 /*******************************************************************************
158 * FUNCTION: acpi_enter_sleep_state_prep
160 * PARAMETERS: sleep_state - Which sleep state to enter
164 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
165 * This function must execute with interrupts enabled.
166 * We break sleeping into 2 stages so that OSPM can handle
167 * various OS-specific tasks between the two steps.
169 ******************************************************************************/
170 acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
173 struct acpi_object_list arg_list;
174 union acpi_object arg;
176 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
179 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
181 status = acpi_get_sleep_type_data(sleep_state,
182 &acpi_gbl_sleep_type_a,
183 &acpi_gbl_sleep_type_b);
184 if (ACPI_FAILURE(status)) {
185 return_ACPI_STATUS(status);
188 /* Setup parameter object */
191 arg_list.pointer = &arg;
193 arg.type = ACPI_TYPE_INTEGER;
194 arg.integer.value = sleep_state;
196 /* Run the _PTS and _GTS methods */
198 status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
199 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
200 return_ACPI_STATUS(status);
203 status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
204 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
205 return_ACPI_STATUS(status);
208 /* Setup the argument to _SST */
210 switch (sleep_state) {
212 arg.integer.value = ACPI_SST_WORKING;
218 arg.integer.value = ACPI_SST_SLEEPING;
222 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
226 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
230 /* Set the system indicators to show the desired sleep state. */
232 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
233 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
234 ACPI_EXCEPTION((AE_INFO, status,
235 "While executing method _SST"));
238 return_ACPI_STATUS(AE_OK);
241 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
243 /*******************************************************************************
245 * FUNCTION: acpi_enter_sleep_state
247 * PARAMETERS: sleep_state - Which sleep state to enter
251 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
252 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
254 ******************************************************************************/
255 acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
259 struct acpi_bit_register_info *sleep_type_reg_info;
260 struct acpi_bit_register_info *sleep_enable_reg_info;
264 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
266 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
267 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
268 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
269 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
270 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
273 sleep_type_reg_info =
274 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
275 sleep_enable_reg_info =
276 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
278 /* Clear wake status */
281 acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
282 if (ACPI_FAILURE(status)) {
283 return_ACPI_STATUS(status);
286 /* Clear all fixed and general purpose status bits */
288 status = acpi_hw_clear_acpi_status(ACPI_MTX_DO_NOT_LOCK);
289 if (ACPI_FAILURE(status)) {
290 return_ACPI_STATUS(status);
294 * 1) Disable/Clear all GPEs
295 * 2) Enable all wakeup GPEs
297 status = acpi_hw_disable_all_gpes();
298 if (ACPI_FAILURE(status)) {
299 return_ACPI_STATUS(status);
301 acpi_gbl_system_awake_and_running = FALSE;
303 status = acpi_hw_enable_all_wakeup_gpes();
304 if (ACPI_FAILURE(status)) {
305 return_ACPI_STATUS(status);
308 /* Get current value of PM1A control */
310 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
311 ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
312 if (ACPI_FAILURE(status)) {
313 return_ACPI_STATUS(status);
315 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
316 "Entering sleep state [S%d]\n", sleep_state));
318 /* Clear SLP_EN and SLP_TYP fields */
320 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
321 sleep_enable_reg_info->access_bit_mask);
322 PM1Bcontrol = PM1Acontrol;
324 /* Insert SLP_TYP bits */
327 (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
329 (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
332 * We split the writes of SLP_TYP and SLP_EN to workaround
333 * poorly implemented hardware.
336 /* Write #1: fill in SLP_TYP data */
338 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
339 ACPI_REGISTER_PM1A_CONTROL,
341 if (ACPI_FAILURE(status)) {
342 return_ACPI_STATUS(status);
345 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
346 ACPI_REGISTER_PM1B_CONTROL,
348 if (ACPI_FAILURE(status)) {
349 return_ACPI_STATUS(status);
352 /* Insert SLP_ENABLE bit */
354 PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
355 PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
357 /* Write #2: SLP_TYP + SLP_EN */
359 ACPI_FLUSH_CPU_CACHE();
361 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
362 ACPI_REGISTER_PM1A_CONTROL,
364 if (ACPI_FAILURE(status)) {
365 return_ACPI_STATUS(status);
368 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
369 ACPI_REGISTER_PM1B_CONTROL,
371 if (ACPI_FAILURE(status)) {
372 return_ACPI_STATUS(status);
375 if (sleep_state > ACPI_STATE_S3) {
377 * We wanted to sleep > S3, but it didn't happen (by virtue of the
378 * fact that we are still executing!)
380 * Wait ten seconds, then try again. This is to get S4/S5 to work on
383 * We wait so long to allow chipsets that poll this reg very slowly to
384 * still read the right value. Ideally, this block would go
387 acpi_os_stall(10000000);
389 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
390 ACPI_REGISTER_PM1_CONTROL,
391 sleep_enable_reg_info->
393 if (ACPI_FAILURE(status)) {
394 return_ACPI_STATUS(status);
398 /* Wait until we enter sleep state */
401 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value,
402 ACPI_MTX_DO_NOT_LOCK);
403 if (ACPI_FAILURE(status)) {
404 return_ACPI_STATUS(status);
407 /* Spin until we wake */
411 return_ACPI_STATUS(AE_OK);
414 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
416 /*******************************************************************************
418 * FUNCTION: acpi_enter_sleep_state_s4bios
424 * DESCRIPTION: Perform a S4 bios request.
425 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
427 ******************************************************************************/
428 acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
433 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
436 acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
437 if (ACPI_FAILURE(status)) {
438 return_ACPI_STATUS(status);
441 status = acpi_hw_clear_acpi_status(ACPI_MTX_DO_NOT_LOCK);
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 ACPI_MTX_DO_NOT_LOCK);
470 if (ACPI_FAILURE(status)) {
471 return_ACPI_STATUS(status);
475 return_ACPI_STATUS(AE_OK);
478 ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
480 /*******************************************************************************
482 * FUNCTION: acpi_leave_sleep_state
484 * PARAMETERS: sleep_state - Which sleep state we just exited
488 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
489 * Called with interrupts ENABLED.
491 ******************************************************************************/
492 acpi_status acpi_leave_sleep_state(u8 sleep_state)
494 struct acpi_object_list arg_list;
495 union acpi_object arg;
497 struct acpi_bit_register_info *sleep_type_reg_info;
498 struct acpi_bit_register_info *sleep_enable_reg_info;
502 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
505 * Set SLP_TYPE and SLP_EN to state S0.
506 * This is unclear from the ACPI Spec, but it is required
509 status = acpi_get_sleep_type_data(ACPI_STATE_S0,
510 &acpi_gbl_sleep_type_a,
511 &acpi_gbl_sleep_type_b);
512 if (ACPI_SUCCESS(status)) {
513 sleep_type_reg_info =
514 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
515 sleep_enable_reg_info =
516 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
518 /* Get current value of PM1A control */
520 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
521 ACPI_REGISTER_PM1_CONTROL,
523 if (ACPI_SUCCESS(status)) {
525 /* Clear SLP_EN and SLP_TYP fields */
527 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
528 sleep_enable_reg_info->
530 PM1Bcontrol = PM1Acontrol;
532 /* Insert SLP_TYP bits */
535 (acpi_gbl_sleep_type_a << sleep_type_reg_info->
538 (acpi_gbl_sleep_type_b << sleep_type_reg_info->
541 /* Just ignore any errors */
543 (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
544 ACPI_REGISTER_PM1A_CONTROL,
546 (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
547 ACPI_REGISTER_PM1B_CONTROL,
552 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
554 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
556 /* Setup parameter object */
559 arg_list.pointer = &arg;
560 arg.type = ACPI_TYPE_INTEGER;
562 /* Ignore any errors from these methods */
564 arg.integer.value = ACPI_SST_WAKING;
565 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
566 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
567 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
570 arg.integer.value = sleep_state;
571 status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
572 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
573 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
576 status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
577 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
578 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
580 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
584 * 1) Disable/Clear all GPEs
585 * 2) Enable all runtime GPEs
587 status = acpi_hw_disable_all_gpes();
588 if (ACPI_FAILURE(status)) {
589 return_ACPI_STATUS(status);
591 acpi_gbl_system_awake_and_running = TRUE;
593 status = acpi_hw_enable_all_runtime_gpes();
594 if (ACPI_FAILURE(status)) {
595 return_ACPI_STATUS(status);
598 /* Enable power button */
601 acpi_set_register(acpi_gbl_fixed_event_info
602 [ACPI_EVENT_POWER_BUTTON].enable_register_id, 1,
603 ACPI_MTX_DO_NOT_LOCK);
606 acpi_set_register(acpi_gbl_fixed_event_info
607 [ACPI_EVENT_POWER_BUTTON].status_register_id, 1,
608 ACPI_MTX_DO_NOT_LOCK);
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)