blob: 2ac28bbe8827822f975755b3b7dd7cabab0882a3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2/******************************************************************************
3 *
4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface
5 *
6 *****************************************************************************/
7
8/*
Bob Mooreb4e104e2011-01-17 11:05:40 +08009 * Copyright (C) 2000 - 2011, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
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.
26 *
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.
30 *
31 * NO WARRANTY
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.
43 */
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050046#include "accommon.h"
47#include "actables.h"
Shane Wang69575d32009-09-01 18:25:07 -070048#include <linux/tboot.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50#define _COMPONENT ACPI_HARDWARE
Len Brown4be44fc2005-08-05 00:44:28 -040051ACPI_MODULE_NAME("hwsleep")
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Robert Moore44f6c012005-04-18 22:49:35 -040053/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 *
55 * FUNCTION: acpi_set_firmware_waking_vector
56 *
Bob Moored85988f2008-11-12 14:54:05 +080057 * PARAMETERS: physical_address - 32-bit physical address of ACPI real mode
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 * entry point.
59 *
60 * RETURN: Status
61 *
Bob Moored85988f2008-11-12 14:54:05 +080062 * DESCRIPTION: Sets the 32-bit firmware_waking_vector field of the FACS
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 *
64 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -070065acpi_status
Bob Moored85988f2008-11-12 14:54:05 +080066acpi_set_firmware_waking_vector(u32 physical_address)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067{
Bob Mooreb229cf92006-04-21 17:15:00 -040068 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Bob Mooref3d2e782007-02-02 19:48:18 +030070
Rafael J. Wysockia6629102008-09-06 13:13:01 +020071 /*
72 * According to the ACPI specification 2.0c and later, the 64-bit
73 * waking vector should be cleared and the 32-bit waking vector should
74 * be used, unless we want the wake-up code to be called by the BIOS in
75 * Protected Mode. Some systems (for example HP dv5-1004nr) are known
76 * to fail to resume if the 64-bit vector is used.
77 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Bob Moored85988f2008-11-12 14:54:05 +080079 /* Set the 32-bit vector */
80
Bob Moore009c4cbe2008-11-12 15:34:52 +080081 acpi_gbl_FACS->firmware_waking_vector = physical_address;
Bob Moored85988f2008-11-12 14:54:05 +080082
83 /* Clear the 64-bit vector if it exists */
84
Bob Moore009c4cbe2008-11-12 15:34:52 +080085 if ((acpi_gbl_FACS->length > 32) && (acpi_gbl_FACS->version >= 1)) {
86 acpi_gbl_FACS->xfirmware_waking_vector = 0;
Bob Moored85988f2008-11-12 14:54:05 +080087 }
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Len Brown4be44fc2005-08-05 00:44:28 -040089 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090}
91
Bob Moore83135242006-10-03 00:00:00 -040092ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
93
Bob Moore4f70e372009-02-18 14:52:43 +080094#if ACPI_MACHINE_WIDTH == 64
Robert Moore44f6c012005-04-18 22:49:35 -040095/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 *
Bob Moored85988f2008-11-12 14:54:05 +080097 * FUNCTION: acpi_set_firmware_waking_vector64
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 *
Bob Moored85988f2008-11-12 14:54:05 +080099 * PARAMETERS: physical_address - 64-bit physical address of ACPI protected
100 * mode entry point.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 *
Bob Moored85988f2008-11-12 14:54:05 +0800102 * RETURN: Status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 *
Bob Moored85988f2008-11-12 14:54:05 +0800104 * DESCRIPTION: Sets the 64-bit X_firmware_waking_vector field of the FACS, if
Bob Moore4f70e372009-02-18 14:52:43 +0800105 * it exists in the table. This function is intended for use with
106 * 64-bit host operating systems.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 *
108 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109acpi_status
Bob Moored85988f2008-11-12 14:54:05 +0800110acpi_set_firmware_waking_vector64(u64 physical_address)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
Bob Moored85988f2008-11-12 14:54:05 +0800112 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector64);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
Bob Moored85988f2008-11-12 14:54:05 +0800115 /* Determine if the 64-bit vector actually exists */
116
Bob Moore009c4cbe2008-11-12 15:34:52 +0800117 if ((acpi_gbl_FACS->length <= 32) || (acpi_gbl_FACS->version < 1)) {
Bob Moored85988f2008-11-12 14:54:05 +0800118 return_ACPI_STATUS(AE_NOT_EXIST);
119 }
120
121 /* Clear 32-bit vector, set the 64-bit X_ vector */
122
Bob Moore009c4cbe2008-11-12 15:34:52 +0800123 acpi_gbl_FACS->firmware_waking_vector = 0;
124 acpi_gbl_FACS->xfirmware_waking_vector = physical_address;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Len Brown4be44fc2005-08-05 00:44:28 -0400126 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127}
Bob Moore83135242006-10-03 00:00:00 -0400128
Bob Moored85988f2008-11-12 14:54:05 +0800129ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector64)
Bob Moore4f70e372009-02-18 14:52:43 +0800130#endif
Bob Moored85988f2008-11-12 14:54:05 +0800131
Robert Moore44f6c012005-04-18 22:49:35 -0400132/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 *
134 * FUNCTION: acpi_enter_sleep_state_prep
135 *
136 * PARAMETERS: sleep_state - Which sleep state to enter
137 *
138 * RETURN: Status
139 *
140 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231)
141 * This function must execute with interrupts enabled.
142 * We break sleeping into 2 stages so that OSPM can handle
143 * various OS-specific tasks between the two steps.
144 *
145 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400146acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
Len Brown4be44fc2005-08-05 00:44:28 -0400148 acpi_status status;
149 struct acpi_object_list arg_list;
150 union acpi_object arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151
Bob Mooreb229cf92006-04-21 17:15:00 -0400152 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Bob Moore32c9ef92009-02-18 14:36:05 +0800154 /* _PSW methods could be run here to enable wake-on keyboard, LAN, etc. */
155
Len Brown4be44fc2005-08-05 00:44:28 -0400156 status = acpi_get_sleep_type_data(sleep_state,
157 &acpi_gbl_sleep_type_a,
158 &acpi_gbl_sleep_type_b);
159 if (ACPI_FAILURE(status)) {
160 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 }
162
163 /* Setup parameter object */
164
165 arg_list.count = 1;
166 arg_list.pointer = &arg;
167
168 arg.type = ACPI_TYPE_INTEGER;
169 arg.integer.value = sleep_state;
170
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100171 /* Run the _PTS method */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Len Brown4be44fc2005-08-05 00:44:28 -0400173 status = acpi_evaluate_object(NULL, METHOD_NAME__PTS, &arg_list, NULL);
174 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
175 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 }
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 /* Setup the argument to _SST */
179
180 switch (sleep_state) {
181 case ACPI_STATE_S0:
182 arg.integer.value = ACPI_SST_WORKING;
183 break;
184
185 case ACPI_STATE_S1:
186 case ACPI_STATE_S2:
187 case ACPI_STATE_S3:
188 arg.integer.value = ACPI_SST_SLEEPING;
189 break;
190
191 case ACPI_STATE_S4:
192 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
193 break;
194
195 default:
Len Brown4be44fc2005-08-05 00:44:28 -0400196 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 break;
198 }
199
Bob Moored52c79a2008-06-10 14:26:57 +0800200 /*
201 * Set the system indicators to show the desired sleep state.
202 * _SST is an optional method (return no error if not found)
203 */
Len Brown4be44fc2005-08-05 00:44:28 -0400204 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
205 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500206 ACPI_EXCEPTION((AE_INFO, status,
207 "While executing method _SST"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 }
209
Bob Moored52c79a2008-06-10 14:26:57 +0800210 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211}
212
Bob Moore83135242006-10-03 00:00:00 -0400213ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
214
Len Brown96f15ef2009-04-17 23:32:20 -0400215static unsigned int gts, bfs;
216module_param(gts, uint, 0644);
217module_param(bfs, uint, 0644);
218MODULE_PARM_DESC(gts, "Enable evaluation of _GTS on suspend.");
219MODULE_PARM_DESC(bfs, "Enable evaluation of _BFS on resume".);
220
Robert Moore44f6c012005-04-18 22:49:35 -0400221/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 *
223 * FUNCTION: acpi_enter_sleep_state
224 *
225 * PARAMETERS: sleep_state - Which sleep state to enter
226 *
227 * RETURN: Status
228 *
229 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
230 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
231 *
232 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400233acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
Bob Moore32c9ef92009-02-18 14:36:05 +0800235 u32 pm1a_control;
236 u32 pm1b_control;
Len Brown4be44fc2005-08-05 00:44:28 -0400237 struct acpi_bit_register_info *sleep_type_reg_info;
238 struct acpi_bit_register_info *sleep_enable_reg_info;
239 u32 in_value;
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100240 struct acpi_object_list arg_list;
241 union acpi_object arg;
Len Brown4be44fc2005-08-05 00:44:28 -0400242 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Bob Mooreb229cf92006-04-21 17:15:00 -0400244 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
Len Brown4be44fc2005-08-05 00:44:28 -0400247 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
Bob Mooref6a22b02010-03-05 17:56:40 +0800248 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500249 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
Len Brown4be44fc2005-08-05 00:44:28 -0400250 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 }
252
Len Brown4be44fc2005-08-05 00:44:28 -0400253 sleep_type_reg_info =
Bob Moore82d79b82009-02-18 14:31:05 +0800254 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
Len Brown4be44fc2005-08-05 00:44:28 -0400255 sleep_enable_reg_info =
256 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258 /* Clear wake status */
259
Bob Moore768aaaf2009-03-06 09:49:25 +0800260 status =
261 acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
Len Brown4be44fc2005-08-05 00:44:28 -0400262 if (ACPI_FAILURE(status)) {
263 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
265
266 /* Clear all fixed and general purpose status bits */
267
Bob Moored8c71b62007-02-02 19:48:21 +0300268 status = acpi_hw_clear_acpi_status();
Len Brown4be44fc2005-08-05 00:44:28 -0400269 if (ACPI_FAILURE(status)) {
270 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 }
272
273 /*
Pavel Machek23b168d2008-02-05 19:27:12 +0100274 * 1) Disable/Clear all GPEs
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 * 2) Enable all wakeup GPEs
276 */
Alexey Starikovskiy1d999672007-03-12 14:49:26 -0400277 status = acpi_hw_disable_all_gpes();
278 if (ACPI_FAILURE(status)) {
279 return_ACPI_STATUS(status);
280 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 acpi_gbl_system_awake_and_running = FALSE;
282
Len Brown4be44fc2005-08-05 00:44:28 -0400283 status = acpi_hw_enable_all_wakeup_gpes();
284 if (ACPI_FAILURE(status)) {
285 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 }
287
Len Brown96f15ef2009-04-17 23:32:20 -0400288 if (gts) {
289 /* Execute the _GTS method */
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100290
Len Brown96f15ef2009-04-17 23:32:20 -0400291 arg_list.count = 1;
292 arg_list.pointer = &arg;
293 arg.type = ACPI_TYPE_INTEGER;
294 arg.integer.value = sleep_state;
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100295
Len Brown96f15ef2009-04-17 23:32:20 -0400296 status = acpi_evaluate_object(NULL, METHOD_NAME__GTS, &arg_list, NULL);
297 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
298 return_ACPI_STATUS(status);
299 }
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100300 }
301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 /* Get current value of PM1A control */
303
Bob Moore32c9ef92009-02-18 14:36:05 +0800304 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
305 &pm1a_control);
Len Brown4be44fc2005-08-05 00:44:28 -0400306 if (ACPI_FAILURE(status)) {
307 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 }
Len Brown4be44fc2005-08-05 00:44:28 -0400309 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
Bob Mooreb27d6592010-05-26 11:47:13 +0800310 "Entering sleep state [S%u]\n", sleep_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Bob Moore32c9ef92009-02-18 14:36:05 +0800312 /* Clear the SLP_EN and SLP_TYP fields */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Bob Moore32c9ef92009-02-18 14:36:05 +0800314 pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
315 sleep_enable_reg_info->access_bit_mask);
316 pm1b_control = pm1a_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Bob Moore32c9ef92009-02-18 14:36:05 +0800318 /* Insert the SLP_TYP bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
Bob Moore32c9ef92009-02-18 14:36:05 +0800320 pm1a_control |=
Len Brown4be44fc2005-08-05 00:44:28 -0400321 (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
Bob Moore32c9ef92009-02-18 14:36:05 +0800322 pm1b_control |=
Len Brown4be44fc2005-08-05 00:44:28 -0400323 (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325 /*
326 * We split the writes of SLP_TYP and SLP_EN to workaround
327 * poorly implemented hardware.
328 */
329
Bob Moore32c9ef92009-02-18 14:36:05 +0800330 /* Write #1: write the SLP_TYP data to the PM1 Control registers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Bob Moore32c9ef92009-02-18 14:36:05 +0800332 status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
Len Brown4be44fc2005-08-05 00:44:28 -0400333 if (ACPI_FAILURE(status)) {
334 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 }
336
Bob Moore32c9ef92009-02-18 14:36:05 +0800337 /* Insert the sleep enable (SLP_EN) bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
Bob Moore32c9ef92009-02-18 14:36:05 +0800339 pm1a_control |= sleep_enable_reg_info->access_bit_mask;
340 pm1b_control |= sleep_enable_reg_info->access_bit_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
Bob Moore32c9ef92009-02-18 14:36:05 +0800342 /* Flush caches, as per ACPI specification */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Len Brown4be44fc2005-08-05 00:44:28 -0400344 ACPI_FLUSH_CPU_CACHE();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Joseph Cihula86886e52009-06-30 19:31:07 -0700346 tboot_sleep(sleep_state, pm1a_control, pm1b_control);
347
Bob Moore32c9ef92009-02-18 14:36:05 +0800348 /* Write #2: Write both SLP_TYP + SLP_EN */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Bob Moore32c9ef92009-02-18 14:36:05 +0800350 status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
Len Brown4be44fc2005-08-05 00:44:28 -0400351 if (ACPI_FAILURE(status)) {
352 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 }
354
355 if (sleep_state > ACPI_STATE_S3) {
356 /*
Robert Moore44f6c012005-04-18 22:49:35 -0400357 * We wanted to sleep > S3, but it didn't happen (by virtue of the
358 * fact that we are still executing!)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 *
Robert Moore44f6c012005-04-18 22:49:35 -0400360 * Wait ten seconds, then try again. This is to get S4/S5 to work on
361 * all machines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 *
Bob Moored4913dc2009-03-06 10:05:18 +0800363 * We wait so long to allow chipsets that poll this reg very slowly
364 * to still read the right value. Ideally, this block would go
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 * away entirely.
366 */
Len Brown4be44fc2005-08-05 00:44:28 -0400367 acpi_os_stall(10000000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400369 status = acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL,
Len Brown4be44fc2005-08-05 00:44:28 -0400370 sleep_enable_reg_info->
371 access_bit_mask);
372 if (ACPI_FAILURE(status)) {
373 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 }
375 }
376
377 /* Wait until we enter sleep state */
378
379 do {
Bob Moore50ffba12009-02-23 15:02:07 +0800380 status = acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS,
Alexey Starikovskiy2d571b32007-09-30 22:39:42 +0400381 &in_value);
Len Brown4be44fc2005-08-05 00:44:28 -0400382 if (ACPI_FAILURE(status)) {
383 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 }
385
386 /* Spin until we wake */
387
388 } while (!in_value);
389
Len Brown4be44fc2005-08-05 00:44:28 -0400390 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Bob Moore83135242006-10-03 00:00:00 -0400393ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
Robert Moore44f6c012005-04-18 22:49:35 -0400395/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 *
397 * FUNCTION: acpi_enter_sleep_state_s4bios
398 *
399 * PARAMETERS: None
400 *
401 * RETURN: Status
402 *
403 * DESCRIPTION: Perform a S4 bios request.
404 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
405 *
406 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400407acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
Len Brown4be44fc2005-08-05 00:44:28 -0400409 u32 in_value;
410 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Bob Mooreb229cf92006-04-21 17:15:00 -0400412 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Bob Moore768aaaf2009-03-06 09:49:25 +0800414 /* Clear the wake status bit (PM1) */
415
416 status =
417 acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
Len Brown4be44fc2005-08-05 00:44:28 -0400418 if (ACPI_FAILURE(status)) {
419 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
421
Bob Moored8c71b62007-02-02 19:48:21 +0300422 status = acpi_hw_clear_acpi_status();
Len Brown4be44fc2005-08-05 00:44:28 -0400423 if (ACPI_FAILURE(status)) {
424 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
426
427 /*
428 * 1) Disable/Clear all GPEs
429 * 2) Enable all wakeup GPEs
430 */
Len Brown4be44fc2005-08-05 00:44:28 -0400431 status = acpi_hw_disable_all_gpes();
432 if (ACPI_FAILURE(status)) {
433 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 }
435 acpi_gbl_system_awake_and_running = FALSE;
436
Len Brown4be44fc2005-08-05 00:44:28 -0400437 status = acpi_hw_enable_all_wakeup_gpes();
438 if (ACPI_FAILURE(status)) {
439 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 }
441
Len Brown4be44fc2005-08-05 00:44:28 -0400442 ACPI_FLUSH_CPU_CACHE();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Bob Moore7f071902009-03-19 09:37:47 +0800444 status = acpi_hw_write_port(acpi_gbl_FADT.smi_command,
Bob Mooref3d2e782007-02-02 19:48:18 +0300445 (u32) acpi_gbl_FADT.S4bios_request, 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447 do {
448 acpi_os_stall(1000);
Bob Moore50ffba12009-02-23 15:02:07 +0800449 status =
450 acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
Len Brown4be44fc2005-08-05 00:44:28 -0400451 if (ACPI_FAILURE(status)) {
452 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 }
454 } while (!in_value);
455
Len Brown4be44fc2005-08-05 00:44:28 -0400456 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Bob Moore83135242006-10-03 00:00:00 -0400459ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
Robert Moore44f6c012005-04-18 22:49:35 -0400461/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 *
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100463 * FUNCTION: acpi_leave_sleep_state_prep
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 *
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100465 * PARAMETERS: sleep_state - Which sleep state we are exiting
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 *
467 * RETURN: Status
468 *
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100469 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
470 * sleep.
471 * Called with interrupts DISABLED.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 *
473 ******************************************************************************/
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100474acpi_status acpi_leave_sleep_state_prep(u8 sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475{
Len Brown4be44fc2005-08-05 00:44:28 -0400476 struct acpi_object_list arg_list;
477 union acpi_object arg;
478 acpi_status status;
479 struct acpi_bit_register_info *sleep_type_reg_info;
480 struct acpi_bit_register_info *sleep_enable_reg_info;
Bob Moore32c9ef92009-02-18 14:36:05 +0800481 u32 pm1a_control;
482 u32 pm1b_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100484 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state_prep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486 /*
487 * Set SLP_TYPE and SLP_EN to state S0.
488 * This is unclear from the ACPI Spec, but it is required
489 * by some machines.
490 */
Len Brown4be44fc2005-08-05 00:44:28 -0400491 status = acpi_get_sleep_type_data(ACPI_STATE_S0,
492 &acpi_gbl_sleep_type_a,
493 &acpi_gbl_sleep_type_b);
494 if (ACPI_SUCCESS(status)) {
495 sleep_type_reg_info =
Bob Moore82d79b82009-02-18 14:31:05 +0800496 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
Len Brown4be44fc2005-08-05 00:44:28 -0400497 sleep_enable_reg_info =
498 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500 /* Get current value of PM1A control */
501
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400502 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
Bob Moore32c9ef92009-02-18 14:36:05 +0800503 &pm1a_control);
Len Brown4be44fc2005-08-05 00:44:28 -0400504 if (ACPI_SUCCESS(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400505
Bob Moore32c9ef92009-02-18 14:36:05 +0800506 /* Clear the SLP_EN and SLP_TYP fields */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Bob Moore32c9ef92009-02-18 14:36:05 +0800508 pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
509 sleep_enable_reg_info->
510 access_bit_mask);
511 pm1b_control = pm1a_control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Bob Moore32c9ef92009-02-18 14:36:05 +0800513 /* Insert the SLP_TYP bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Bob Moored4913dc2009-03-06 10:05:18 +0800515 pm1a_control |= (acpi_gbl_sleep_type_a <<
516 sleep_type_reg_info->bit_position);
517 pm1b_control |= (acpi_gbl_sleep_type_b <<
518 sleep_type_reg_info->bit_position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Bob Moore32c9ef92009-02-18 14:36:05 +0800520 /* Write the control registers and ignore any errors */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
Bob Moore32c9ef92009-02-18 14:36:05 +0800522 (void)acpi_hw_write_pm1_control(pm1a_control,
523 pm1b_control);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 }
525 }
526
Len Brown96f15ef2009-04-17 23:32:20 -0400527 if (bfs) {
528 /* Execute the _BFS method */
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100529
Len Brown96f15ef2009-04-17 23:32:20 -0400530 arg_list.count = 1;
531 arg_list.pointer = &arg;
532 arg.type = ACPI_TYPE_INTEGER;
533 arg.integer.value = sleep_state;
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100534
Len Brown96f15ef2009-04-17 23:32:20 -0400535 status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
536 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
537 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
538 }
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100539 }
Rafael J. Wysockic95d47a2008-01-08 00:05:21 +0100540 return_ACPI_STATUS(status);
541}
542
543/*******************************************************************************
544 *
545 * FUNCTION: acpi_leave_sleep_state
546 *
547 * PARAMETERS: sleep_state - Which sleep state we just exited
548 *
549 * RETURN: Status
550 *
551 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
552 * Called with interrupts ENABLED.
553 *
554 ******************************************************************************/
555acpi_status acpi_leave_sleep_state(u8 sleep_state)
556{
557 struct acpi_object_list arg_list;
558 union acpi_object arg;
559 acpi_status status;
560
561 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
564
565 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
566
567 /* Setup parameter object */
568
569 arg_list.count = 1;
570 arg_list.pointer = &arg;
571 arg.type = ACPI_TYPE_INTEGER;
572
573 /* Ignore any errors from these methods */
574
575 arg.integer.value = ACPI_SST_WAKING;
Len Brown4be44fc2005-08-05 00:44:28 -0400576 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
577 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500578 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 /*
Thomas Renninger79d2dfa2007-08-24 01:24:47 -0400582 * GPEs must be enabled before _WAK is called as GPEs
583 * might get fired there
584 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 * Restore the GPEs:
586 * 1) Disable/Clear all GPEs
587 * 2) Enable all runtime GPEs
588 */
Len Brown4be44fc2005-08-05 00:44:28 -0400589 status = acpi_hw_disable_all_gpes();
590 if (ACPI_FAILURE(status)) {
591 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 }
Len Brown4be44fc2005-08-05 00:44:28 -0400593 status = acpi_hw_enable_all_runtime_gpes();
594 if (ACPI_FAILURE(status)) {
595 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 }
597
Rafael J. Wysocki314ccd62008-02-13 00:32:16 +0100598 arg.integer.value = sleep_state;
Thomas Renninger79d2dfa2007-08-24 01:24:47 -0400599 status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
600 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
601 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
602 }
603 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
604
Matthew Garretta68823e2008-08-06 19:12:04 +0100605 /*
606 * Some BIOSes assume that WAK_STS will be cleared on resume and use
607 * it to determine whether the system is rebooting or resuming. Clear
608 * it for compatibility.
609 */
Bob Moore50ffba12009-02-23 15:02:07 +0800610 acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, 1);
Matthew Garretta68823e2008-08-06 19:12:04 +0100611
Thomas Renninger79d2dfa2007-08-24 01:24:47 -0400612 acpi_gbl_system_awake_and_running = TRUE;
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 /* Enable power button */
615
Len Brown4be44fc2005-08-05 00:44:28 -0400616 (void)
Bob Moore50ffba12009-02-23 15:02:07 +0800617 acpi_write_bit_register(acpi_gbl_fixed_event_info
Bob Moore768aaaf2009-03-06 09:49:25 +0800618 [ACPI_EVENT_POWER_BUTTON].
619 enable_register_id, ACPI_ENABLE_EVENT);
Robert Moore44f6c012005-04-18 22:49:35 -0400620
Len Brown4be44fc2005-08-05 00:44:28 -0400621 (void)
Bob Moore50ffba12009-02-23 15:02:07 +0800622 acpi_write_bit_register(acpi_gbl_fixed_event_info
Bob Moore768aaaf2009-03-06 09:49:25 +0800623 [ACPI_EVENT_POWER_BUTTON].
624 status_register_id, ACPI_CLEAR_STATUS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626 arg.integer.value = ACPI_SST_WORKING;
Len Brown4be44fc2005-08-05 00:44:28 -0400627 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
628 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500629 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 }
631
Len Brown4be44fc2005-08-05 00:44:28 -0400632 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
Bob Moore83135242006-10-03 00:00:00 -0400634
635ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)