2 /******************************************************************************
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2005, 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>
46 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_HARDWARE
49 ACPI_MODULE_NAME ("hwsleep")
52 /*******************************************************************************
54 * FUNCTION: acpi_set_firmware_waking_vector
56 * PARAMETERS: physical_address - Physical address of ACPI real mode
61 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
63 ******************************************************************************/
66 acpi_set_firmware_waking_vector (
67 acpi_physical_address physical_address)
70 ACPI_FUNCTION_TRACE ("acpi_set_firmware_waking_vector");
75 if (acpi_gbl_common_fACS.vector_width == 32) {
76 *(ACPI_CAST_PTR (u32, acpi_gbl_common_fACS.firmware_waking_vector))
77 = (u32) physical_address;
80 *acpi_gbl_common_fACS.firmware_waking_vector
84 return_ACPI_STATUS (AE_OK);
88 /*******************************************************************************
90 * FUNCTION: acpi_get_firmware_waking_vector
92 * PARAMETERS: *physical_address - Where the contents of
93 * the firmware_waking_vector field of
94 * the FACS will be returned.
96 * RETURN: Status, vector
98 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
100 ******************************************************************************/
102 #ifdef ACPI_FUTURE_USAGE
104 acpi_get_firmware_waking_vector (
105 acpi_physical_address *physical_address)
108 ACPI_FUNCTION_TRACE ("acpi_get_firmware_waking_vector");
111 if (!physical_address) {
112 return_ACPI_STATUS (AE_BAD_PARAMETER);
117 if (acpi_gbl_common_fACS.vector_width == 32) {
118 *physical_address = (acpi_physical_address)
119 *(ACPI_CAST_PTR (u32, acpi_gbl_common_fACS.firmware_waking_vector));
123 *acpi_gbl_common_fACS.firmware_waking_vector;
126 return_ACPI_STATUS (AE_OK);
131 /*******************************************************************************
133 * FUNCTION: acpi_enter_sleep_state_prep
135 * PARAMETERS: sleep_state - Which sleep state to enter
139 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
140 * This function must execute with interrupts enabled.
141 * We break sleeping into 2 stages so that OSPM can handle
142 * various OS-specific tasks between the two steps.
144 ******************************************************************************/
147 acpi_enter_sleep_state_prep (
151 struct acpi_object_list arg_list;
152 union acpi_object arg;
155 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state_prep");
159 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
161 status = acpi_get_sleep_type_data (sleep_state,
162 &acpi_gbl_sleep_type_a, &acpi_gbl_sleep_type_b);
163 if (ACPI_FAILURE (status)) {
164 return_ACPI_STATUS (status);
167 /* Setup parameter object */
170 arg_list.pointer = &arg;
172 arg.type = ACPI_TYPE_INTEGER;
173 arg.integer.value = sleep_state;
175 /* Run the _PTS and _GTS methods */
177 status = acpi_evaluate_object (NULL, METHOD_NAME__PTS, &arg_list, NULL);
178 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
179 return_ACPI_STATUS (status);
182 status = acpi_evaluate_object (NULL, METHOD_NAME__GTS, &arg_list, NULL);
183 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
184 return_ACPI_STATUS (status);
187 /* Setup the argument to _SST */
189 switch (sleep_state) {
191 arg.integer.value = ACPI_SST_WORKING;
197 arg.integer.value = ACPI_SST_SLEEPING;
201 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
205 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
209 /* Set the system indicators to show the desired sleep state. */
211 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
212 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
213 ACPI_REPORT_ERROR (("Method _SST failed, %s\n",
214 acpi_format_exception (status)));
217 return_ACPI_STATUS (AE_OK);
221 /*******************************************************************************
223 * FUNCTION: acpi_enter_sleep_state
225 * PARAMETERS: sleep_state - Which sleep state to enter
229 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
230 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
232 ******************************************************************************/
234 acpi_status asmlinkage
235 acpi_enter_sleep_state (
240 struct acpi_bit_register_info *sleep_type_reg_info;
241 struct acpi_bit_register_info *sleep_enable_reg_info;
246 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state");
249 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
250 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
251 ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n",
252 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
253 return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
256 sleep_type_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_TYPE_A);
257 sleep_enable_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_ENABLE);
259 /* Clear wake status */
261 status = acpi_set_register (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
262 if (ACPI_FAILURE (status)) {
263 return_ACPI_STATUS (status);
266 /* Clear all fixed and general purpose status bits */
268 status = acpi_hw_clear_acpi_status (ACPI_MTX_DO_NOT_LOCK);
269 if (ACPI_FAILURE (status)) {
270 return_ACPI_STATUS (status);
274 * 1) Disable/Clear all GPEs
275 * 2) Enable all wakeup GPEs
277 status = acpi_hw_disable_all_gpes (ACPI_ISR);
278 if (ACPI_FAILURE (status)) {
279 return_ACPI_STATUS (status);
281 acpi_gbl_system_awake_and_running = FALSE;
283 status = acpi_hw_enable_all_wakeup_gpes (ACPI_ISR);
284 if (ACPI_FAILURE (status)) {
285 return_ACPI_STATUS (status);
288 /* Get current value of PM1A control */
290 status = acpi_hw_register_read (ACPI_MTX_DO_NOT_LOCK,
291 ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
292 if (ACPI_FAILURE (status)) {
293 return_ACPI_STATUS (status);
295 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
296 "Entering sleep state [S%d]\n", sleep_state));
298 /* Clear SLP_EN and SLP_TYP fields */
300 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
301 sleep_enable_reg_info->access_bit_mask);
302 PM1Bcontrol = PM1Acontrol;
304 /* Insert SLP_TYP bits */
306 PM1Acontrol |= (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
307 PM1Bcontrol |= (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
310 * We split the writes of SLP_TYP and SLP_EN to workaround
311 * poorly implemented hardware.
314 /* Write #1: fill in SLP_TYP data */
316 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
317 ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
318 if (ACPI_FAILURE (status)) {
319 return_ACPI_STATUS (status);
322 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
323 ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
324 if (ACPI_FAILURE (status)) {
325 return_ACPI_STATUS (status);
328 /* Insert SLP_ENABLE bit */
330 PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
331 PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
333 /* Write #2: SLP_TYP + SLP_EN */
335 ACPI_FLUSH_CPU_CACHE ();
337 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
338 ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
339 if (ACPI_FAILURE (status)) {
340 return_ACPI_STATUS (status);
343 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
344 ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
345 if (ACPI_FAILURE (status)) {
346 return_ACPI_STATUS (status);
349 if (sleep_state > ACPI_STATE_S3) {
351 * We wanted to sleep > S3, but it didn't happen (by virtue of the
352 * fact that we are still executing!)
354 * Wait ten seconds, then try again. This is to get S4/S5 to work on
357 * We wait so long to allow chipsets that poll this reg very slowly to
358 * still read the right value. Ideally, this block would go
361 acpi_os_stall (10000000);
363 status = acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
364 ACPI_REGISTER_PM1_CONTROL,
365 sleep_enable_reg_info->access_bit_mask);
366 if (ACPI_FAILURE (status)) {
367 return_ACPI_STATUS (status);
371 /* Wait until we enter sleep state */
374 status = acpi_get_register (ACPI_BITREG_WAKE_STATUS, &in_value,
375 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);
386 EXPORT_SYMBOL(acpi_enter_sleep_state);
389 /*******************************************************************************
391 * FUNCTION: acpi_enter_sleep_state_s4bios
397 * DESCRIPTION: Perform a S4 bios request.
398 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
400 ******************************************************************************/
402 acpi_status asmlinkage
403 acpi_enter_sleep_state_s4bios (
410 ACPI_FUNCTION_TRACE ("acpi_enter_sleep_state_s4bios");
413 status = acpi_set_register (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK);
414 if (ACPI_FAILURE (status)) {
415 return_ACPI_STATUS (status);
418 status = acpi_hw_clear_acpi_status (ACPI_MTX_DO_NOT_LOCK);
419 if (ACPI_FAILURE (status)) {
420 return_ACPI_STATUS (status);
424 * 1) Disable/Clear all GPEs
425 * 2) Enable all wakeup GPEs
427 status = acpi_hw_disable_all_gpes (ACPI_ISR);
428 if (ACPI_FAILURE (status)) {
429 return_ACPI_STATUS (status);
431 acpi_gbl_system_awake_and_running = FALSE;
433 status = acpi_hw_enable_all_wakeup_gpes (ACPI_ISR);
434 if (ACPI_FAILURE (status)) {
435 return_ACPI_STATUS (status);
438 ACPI_FLUSH_CPU_CACHE ();
440 status = acpi_os_write_port (acpi_gbl_FADT->smi_cmd,
441 (u32) acpi_gbl_FADT->S4bios_req, 8);
445 status = acpi_get_register (ACPI_BITREG_WAKE_STATUS, &in_value,
446 ACPI_MTX_DO_NOT_LOCK);
447 if (ACPI_FAILURE (status)) {
448 return_ACPI_STATUS (status);
452 return_ACPI_STATUS (AE_OK);
454 EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios);
457 /*******************************************************************************
459 * FUNCTION: acpi_leave_sleep_state
461 * PARAMETERS: sleep_state - Which sleep state we just exited
465 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
466 * Called with interrupts ENABLED.
468 ******************************************************************************/
471 acpi_leave_sleep_state (
474 struct acpi_object_list arg_list;
475 union acpi_object arg;
477 struct acpi_bit_register_info *sleep_type_reg_info;
478 struct acpi_bit_register_info *sleep_enable_reg_info;
483 ACPI_FUNCTION_TRACE ("acpi_leave_sleep_state");
487 * Set SLP_TYPE and SLP_EN to state S0.
488 * This is unclear from the ACPI Spec, but it is required
491 status = acpi_get_sleep_type_data (ACPI_STATE_S0,
492 &acpi_gbl_sleep_type_a, &acpi_gbl_sleep_type_b);
493 if (ACPI_SUCCESS (status)) {
494 sleep_type_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_TYPE_A);
495 sleep_enable_reg_info = acpi_hw_get_bit_register_info (ACPI_BITREG_SLEEP_ENABLE);
497 /* Get current value of PM1A control */
499 status = acpi_hw_register_read (ACPI_MTX_DO_NOT_LOCK,
500 ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
501 if (ACPI_SUCCESS (status)) {
502 /* Clear SLP_EN and SLP_TYP fields */
504 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
505 sleep_enable_reg_info->access_bit_mask);
506 PM1Bcontrol = PM1Acontrol;
508 /* Insert SLP_TYP bits */
510 PM1Acontrol |= (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
511 PM1Bcontrol |= (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
513 /* Just ignore any errors */
515 (void) acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
516 ACPI_REGISTER_PM1A_CONTROL, PM1Acontrol);
517 (void) acpi_hw_register_write (ACPI_MTX_DO_NOT_LOCK,
518 ACPI_REGISTER_PM1B_CONTROL, PM1Bcontrol);
522 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
524 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
526 /* Setup parameter object */
529 arg_list.pointer = &arg;
530 arg.type = ACPI_TYPE_INTEGER;
532 /* Ignore any errors from these methods */
534 arg.integer.value = ACPI_SST_WAKING;
535 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
536 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
537 ACPI_REPORT_ERROR (("Method _SST failed, %s\n",
538 acpi_format_exception (status)));
541 arg.integer.value = sleep_state;
542 status = acpi_evaluate_object (NULL, METHOD_NAME__BFS, &arg_list, NULL);
543 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
544 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n",
545 acpi_format_exception (status)));
548 status = acpi_evaluate_object (NULL, METHOD_NAME__WAK, &arg_list, NULL);
549 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
550 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n",
551 acpi_format_exception (status)));
553 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
557 * 1) Disable/Clear all GPEs
558 * 2) Enable all runtime GPEs
560 status = acpi_hw_disable_all_gpes (ACPI_NOT_ISR);
561 if (ACPI_FAILURE (status)) {
562 return_ACPI_STATUS (status);
564 acpi_gbl_system_awake_and_running = TRUE;
566 status = acpi_hw_enable_all_runtime_gpes (ACPI_NOT_ISR);
567 if (ACPI_FAILURE (status)) {
568 return_ACPI_STATUS (status);
571 /* Enable power button */
573 (void) acpi_set_register(
574 acpi_gbl_fixed_event_info[ACPI_EVENT_POWER_BUTTON].enable_register_id,
575 1, ACPI_MTX_DO_NOT_LOCK);
577 (void) acpi_set_register(
578 acpi_gbl_fixed_event_info[ACPI_EVENT_POWER_BUTTON].status_register_id,
579 1, ACPI_MTX_DO_NOT_LOCK);
581 arg.integer.value = ACPI_SST_WORKING;
582 status = acpi_evaluate_object (NULL, METHOD_NAME__SST, &arg_list, NULL);
583 if (ACPI_FAILURE (status) && status != AE_NOT_FOUND) {
584 ACPI_REPORT_ERROR (("Method _SST failed, %s\n",
585 acpi_format_exception (status)));
588 return_ACPI_STATUS (status);