blob: 7c9645129210657ac5cc192312bbdaa6d7f0f5d0 [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 Moore4a90c7e2006-01-13 16:22:00 -05009 * Copyright (C) 2000 - 2006, R. Byron Moore
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>
Bob Mooref3d2e782007-02-02 19:48:18 +030046#include <acpi/actables.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#define _COMPONENT ACPI_HARDWARE
Len Brown4be44fc2005-08-05 00:44:28 -040049ACPI_MODULE_NAME("hwsleep")
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Robert Moore44f6c012005-04-18 22:49:35 -040051/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 *
53 * FUNCTION: acpi_set_firmware_waking_vector
54 *
55 * PARAMETERS: physical_address - Physical address of ACPI real mode
56 * entry point.
57 *
58 * RETURN: Status
59 *
Robert Moore44f6c012005-04-18 22:49:35 -040060 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 *
62 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -070063acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040064acpi_set_firmware_waking_vector(acpi_physical_address physical_address)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
Bob Mooref3d2e782007-02-02 19:48:18 +030066 struct acpi_table_facs *facs;
67 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Bob Mooreb229cf92006-04-21 17:15:00 -040069 ACPI_FUNCTION_TRACE(acpi_set_firmware_waking_vector);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
Bob Mooref3d2e782007-02-02 19:48:18 +030071 /* Get the FACS */
72
73 status =
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);
78 }
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 /* Set the vector */
81
Bob Mooref3d2e782007-02-02 19:48:18 +030082 if ((facs->length < 32) || (!(facs->xfirmware_waking_vector))) {
83 /*
84 * ACPI 1.0 FACS or short table or optional X_ field is zero
85 */
86 facs->firmware_waking_vector = (u32) physical_address;
Len Brown4be44fc2005-08-05 00:44:28 -040087 } else {
Bob Mooref3d2e782007-02-02 19:48:18 +030088 /*
89 * ACPI 2.0 FACS with valid X_ field
90 */
91 facs->xfirmware_waking_vector = physical_address;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 }
93
Len Brown4be44fc2005-08-05 00:44:28 -040094 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095}
96
Bob Moore83135242006-10-03 00:00:00 -040097ACPI_EXPORT_SYMBOL(acpi_set_firmware_waking_vector)
98
Robert Moore44f6c012005-04-18 22:49:35 -040099/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 *
101 * FUNCTION: acpi_get_firmware_waking_vector
102 *
Robert Moore44f6c012005-04-18 22:49:35 -0400103 * PARAMETERS: *physical_address - Where the contents of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * the firmware_waking_vector field of
Robert Moore44f6c012005-04-18 22:49:35 -0400105 * the FACS will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 *
Robert Moore44f6c012005-04-18 22:49:35 -0400107 * RETURN: Status, vector
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 *
Robert Moore44f6c012005-04-18 22:49:35 -0400109 * DESCRIPTION: Access function for the firmware_waking_vector field in FACS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 *
111 ******************************************************************************/
112#ifdef ACPI_FUTURE_USAGE
113acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400114acpi_get_firmware_waking_vector(acpi_physical_address * physical_address)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
Bob Mooref3d2e782007-02-02 19:48:18 +0300116 struct acpi_table_facs *facs;
117 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Bob Mooreb229cf92006-04-21 17:15:00 -0400119 ACPI_FUNCTION_TRACE(acpi_get_firmware_waking_vector);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 if (!physical_address) {
Len Brown4be44fc2005-08-05 00:44:28 -0400122 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 }
124
Bob Mooref3d2e782007-02-02 19:48:18 +0300125 /* Get the FACS */
126
127 status =
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);
132 }
133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 /* Get the vector */
135
Bob Mooref3d2e782007-02-02 19:48:18 +0300136 if ((facs->length < 32) || (!(facs->xfirmware_waking_vector))) {
137 /*
138 * ACPI 1.0 FACS or short table or optional X_ field is zero
139 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 *physical_address =
Bob Mooref3d2e782007-02-02 19:48:18 +0300141 (acpi_physical_address) facs->firmware_waking_vector;
142 } else {
143 /*
144 * ACPI 2.0 FACS with valid X_ field
145 */
146 *physical_address =
147 (acpi_physical_address) facs->xfirmware_waking_vector;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 }
149
Len Brown4be44fc2005-08-05 00:44:28 -0400150 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151}
Bob Moore83135242006-10-03 00:00:00 -0400152
153ACPI_EXPORT_SYMBOL(acpi_get_firmware_waking_vector)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#endif
155
Robert Moore44f6c012005-04-18 22:49:35 -0400156/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 *
158 * FUNCTION: acpi_enter_sleep_state_prep
159 *
160 * PARAMETERS: sleep_state - Which sleep state to enter
161 *
162 * RETURN: Status
163 *
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.
168 *
169 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400170acpi_status acpi_enter_sleep_state_prep(u8 sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Len Brown4be44fc2005-08-05 00:44:28 -0400172 acpi_status status;
173 struct acpi_object_list arg_list;
174 union acpi_object arg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Bob Mooreb229cf92006-04-21 17:15:00 -0400176 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_prep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178 /*
179 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc.
180 */
Len Brown4be44fc2005-08-05 00:44:28 -0400181 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
187
188 /* Setup parameter object */
189
190 arg_list.count = 1;
191 arg_list.pointer = &arg;
192
193 arg.type = ACPI_TYPE_INTEGER;
194 arg.integer.value = sleep_state;
195
196 /* Run the _PTS and _GTS methods */
197
Len Brown4be44fc2005-08-05 00:44:28 -0400198 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 }
202
Len Brown4be44fc2005-08-05 00:44:28 -0400203 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 }
207
208 /* Setup the argument to _SST */
209
210 switch (sleep_state) {
211 case ACPI_STATE_S0:
212 arg.integer.value = ACPI_SST_WORKING;
213 break;
214
215 case ACPI_STATE_S1:
216 case ACPI_STATE_S2:
217 case ACPI_STATE_S3:
218 arg.integer.value = ACPI_SST_SLEEPING;
219 break;
220
221 case ACPI_STATE_S4:
222 arg.integer.value = ACPI_SST_SLEEP_CONTEXT;
223 break;
224
225 default:
Len Brown4be44fc2005-08-05 00:44:28 -0400226 arg.integer.value = ACPI_SST_INDICATOR_OFF; /* Default is off */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 break;
228 }
229
230 /* Set the system indicators to show the desired sleep state. */
231
Len Brown4be44fc2005-08-05 00:44:28 -0400232 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
233 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500234 ACPI_EXCEPTION((AE_INFO, status,
235 "While executing method _SST"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 }
237
Len Brown4be44fc2005-08-05 00:44:28 -0400238 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239}
240
Bob Moore83135242006-10-03 00:00:00 -0400241ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_prep)
242
Robert Moore44f6c012005-04-18 22:49:35 -0400243/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 *
245 * FUNCTION: acpi_enter_sleep_state
246 *
247 * PARAMETERS: sleep_state - Which sleep state to enter
248 *
249 * RETURN: Status
250 *
251 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231)
252 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
253 *
254 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400255acpi_status asmlinkage acpi_enter_sleep_state(u8 sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
Len Brown4be44fc2005-08-05 00:44:28 -0400257 u32 PM1Acontrol;
258 u32 PM1Bcontrol;
259 struct acpi_bit_register_info *sleep_type_reg_info;
260 struct acpi_bit_register_info *sleep_enable_reg_info;
261 u32 in_value;
262 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Bob Mooreb229cf92006-04-21 17:15:00 -0400264 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266 if ((acpi_gbl_sleep_type_a > ACPI_SLEEP_TYPE_MAX) ||
Len Brown4be44fc2005-08-05 00:44:28 -0400267 (acpi_gbl_sleep_type_b > ACPI_SLEEP_TYPE_MAX)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500268 ACPI_ERROR((AE_INFO, "Sleep values out of range: A=%X B=%X",
269 acpi_gbl_sleep_type_a, acpi_gbl_sleep_type_b));
Len Brown4be44fc2005-08-05 00:44:28 -0400270 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 }
272
Len Brown4be44fc2005-08-05 00:44:28 -0400273 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
278 /* Clear wake status */
279
Bob Moored8c71b62007-02-02 19:48:21 +0300280 status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
Len Brown4be44fc2005-08-05 00:44:28 -0400281 if (ACPI_FAILURE(status)) {
282 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 }
284
285 /* Clear all fixed and general purpose status bits */
286
Bob Moored8c71b62007-02-02 19:48:21 +0300287 status = acpi_hw_clear_acpi_status();
Len Brown4be44fc2005-08-05 00:44:28 -0400288 if (ACPI_FAILURE(status)) {
289 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 }
291
292 /*
293 * 1) Disable/Clear all GPEs
294 * 2) Enable all wakeup GPEs
295 */
Len Brown4be44fc2005-08-05 00:44:28 -0400296 status = acpi_hw_disable_all_gpes();
297 if (ACPI_FAILURE(status)) {
298 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 }
300 acpi_gbl_system_awake_and_running = FALSE;
301
Len Brown4be44fc2005-08-05 00:44:28 -0400302 status = acpi_hw_enable_all_wakeup_gpes();
303 if (ACPI_FAILURE(status)) {
304 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 }
306
307 /* Get current value of PM1A control */
308
Len Brown4be44fc2005-08-05 00:44:28 -0400309 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
310 ACPI_REGISTER_PM1_CONTROL, &PM1Acontrol);
311 if (ACPI_FAILURE(status)) {
312 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 }
Len Brown4be44fc2005-08-05 00:44:28 -0400314 ACPI_DEBUG_PRINT((ACPI_DB_INIT,
315 "Entering sleep state [S%d]\n", sleep_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 /* Clear SLP_EN and SLP_TYP fields */
318
Robert Moore44f6c012005-04-18 22:49:35 -0400319 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
Len Brown4be44fc2005-08-05 00:44:28 -0400320 sleep_enable_reg_info->access_bit_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 PM1Bcontrol = PM1Acontrol;
322
323 /* Insert SLP_TYP bits */
324
Len Brown4be44fc2005-08-05 00:44:28 -0400325 PM1Acontrol |=
326 (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
327 PM1Bcontrol |=
328 (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330 /*
331 * We split the writes of SLP_TYP and SLP_EN to workaround
332 * poorly implemented hardware.
333 */
334
335 /* Write #1: fill in SLP_TYP data */
336
Len Brown4be44fc2005-08-05 00:44:28 -0400337 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
338 ACPI_REGISTER_PM1A_CONTROL,
339 PM1Acontrol);
340 if (ACPI_FAILURE(status)) {
341 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 }
343
Len Brown4be44fc2005-08-05 00:44:28 -0400344 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
345 ACPI_REGISTER_PM1B_CONTROL,
346 PM1Bcontrol);
347 if (ACPI_FAILURE(status)) {
348 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 }
350
351 /* Insert SLP_ENABLE bit */
352
353 PM1Acontrol |= sleep_enable_reg_info->access_bit_mask;
354 PM1Bcontrol |= sleep_enable_reg_info->access_bit_mask;
355
356 /* Write #2: SLP_TYP + SLP_EN */
357
Len Brown4be44fc2005-08-05 00:44:28 -0400358 ACPI_FLUSH_CPU_CACHE();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Len Brown4be44fc2005-08-05 00:44:28 -0400360 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
361 ACPI_REGISTER_PM1A_CONTROL,
362 PM1Acontrol);
363 if (ACPI_FAILURE(status)) {
364 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 }
366
Len Brown4be44fc2005-08-05 00:44:28 -0400367 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
368 ACPI_REGISTER_PM1B_CONTROL,
369 PM1Bcontrol);
370 if (ACPI_FAILURE(status)) {
371 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 }
373
374 if (sleep_state > ACPI_STATE_S3) {
375 /*
Robert Moore44f6c012005-04-18 22:49:35 -0400376 * We wanted to sleep > S3, but it didn't happen (by virtue of the
377 * fact that we are still executing!)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 *
Robert Moore44f6c012005-04-18 22:49:35 -0400379 * Wait ten seconds, then try again. This is to get S4/S5 to work on
380 * all machines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 *
382 * We wait so long to allow chipsets that poll this reg very slowly to
383 * still read the right value. Ideally, this block would go
384 * away entirely.
385 */
Len Brown4be44fc2005-08-05 00:44:28 -0400386 acpi_os_stall(10000000);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Len Brown4be44fc2005-08-05 00:44:28 -0400388 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
389 ACPI_REGISTER_PM1_CONTROL,
390 sleep_enable_reg_info->
391 access_bit_mask);
392 if (ACPI_FAILURE(status)) {
393 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 }
395 }
396
397 /* Wait until we enter sleep state */
398
399 do {
Bob Moored8c71b62007-02-02 19:48:21 +0300400 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
Len Brown4be44fc2005-08-05 00:44:28 -0400401 if (ACPI_FAILURE(status)) {
402 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 }
404
405 /* Spin until we wake */
406
407 } while (!in_value);
408
Len Brown4be44fc2005-08-05 00:44:28 -0400409 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Bob Moore83135242006-10-03 00:00:00 -0400412ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Robert Moore44f6c012005-04-18 22:49:35 -0400414/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 *
416 * FUNCTION: acpi_enter_sleep_state_s4bios
417 *
418 * PARAMETERS: None
419 *
420 * RETURN: Status
421 *
422 * DESCRIPTION: Perform a S4 bios request.
423 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
424 *
425 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400426acpi_status asmlinkage acpi_enter_sleep_state_s4bios(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427{
Len Brown4be44fc2005-08-05 00:44:28 -0400428 u32 in_value;
429 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Bob Mooreb229cf92006-04-21 17:15:00 -0400431 ACPI_FUNCTION_TRACE(acpi_enter_sleep_state_s4bios);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Bob Moored8c71b62007-02-02 19:48:21 +0300433 status = acpi_set_register(ACPI_BITREG_WAKE_STATUS, 1);
Len Brown4be44fc2005-08-05 00:44:28 -0400434 if (ACPI_FAILURE(status)) {
435 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 }
437
Bob Moored8c71b62007-02-02 19:48:21 +0300438 status = acpi_hw_clear_acpi_status();
Len Brown4be44fc2005-08-05 00:44:28 -0400439 if (ACPI_FAILURE(status)) {
440 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 }
442
443 /*
444 * 1) Disable/Clear all GPEs
445 * 2) Enable all wakeup GPEs
446 */
Len Brown4be44fc2005-08-05 00:44:28 -0400447 status = acpi_hw_disable_all_gpes();
448 if (ACPI_FAILURE(status)) {
449 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 }
451 acpi_gbl_system_awake_and_running = FALSE;
452
Len Brown4be44fc2005-08-05 00:44:28 -0400453 status = acpi_hw_enable_all_wakeup_gpes();
454 if (ACPI_FAILURE(status)) {
455 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 }
457
Len Brown4be44fc2005-08-05 00:44:28 -0400458 ACPI_FLUSH_CPU_CACHE();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Bob Mooref3d2e782007-02-02 19:48:18 +0300460 status = acpi_os_write_port(acpi_gbl_FADT.smi_command,
461 (u32) acpi_gbl_FADT.S4bios_request, 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 do {
464 acpi_os_stall(1000);
Bob Moored8c71b62007-02-02 19:48:21 +0300465 status = acpi_get_register(ACPI_BITREG_WAKE_STATUS, &in_value);
Len Brown4be44fc2005-08-05 00:44:28 -0400466 if (ACPI_FAILURE(status)) {
467 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 }
469 } while (!in_value);
470
Len Brown4be44fc2005-08-05 00:44:28 -0400471 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Bob Moore83135242006-10-03 00:00:00 -0400474ACPI_EXPORT_SYMBOL(acpi_enter_sleep_state_s4bios)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Robert Moore44f6c012005-04-18 22:49:35 -0400476/*******************************************************************************
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 *
478 * FUNCTION: acpi_leave_sleep_state
479 *
480 * PARAMETERS: sleep_state - Which sleep state we just exited
481 *
482 * RETURN: Status
483 *
484 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
485 * Called with interrupts ENABLED.
486 *
487 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -0400488acpi_status acpi_leave_sleep_state(u8 sleep_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
Len Brown4be44fc2005-08-05 00:44:28 -0400490 struct acpi_object_list arg_list;
491 union acpi_object arg;
492 acpi_status status;
493 struct acpi_bit_register_info *sleep_type_reg_info;
494 struct acpi_bit_register_info *sleep_enable_reg_info;
495 u32 PM1Acontrol;
496 u32 PM1Bcontrol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Bob Mooreb229cf92006-04-21 17:15:00 -0400498 ACPI_FUNCTION_TRACE(acpi_leave_sleep_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500 /*
501 * Set SLP_TYPE and SLP_EN to state S0.
502 * This is unclear from the ACPI Spec, but it is required
503 * by some machines.
504 */
Len Brown4be44fc2005-08-05 00:44:28 -0400505 status = acpi_get_sleep_type_data(ACPI_STATE_S0,
506 &acpi_gbl_sleep_type_a,
507 &acpi_gbl_sleep_type_b);
508 if (ACPI_SUCCESS(status)) {
509 sleep_type_reg_info =
510 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE_A);
511 sleep_enable_reg_info =
512 acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514 /* Get current value of PM1A control */
515
Len Brown4be44fc2005-08-05 00:44:28 -0400516 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
517 ACPI_REGISTER_PM1_CONTROL,
518 &PM1Acontrol);
519 if (ACPI_SUCCESS(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 /* Clear SLP_EN and SLP_TYP fields */
522
523 PM1Acontrol &= ~(sleep_type_reg_info->access_bit_mask |
Len Brown4be44fc2005-08-05 00:44:28 -0400524 sleep_enable_reg_info->
525 access_bit_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 PM1Bcontrol = PM1Acontrol;
527
528 /* Insert SLP_TYP bits */
529
Len Brown4be44fc2005-08-05 00:44:28 -0400530 PM1Acontrol |=
531 (acpi_gbl_sleep_type_a << sleep_type_reg_info->
532 bit_position);
533 PM1Bcontrol |=
534 (acpi_gbl_sleep_type_b << sleep_type_reg_info->
535 bit_position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
537 /* Just ignore any errors */
538
Len Brown4be44fc2005-08-05 00:44:28 -0400539 (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
540 ACPI_REGISTER_PM1A_CONTROL,
541 PM1Acontrol);
542 (void)acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
543 ACPI_REGISTER_PM1B_CONTROL,
544 PM1Bcontrol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 }
546 }
547
548 /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
549
550 acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
551
552 /* Setup parameter object */
553
554 arg_list.count = 1;
555 arg_list.pointer = &arg;
556 arg.type = ACPI_TYPE_INTEGER;
557
558 /* Ignore any errors from these methods */
559
560 arg.integer.value = ACPI_SST_WAKING;
Len Brown4be44fc2005-08-05 00:44:28 -0400561 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
562 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500563 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 }
565
566 arg.integer.value = sleep_state;
Len Brown4be44fc2005-08-05 00:44:28 -0400567 status = acpi_evaluate_object(NULL, METHOD_NAME__BFS, &arg_list, NULL);
568 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500569 ACPI_EXCEPTION((AE_INFO, status, "During Method _BFS"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 }
571
Len Brown4be44fc2005-08-05 00:44:28 -0400572 status = acpi_evaluate_object(NULL, METHOD_NAME__WAK, &arg_list, NULL);
573 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500574 ACPI_EXCEPTION((AE_INFO, status, "During Method _WAK"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 }
576 /* TBD: _WAK "sometimes" returns stuff - do we want to look at it? */
577
578 /*
579 * Restore the GPEs:
580 * 1) Disable/Clear all GPEs
581 * 2) Enable all runtime GPEs
582 */
Len Brown4be44fc2005-08-05 00:44:28 -0400583 status = acpi_hw_disable_all_gpes();
584 if (ACPI_FAILURE(status)) {
585 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 }
587 acpi_gbl_system_awake_and_running = TRUE;
588
Len Brown4be44fc2005-08-05 00:44:28 -0400589 status = acpi_hw_enable_all_runtime_gpes();
590 if (ACPI_FAILURE(status)) {
591 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 }
593
594 /* Enable power button */
595
Len Brown4be44fc2005-08-05 00:44:28 -0400596 (void)
597 acpi_set_register(acpi_gbl_fixed_event_info
Bob Moored8c71b62007-02-02 19:48:21 +0300598 [ACPI_EVENT_POWER_BUTTON].enable_register_id, 1);
Robert Moore44f6c012005-04-18 22:49:35 -0400599
Len Brown4be44fc2005-08-05 00:44:28 -0400600 (void)
601 acpi_set_register(acpi_gbl_fixed_event_info
Bob Moored8c71b62007-02-02 19:48:21 +0300602 [ACPI_EVENT_POWER_BUTTON].status_register_id, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
604 arg.integer.value = ACPI_SST_WORKING;
Len Brown4be44fc2005-08-05 00:44:28 -0400605 status = acpi_evaluate_object(NULL, METHOD_NAME__SST, &arg_list, NULL);
606 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500607 ACPI_EXCEPTION((AE_INFO, status, "During Method _SST"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608 }
609
Len Brown4be44fc2005-08-05 00:44:28 -0400610 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611}
Bob Moore83135242006-10-03 00:00:00 -0400612
613ACPI_EXPORT_SYMBOL(acpi_leave_sleep_state)