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 <linux/module.h>
47 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_HARDWARE
50 ACPI_MODULE_NAME ("hwsleep")
53 #define METHOD_NAME__BFS "\\_BFS"
54 #define METHOD_NAME__GTS "\\_GTS"
55 #define METHOD_NAME__PTS "\\_PTS"
56 #define METHOD_NAME__SST "\\_SI._SST"
57 #define METHOD_NAME__WAK "\\_WAK"
59 #define ACPI_SST_INDICATOR_OFF 0
60 #define ACPI_SST_WORKING 1
61 #define ACPI_SST_WAKING 2
62 #define ACPI_SST_SLEEPING 3
63 #define ACPI_SST_SLEEP_CONTEXT 4
66 /******************************************************************************
68 * FUNCTION: acpi_set_firmware_waking_vector
70 * PARAMETERS: physical_address - Physical address of ACPI real mode
75 * DESCRIPTION: access function for d_firmware_waking_vector field in FACS
77 ******************************************************************************/
80 acpi_set_firmware_waking_vector (
81 acpi_physical_address physical_address)
84 ACPI_FUNCTION_TRACE ("acpi_set_firmware_waking_vector");
89 if (acpi_gbl_common_fACS.vector_width == 32) {
90 *(ACPI_CAST_PTR (u32, acpi_gbl_common_fACS.firmware_waking_vector))
91 = (u32) physical_address;
94 *acpi_gbl_common_fACS.firmware_waking_vector
98 return_ACPI_STATUS (AE_OK);
102 /******************************************************************************
104 * FUNCTION: acpi_get_firmware_waking_vector
106 * PARAMETERS: *physical_address - Output buffer where contents of
107 * the firmware_waking_vector field of
108 * the FACS will be stored.
112 * DESCRIPTION: Access function for firmware_waking_vector field in FACS
114 ******************************************************************************/
115 #ifdef ACPI_FUTURE_USAGE
117 acpi_get_firmware_waking_vector (
118 acpi_physical_address *physical_address)
121 ACPI_FUNCTION_TRACE ("acpi_get_firmware_waking_vector");
124 if (!physical_address) {
125 return_ACPI_STATUS (AE_BAD_PARAMETER);
130 if (acpi_gbl_common_fACS.vector_width == 32) {
131 *physical_address = (acpi_physical_address)
132 *(ACPI_CAST_PTR (u32, acpi_gbl_common_fACS.firmware_waking_vector));
136 *acpi_gbl_common_fACS.firmware_waking_vector;
139 return_ACPI_STATUS (AE_OK);
144 /******************************************************************************
146 * FUNCTION: acpi_enter_sleep_state_prep
148 * PARAMETERS: sleep_state - Which sleep state to enter
152 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
153 * This function must execute with interrupts enabled.
154 * We break sleeping into 2 stages so that OSPM can handle
155 * various OS-specific tasks between the two steps.
157 ******************************************************************************/
160 acpi_enter_sleep_state_prep (
164 struct acpi_object_list arg_list;
165 union acpi_object arg;
168 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state_prep");
172 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
174 status = acpi_get_sleep_type_data (sleep_state,
175 &acpi_gbl_sleep_type_a, &acpi_gbl_sleep_type_b);
176 if (ACPI_FAILURE (status)) {
177 return_ACPI_STATUS (status);
180 /* Setup parameter object */
183 arg_list.pointer = &arg;
185 arg.type = ACPI_TYPE_INTEGER;
186 arg.integer.value = sleep_state;
188 /* Run the _PTS and _GTS methods */
190 status = acpi_evaluate_object (NULL, METHOD_NAME__PTS, &arg_list, NULL);
191 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
192 return_ACPI_STATUS (status);
195 status = acpi_evaluate_object (NULL, METHOD_NAME__GTS, &arg_list, NULL);
196 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
197 return_ACPI_STATUS (status);
200 /* Setup the argument to _SST */
202 switch (sleep_state) {
204 arg.integer.value = ACPI_SST_WORKING;
210 arg.integer.value = ACPI_SST_SLEEPING;
214 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
218 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is indicator off */
222 /* Set the system indicators to show the desired sleep state. */
224 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
225 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
226 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", acpi_format_exception (status)));
229 return_ACPI_STATUS (AE_OK);
233 /******************************************************************************
235 * FUNCTION: acpi_enter_sleep_state
237 * PARAMETERS: sleep_state - Which sleep state to enter
241 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
242 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
244 ******************************************************************************/
246 acpi_status asmlinkage
247 acpi_enter_sleep_state (
252 struct acpi_bit_register_info *sleep_type_reg_info;
253 struct acpi_bit_register_info *sleep_enable_reg_info;
258 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state");
261 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
262 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
263 ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
264 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
265 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
268 sleep_type_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_TYPE_A);
269 sleep_enable_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_ENABLE);
271 /* Clear wake status */
273 status = acpi_set_register (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
274 if (ACPI_FAILURE (status)) {
275 return_ACPI_STATUS (status);
278 /* Clear all fixed and general purpose status bits */
280 status = acpi_hw_clear_acpi_status (ACPI_MTX_DO_NOT_LOCK);
281 if (ACPI_FAILURE (status)) {
282 return_ACPI_STATUS (status);
285 if (sleep_state != ACPI_STATE_S5) {
286 /* Disable BM arbitration */
288 status = acpi_set_register (ACPI_BITREG_ARB_DISABLE, 1, ACPI_MTX_DO_NOT_LOCK);
289 if (ACPI_FAILURE (status)) {
290 return_ACPI_STATUS (status);
295 * 1) Disable/Clear all GPEs
296 * 2) Enable all wakeup GPEs
298 status = acpi_hw_disable_all_gpes (ACPI_ISR);
299 if (ACPI_FAILURE (status)) {
300 return_ACPI_STATUS (status);
302 acpi_gbl_system_awake_and_running = FALSE;
304 status = acpi_hw_enable_all_wakeup_gpes (ACPI_ISR);
305 if (ACPI_FAILURE (status)) {
306 return_ACPI_STATUS (status);
309 /* Get current value of PM1A control */
311 status = acpi_hw_register_read (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
312 if (ACPI_FAILURE (status)) {
313 return_ACPI_STATUS (status);
315 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Entering sleep state [S%d]\n", sleep_state));
317 /* Clear SLP_EN and SLP_TYP fields */
319 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask | sleep_enable_reg_info->access_bit_mask);
320 PM1Bcontrol = PM1Acontrol;
322 /* Insert SLP_TYP bits */
324 PM1Acontrol |= (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
325 PM1Bcontrol |= (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
328 * We split the writes of SLP_TYP and SLP_EN to workaround
329 * poorly implemented hardware.
332 /* Write #1: fill in SLP_TYP data */
334 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
335 if (ACPI_FAILURE (status)) {
336 return_ACPI_STATUS (status);
339 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
340 if (ACPI_FAILURE (status)) {
341 return_ACPI_STATUS (status);
344 /* Insert SLP_ENABLE bit */
346 PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
347 PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
349 /* Write #2: SLP_TYP + SLP_EN */
351 ACPI_FLUSH_CPU_CACHE ();
353 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
354 if (ACPI_FAILURE (status)) {
355 return_ACPI_STATUS (status);
358 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
359 if (ACPI_FAILURE (status)) {
360 return_ACPI_STATUS (status);
363 if (sleep_state > ACPI_STATE_S3) {
365 * We wanted to sleep > S3, but it didn't happen (by virtue of the fact that
366 * we are still executing!)
368 * Wait ten seconds, then try again. This is to get S4/S5 to work on all machines.
370 * We wait so long to allow chipsets that poll this reg very slowly to
371 * still read the right value. Ideally, this block would go
374 acpi_os_stall (10000000);
376 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL,
377 sleep_enable_reg_info->access_bit_mask);
378 if (ACPI_FAILURE (status)) {
379 return_ACPI_STATUS (status);
383 /* Wait until we enter sleep state */
386 status = acpi_get_register (ACPI_BITREG_WAKE_STATUS, &in_value, ACPI_MTX_DO_NOT_LOCK);
387 if (ACPI_FAILURE (status)) {
388 return_ACPI_STATUS (status);
391 /* Spin until we wake */
395 return_ACPI_STATUS (AE_OK);
397 EXPORT_SYMBOL(acpi_enter_sleep_state);
400 /******************************************************************************
402 * FUNCTION: acpi_enter_sleep_state_s4bios
408 * DESCRIPTION: Perform a S4 bios request.
409 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
411 ******************************************************************************/
413 acpi_status asmlinkage
414 acpi_enter_sleep_state_s4bios (
421 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state_s4bios");
424 status = acpi_set_register (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
425 if (ACPI_FAILURE (status)) {
426 return_ACPI_STATUS (status);
429 status = acpi_hw_clear_acpi_status (ACPI_MTX_DO_NOT_LOCK);
430 if (ACPI_FAILURE (status)) {
431 return_ACPI_STATUS (status);
435 * 1) Disable/Clear all GPEs
436 * 2) Enable all wakeup GPEs
438 status = acpi_hw_disable_all_gpes (ACPI_ISR);
439 if (ACPI_FAILURE (status)) {
440 return_ACPI_STATUS (status);
442 acpi_gbl_system_awake_and_running = FALSE;
444 status = acpi_hw_enable_all_wakeup_gpes (ACPI_ISR);
445 if (ACPI_FAILURE (status)) {
446 return_ACPI_STATUS (status);
449 ACPI_FLUSH_CPU_CACHE ();
451 status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd, (u32) acpi_gbl_FADT->S4bios_req, 8);
455 status = acpi_get_register (ACPI_BITREG_WAKE_STATUS, &in_value, ACPI_MTX_DO_NOT_LOCK);
456 if (ACPI_FAILURE (status)) {
457 return_ACPI_STATUS (status);
461 return_ACPI_STATUS (AE_OK);
463 EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios);
466 /******************************************************************************
468 * FUNCTION: acpi_leave_sleep_state
470 * PARAMETERS: sleep_state - Which sleep state we just exited
474 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
475 * Called with interrupts ENABLED.
477 ******************************************************************************/
480 acpi_leave_sleep_state (
483 struct acpi_object_list arg_list;
484 union acpi_object arg;
486 struct acpi_bit_register_info *sleep_type_reg_info;
487 struct acpi_bit_register_info *sleep_enable_reg_info;
492 ACPI_FUNCTION_TRACE ("acpi_leave_sleep_state");
496 * Set SLP_TYPE and SLP_EN to state S0.
497 * This is unclear from the ACPI Spec, but it is required
500 status = acpi_get_sleep_type_data (ACPI_STATE_S0,
501 &acpi_gbl_sleep_type_a, &acpi_gbl_sleep_type_b);
502 if (ACPI_SUCCESS (status)) {
503 sleep_type_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_TYPE_A);
504 sleep_enable_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_ENABLE);
506 /* Get current value of PM1A control */
508 status = acpi_hw_register_read (ACPI_MTX_DO_NOT_LOCK,
509 ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
510 if (ACPI_SUCCESS (status)) {
511 /* Clear SLP_EN and SLP_TYP fields */
513 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
514 sleep_enable_reg_info->access_bit_mask);
515 PM1Bcontrol = PM1Acontrol;
517 /* Insert SLP_TYP bits */
519 PM1Acontrol |= (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
520 PM1Bcontrol |= (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
522 /* Just ignore any errors */
524 (void) acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
525 ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
526 (void) acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
527 ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
531 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
533 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
535 /* Setup parameter object */
538 arg_list.pointer = &arg;
539 arg.type = ACPI_TYPE_INTEGER;
541 /* Ignore any errors from these methods */
543 arg.integer.value = ACPI_SST_WAKING;
544 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
545 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
546 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", acpi_format_exception (status)));
549 arg.integer.value = sleep_state;
550 status = acpi_evaluate_object (NULL, METHOD_NAME__BFS, &arg_list, NULL);
551 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
552 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", acpi_format_exception (status)));
555 status = acpi_evaluate_object (NULL, METHOD_NAME__WAK, &arg_list, NULL);
556 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
557 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", acpi_format_exception (status)));
559 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
563 * 1) Disable/Clear all GPEs
564 * 2) Enable all runtime GPEs
566 status = acpi_hw_disable_all_gpes (ACPI_NOT_ISR);
567 if (ACPI_FAILURE (status)) {
568 return_ACPI_STATUS (status);
570 acpi_gbl_system_awake_and_running = TRUE;
572 status = acpi_hw_enable_all_runtime_gpes (ACPI_NOT_ISR);
573 if (ACPI_FAILURE (status)) {
574 return_ACPI_STATUS (status);
577 /* Enable power button */
579 (void) acpi_set_register(acpi_gbl_fixed_event_info[ACPI_EVENT_POWER_BUTTON].enable_register_id,
580 1, ACPI_MTX_DO_NOT_LOCK);
581 (void) acpi_set_register(acpi_gbl_fixed_event_info[ACPI_EVENT_POWER_BUTTON].status_register_id,
582 1, ACPI_MTX_DO_NOT_LOCK);
584 /* Enable BM arbitration */
586 status = acpi_set_register (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_LOCK);
587 if (ACPI_FAILURE (status)) {
588 return_ACPI_STATUS (status);
591 arg.integer.value = ACPI_SST_WORKING;
592 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
593 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
594 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", acpi_format_exception (status)));
597 return_ACPI_STATUS (status);