2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2004, 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>
47 #define _COMPONENT ACPI_HARDWARE
48 ACPI_MODULE_NAME ("hwsleep")
51 #define METHOD_NAME__BFS "\\_BFS"
52 #define METHOD_NAME__GTS "\\_GTS"
53 #define METHOD_NAME__PTS "\\_PTS"
54 #define METHOD_NAME__SST "\\_SI._SST"
55 #define METHOD_NAME__WAK "\\_WAK"
57 #define ACPI_SST_INDICATOR_OFF 0
58 #define ACPI_SST_WORKING 1
59 #define ACPI_SST_WAKING 2
60 #define ACPI_SST_SLEEPING 3
61 #define ACPI_SST_SLEEP_CONTEXT 4
64 /******************************************************************************
66 * FUNCTION: acpi_set_firmware_waking_vector
68 * PARAMETERS: physical_address - Physical address of ACPI real mode
73 * DESCRIPTION: access function for d_firmware_waking_vector field in FACS
75 ******************************************************************************/
78 acpi_set_firmware_waking_vector (
79 acpi_physical_address physical_address)
82 ACPI_FUNCTION_TRACE ("acpi_set_firmware_waking_vector");
87 if (acpi_gbl_common_fACS.vector_width == 32) {
88 *(ACPI_CAST_PTR (u32, acpi_gbl_common_fACS.firmware_waking_vector))
89 = (u32) physical_address;
92 *acpi_gbl_common_fACS.firmware_waking_vector
96 return_ACPI_STATUS (AE_OK);
100 /******************************************************************************
102 * FUNCTION: acpi_get_firmware_waking_vector
104 * PARAMETERS: *physical_address - Output buffer where contents of
105 * the firmware_waking_vector field of
106 * the FACS will be stored.
110 * DESCRIPTION: Access function for firmware_waking_vector field in FACS
112 ******************************************************************************/
115 acpi_get_firmware_waking_vector (
116 acpi_physical_address *physical_address)
119 ACPI_FUNCTION_TRACE ("acpi_get_firmware_waking_vector");
122 if (!physical_address) {
123 return_ACPI_STATUS (AE_BAD_PARAMETER);
128 if (acpi_gbl_common_fACS.vector_width == 32) {
129 *physical_address = (acpi_physical_address)
130 *(ACPI_CAST_PTR (u32, acpi_gbl_common_fACS.firmware_waking_vector));
134 *acpi_gbl_common_fACS.firmware_waking_vector;
137 return_ACPI_STATUS (AE_OK);
141 /******************************************************************************
143 * FUNCTION: acpi_enter_sleep_state_prep
145 * PARAMETERS: sleep_state - Which sleep state to enter
149 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
150 * This function must execute with interrupts enabled.
151 * We break sleeping into 2 stages so that OSPM can handle
152 * various OS-specific tasks between the two steps.
154 ******************************************************************************/
157 acpi_enter_sleep_state_prep (
161 struct acpi_object_list arg_list;
162 union acpi_object arg;
165 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state_prep");
169 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
171 status = acpi_get_sleep_type_data (sleep_state,
172 &acpi_gbl_sleep_type_a, &acpi_gbl_sleep_type_b);
173 if (ACPI_FAILURE (status)) {
174 return_ACPI_STATUS (status);
177 /* Setup parameter object */
180 arg_list.pointer = &arg;
182 arg.type = ACPI_TYPE_INTEGER;
183 arg.integer.value = sleep_state;
185 /* Run the _PTS and _GTS methods */
187 status = acpi_evaluate_object (NULL, METHOD_NAME__PTS, &arg_list, NULL);
188 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
189 return_ACPI_STATUS (status);
192 status = acpi_evaluate_object (NULL, METHOD_NAME__GTS, &arg_list, NULL);
193 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
194 return_ACPI_STATUS (status);
197 /* Setup the argument to _SST */
199 switch (sleep_state) {
201 arg.integer.value = ACPI_SST_WORKING;
207 arg.integer.value = ACPI_SST_SLEEPING;
211 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
215 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is indicator off */
219 /* Set the system indicators to show the desired sleep state. */
221 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
222 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
223 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", acpi_format_exception (status)));
226 return_ACPI_STATUS (AE_OK);
230 /******************************************************************************
232 * FUNCTION: acpi_enter_sleep_state
234 * PARAMETERS: sleep_state - Which sleep state to enter
238 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
239 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
241 ******************************************************************************/
243 acpi_status asmlinkage
244 acpi_enter_sleep_state (
249 struct acpi_bit_register_info *sleep_type_reg_info;
250 struct acpi_bit_register_info *sleep_enable_reg_info;
255 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state");
258 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
259 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
260 ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
261 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
262 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
265 sleep_type_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_TYPE_A);
266 sleep_enable_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_ENABLE);
268 if (sleep_state != ACPI_STATE_S5) {
269 /* Clear wake status */
271 status = acpi_set_register (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
272 if (ACPI_FAILURE (status)) {
273 return_ACPI_STATUS (status);
276 status = acpi_hw_clear_acpi_status (ACPI_MTX_DO_NOT_LOCK);
277 if (ACPI_FAILURE (status)) {
278 return_ACPI_STATUS (status);
281 /* Disable BM arbitration */
283 status = acpi_set_register (ACPI_BITREG_ARB_DISABLE, 1, ACPI_MTX_DO_NOT_LOCK);
284 if (ACPI_FAILURE (status)) {
285 return_ACPI_STATUS (status);
290 * 1) Disable all runtime GPEs
291 * 2) Enable all wakeup GPEs
293 status = acpi_hw_prepare_gpes_for_sleep ();
294 if (ACPI_FAILURE (status)) {
295 return_ACPI_STATUS (status);
298 /* Get current value of PM1A control */
300 status = acpi_hw_register_read (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
301 if (ACPI_FAILURE (status)) {
302 return_ACPI_STATUS (status);
304 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Entering sleep state [S%d]\n", sleep_state));
306 /* Clear SLP_EN and SLP_TYP fields */
308 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask | sleep_enable_reg_info->access_bit_mask);
309 PM1Bcontrol = PM1Acontrol;
311 /* Insert SLP_TYP bits */
313 PM1Acontrol |= (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
314 PM1Bcontrol |= (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
317 * We split the writes of SLP_TYP and SLP_EN to workaround
318 * poorly implemented hardware.
321 /* Write #1: fill in SLP_TYP data */
323 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
324 if (ACPI_FAILURE (status)) {
325 return_ACPI_STATUS (status);
328 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
329 if (ACPI_FAILURE (status)) {
330 return_ACPI_STATUS (status);
333 /* Insert SLP_ENABLE bit */
335 PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
336 PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
338 /* Write #2: SLP_TYP + SLP_EN */
340 ACPI_FLUSH_CPU_CACHE ();
342 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
343 if (ACPI_FAILURE (status)) {
344 return_ACPI_STATUS (status);
347 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, 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 fact that
355 * we are still executing!)
357 * Wait ten seconds, then try again. This is to get S4/S5 to work on all machines.
359 * We wait so long to allow chipsets that poll this reg very slowly to
360 * still read the right value. Ideally, this block would go
363 acpi_os_stall (10000000);
365 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL,
366 sleep_enable_reg_info->access_bit_mask);
367 if (ACPI_FAILURE (status)) {
368 return_ACPI_STATUS (status);
372 /* Wait until we enter sleep state */
375 status = acpi_get_register (ACPI_BITREG_WAKE_STATUS, &in_value, ACPI_MTX_DO_NOT_LOCK);
376 if (ACPI_FAILURE (status)) {
377 return_ACPI_STATUS (status);
380 /* Spin until we wake */
384 return_ACPI_STATUS (AE_OK);
388 /******************************************************************************
390 * FUNCTION: acpi_enter_sleep_state_s4bios
396 * DESCRIPTION: Perform a S4 bios request.
397 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
399 ******************************************************************************/
401 acpi_status asmlinkage
402 acpi_enter_sleep_state_s4bios (
409 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state_s4bios");
412 status = acpi_set_register (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
413 if (ACPI_FAILURE (status)) {
414 return_ACPI_STATUS (status);
417 status = acpi_hw_clear_acpi_status (ACPI_MTX_DO_NOT_LOCK);
418 if (ACPI_FAILURE (status)) {
419 return_ACPI_STATUS (status);
423 * 1) Disable all runtime GPEs
424 * 2) Enable all wakeup GPEs
426 status = acpi_hw_prepare_gpes_for_sleep ();
427 if (ACPI_FAILURE (status)) {
428 return_ACPI_STATUS (status);
431 ACPI_FLUSH_CPU_CACHE ();
433 status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd, (u32) acpi_gbl_FADT->S4bios_req, 8);
437 status = acpi_get_register (ACPI_BITREG_WAKE_STATUS, &in_value, ACPI_MTX_DO_NOT_LOCK);
438 if (ACPI_FAILURE (status)) {
439 return_ACPI_STATUS (status);
443 return_ACPI_STATUS (AE_OK);
447 /******************************************************************************
449 * FUNCTION: acpi_leave_sleep_state
451 * PARAMETERS: sleep_state - Which sleep state we just exited
455 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
457 ******************************************************************************/
460 acpi_leave_sleep_state (
463 struct acpi_object_list arg_list;
464 union acpi_object arg;
466 struct acpi_bit_register_info *sleep_type_reg_info;
467 struct acpi_bit_register_info *sleep_enable_reg_info;
472 ACPI_FUNCTION_TRACE ("acpi_leave_sleep_state");
476 * Set SLP_TYPE and SLP_EN to state S0.
477 * This is unclear from the ACPI Spec, but it is required
480 status = acpi_get_sleep_type_data (ACPI_STATE_S0,
481 &acpi_gbl_sleep_type_a, &acpi_gbl_sleep_type_b);
482 if (ACPI_SUCCESS (status)) {
483 sleep_type_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_TYPE_A);
484 sleep_enable_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_ENABLE);
486 /* Get current value of PM1A control */
488 status = acpi_hw_register_read (ACPI_MTX_DO_NOT_LOCK,
489 ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
490 if (ACPI_SUCCESS (status)) {
491 /* Clear SLP_EN and SLP_TYP fields */
493 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
494 sleep_enable_reg_info->access_bit_mask);
495 PM1Bcontrol = PM1Acontrol;
497 /* Insert SLP_TYP bits */
499 PM1Acontrol |= (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
500 PM1Bcontrol |= (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
502 /* Just ignore any errors */
504 (void) acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
505 ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
506 (void) acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
507 ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
511 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
513 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
515 /* Setup parameter object */
518 arg_list.pointer = &arg;
519 arg.type = ACPI_TYPE_INTEGER;
521 /* Ignore any errors from these methods */
523 arg.integer.value = ACPI_SST_WAKING;
524 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
525 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
526 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", acpi_format_exception (status)));
529 arg.integer.value = sleep_state;
530 status = acpi_evaluate_object (NULL, METHOD_NAME__BFS, &arg_list, NULL);
531 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
532 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", acpi_format_exception (status)));
535 status = acpi_evaluate_object (NULL, METHOD_NAME__WAK, &arg_list, NULL);
536 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
537 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", acpi_format_exception (status)));
539 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
543 * 1) Disable all wakeup GPEs
544 * 2) Enable all runtime GPEs
546 status = acpi_hw_restore_gpes_on_wake ();
547 if (ACPI_FAILURE (status)) {
548 return_ACPI_STATUS (status);
551 /* Enable power button */
553 acpi_set_register(acpi_gbl_fixed_event_info[ACPI_EVENT_POWER_BUTTON].enable_register_id,
554 1, ACPI_MTX_DO_NOT_LOCK);
555 acpi_set_register(acpi_gbl_fixed_event_info[ACPI_EVENT_POWER_BUTTON].status_register_id,
556 1, ACPI_MTX_DO_NOT_LOCK);
558 /* Enable BM arbitration */
560 status = acpi_set_register (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_LOCK);
561 if (ACPI_FAILURE (status)) {
562 return_ACPI_STATUS (status);
565 arg.integer.value = ACPI_SST_WORKING;
566 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
567 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
568 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", acpi_format_exception (status)));
571 return_ACPI_STATUS (status);