]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - drivers/acpi/acpica/hwsleep.c
8ab325cefa68a4eea8be1c1c320c5e8c2ceffbc3
[~shefty/rdma-dev.git] / drivers / acpi / acpica / hwsleep.c
1 /******************************************************************************
2  *
3  * Name: hwsleep.c - ACPI Hardware Sleep/Wake Support functions for the
4  *                   original/legacy sleep/PM registers.
5  *
6  *****************************************************************************/
7
8 /*
9  * Copyright (C) 2000 - 2012, Intel Corp.
10  * 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
45 #include <acpi/acpi.h>
46 #include "accommon.h"
47 #include <linux/tboot.h>
48 #include <linux/module.h>
49
50 #define _COMPONENT          ACPI_HARDWARE
51 ACPI_MODULE_NAME("hwsleep")
52
53 #if (!ACPI_REDUCED_HARDWARE)    /* Entire module */
54 /*******************************************************************************
55  *
56  * FUNCTION:    acpi_hw_legacy_sleep
57  *
58  * PARAMETERS:  sleep_state         - Which sleep state to enter
59  *              Flags               - ACPI_EXECUTE_GTS to run optional method
60  *
61  * RETURN:      Status
62  *
63  * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers
64  *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
65  *
66  ******************************************************************************/
67 acpi_status acpi_hw_legacy_sleep(u8 sleep_state, u8 flags)
68 {
69         struct acpi_bit_register_info *sleep_type_reg_info;
70         struct acpi_bit_register_info *sleep_enable_reg_info;
71         u32 pm1a_control;
72         u32 pm1b_control;
73         u32 in_value;
74         acpi_status status;
75
76         ACPI_FUNCTION_TRACE(hw_legacy_sleep);
77
78         sleep_type_reg_info =
79             acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
80         sleep_enable_reg_info =
81             acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
82
83         /* Clear wake status */
84
85         status =
86             acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
87         if (ACPI_FAILURE(status)) {
88                 return_ACPI_STATUS(status);
89         }
90
91         /* Clear all fixed and general purpose status bits */
92
93         status = acpi_hw_clear_acpi_status();
94         if (ACPI_FAILURE(status)) {
95                 return_ACPI_STATUS(status);
96         }
97
98         if (sleep_state != ACPI_STATE_S5) {
99                 /*
100                  * Disable BM arbitration. This feature is contained within an
101                  * optional register (PM2 Control), so ignore a BAD_ADDRESS
102                  * exception.
103                  */
104                 status = acpi_write_bit_register(ACPI_BITREG_ARB_DISABLE, 1);
105                 if (ACPI_FAILURE(status) && (status != AE_BAD_ADDRESS)) {
106                         return_ACPI_STATUS(status);
107                 }
108         }
109
110         /*
111          * 1) Disable/Clear all GPEs
112          * 2) Enable all wakeup GPEs
113          */
114         status = acpi_hw_disable_all_gpes();
115         if (ACPI_FAILURE(status)) {
116                 return_ACPI_STATUS(status);
117         }
118         acpi_gbl_system_awake_and_running = FALSE;
119
120         status = acpi_hw_enable_all_wakeup_gpes();
121         if (ACPI_FAILURE(status)) {
122                 return_ACPI_STATUS(status);
123         }
124
125         /* Optionally execute _GTS (Going To Sleep) */
126
127         if (flags & ACPI_EXECUTE_GTS) {
128                 acpi_hw_execute_sleep_method(METHOD_PATHNAME__GTS, sleep_state);
129         }
130
131         /* Get current value of PM1A control */
132
133         status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
134                                        &pm1a_control);
135         if (ACPI_FAILURE(status)) {
136                 return_ACPI_STATUS(status);
137         }
138         ACPI_DEBUG_PRINT((ACPI_DB_INIT,
139                           "Entering sleep state [S%u]\n", sleep_state));
140
141         /* Clear the SLP_EN and SLP_TYP fields */
142
143         pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
144                           sleep_enable_reg_info->access_bit_mask);
145         pm1b_control = pm1a_control;
146
147         /* Insert the SLP_TYP bits */
148
149         pm1a_control |=
150             (acpi_gbl_sleep_type_a << sleep_type_reg_info->bit_position);
151         pm1b_control |=
152             (acpi_gbl_sleep_type_b << sleep_type_reg_info->bit_position);
153
154         /*
155          * We split the writes of SLP_TYP and SLP_EN to workaround
156          * poorly implemented hardware.
157          */
158
159         /* Write #1: write the SLP_TYP data to the PM1 Control registers */
160
161         status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
162         if (ACPI_FAILURE(status)) {
163                 return_ACPI_STATUS(status);
164         }
165
166         /* Insert the sleep enable (SLP_EN) bit */
167
168         pm1a_control |= sleep_enable_reg_info->access_bit_mask;
169         pm1b_control |= sleep_enable_reg_info->access_bit_mask;
170
171         /* Flush caches, as per ACPI specification */
172
173         ACPI_FLUSH_CPU_CACHE();
174
175         tboot_sleep(sleep_state, pm1a_control, pm1b_control);
176
177         /* Write #2: Write both SLP_TYP + SLP_EN */
178
179         status = acpi_hw_write_pm1_control(pm1a_control, pm1b_control);
180         if (ACPI_FAILURE(status)) {
181                 return_ACPI_STATUS(status);
182         }
183
184         if (sleep_state > ACPI_STATE_S3) {
185                 /*
186                  * We wanted to sleep > S3, but it didn't happen (by virtue of the
187                  * fact that we are still executing!)
188                  *
189                  * Wait ten seconds, then try again. This is to get S4/S5 to work on
190                  * all machines.
191                  *
192                  * We wait so long to allow chipsets that poll this reg very slowly
193                  * to still read the right value. Ideally, this block would go
194                  * away entirely.
195                  */
196                 acpi_os_stall(10000000);
197
198                 status = acpi_hw_register_write(ACPI_REGISTER_PM1_CONTROL,
199                                                 sleep_enable_reg_info->
200                                                 access_bit_mask);
201                 if (ACPI_FAILURE(status)) {
202                         return_ACPI_STATUS(status);
203                 }
204         }
205
206         /* Wait for transition back to Working State */
207
208         do {
209                 status =
210                     acpi_read_bit_register(ACPI_BITREG_WAKE_STATUS, &in_value);
211                 if (ACPI_FAILURE(status)) {
212                         return_ACPI_STATUS(status);
213                 }
214
215         } while (!in_value);
216
217         return_ACPI_STATUS(AE_OK);
218 }
219
220 /*******************************************************************************
221  *
222  * FUNCTION:    acpi_hw_legacy_wake_prep
223  *
224  * PARAMETERS:  sleep_state         - Which sleep state we just exited
225  *              Flags               - ACPI_EXECUTE_BFS to run optional method
226  *
227  * RETURN:      Status
228  *
229  * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
230  *              sleep.
231  *              Called with interrupts ENABLED.
232  *
233  ******************************************************************************/
234
235 acpi_status acpi_hw_legacy_wake_prep(u8 sleep_state, u8 flags)
236 {
237         acpi_status status;
238         struct acpi_bit_register_info *sleep_type_reg_info;
239         struct acpi_bit_register_info *sleep_enable_reg_info;
240         u32 pm1a_control;
241         u32 pm1b_control;
242
243         ACPI_FUNCTION_TRACE(hw_legacy_wake_prep);
244
245         /*
246          * Set SLP_TYPE and SLP_EN to state S0.
247          * This is unclear from the ACPI Spec, but it is required
248          * by some machines.
249          */
250         status = acpi_get_sleep_type_data(ACPI_STATE_S0,
251                                           &acpi_gbl_sleep_type_a,
252                                           &acpi_gbl_sleep_type_b);
253         if (ACPI_SUCCESS(status)) {
254                 sleep_type_reg_info =
255                     acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_TYPE);
256                 sleep_enable_reg_info =
257                     acpi_hw_get_bit_register_info(ACPI_BITREG_SLEEP_ENABLE);
258
259                 /* Get current value of PM1A control */
260
261                 status = acpi_hw_register_read(ACPI_REGISTER_PM1_CONTROL,
262                                                &pm1a_control);
263                 if (ACPI_SUCCESS(status)) {
264
265                         /* Clear the SLP_EN and SLP_TYP fields */
266
267                         pm1a_control &= ~(sleep_type_reg_info->access_bit_mask |
268                                           sleep_enable_reg_info->
269                                           access_bit_mask);
270                         pm1b_control = pm1a_control;
271
272                         /* Insert the SLP_TYP bits */
273
274                         pm1a_control |= (acpi_gbl_sleep_type_a <<
275                                          sleep_type_reg_info->bit_position);
276                         pm1b_control |= (acpi_gbl_sleep_type_b <<
277                                          sleep_type_reg_info->bit_position);
278
279                         /* Write the control registers and ignore any errors */
280
281                         (void)acpi_hw_write_pm1_control(pm1a_control,
282                                                         pm1b_control);
283                 }
284         }
285
286         /* Optionally execute _BFS (Back From Sleep) */
287
288         if (flags & ACPI_EXECUTE_BFS) {
289                 acpi_hw_execute_sleep_method(METHOD_PATHNAME__BFS, sleep_state);
290         }
291         return_ACPI_STATUS(status);
292 }
293
294 /*******************************************************************************
295  *
296  * FUNCTION:    acpi_hw_legacy_wake
297  *
298  * PARAMETERS:  sleep_state         - Which sleep state we just exited
299  *              Flags               - Reserved, set to zero
300  *
301  * RETURN:      Status
302  *
303  * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
304  *              Called with interrupts ENABLED.
305  *
306  ******************************************************************************/
307
308 acpi_status acpi_hw_legacy_wake(u8 sleep_state, u8 flags)
309 {
310         acpi_status status;
311
312         ACPI_FUNCTION_TRACE(hw_legacy_wake);
313
314         /* Ensure enter_sleep_state_prep -> enter_sleep_state ordering */
315
316         acpi_gbl_sleep_type_a = ACPI_SLEEP_TYPE_INVALID;
317         acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WAKING);
318
319         /*
320          * GPEs must be enabled before _WAK is called as GPEs
321          * might get fired there
322          *
323          * Restore the GPEs:
324          * 1) Disable/Clear all GPEs
325          * 2) Enable all runtime GPEs
326          */
327         status = acpi_hw_disable_all_gpes();
328         if (ACPI_FAILURE(status)) {
329                 return_ACPI_STATUS(status);
330         }
331
332         status = acpi_hw_enable_all_runtime_gpes();
333         if (ACPI_FAILURE(status)) {
334                 return_ACPI_STATUS(status);
335         }
336
337         /*
338          * Now we can execute _WAK, etc. Some machines require that the GPEs
339          * are enabled before the wake methods are executed.
340          */
341         acpi_hw_execute_sleep_method(METHOD_PATHNAME__WAK, sleep_state);
342
343         /*
344          * Some BIOS code assumes that WAK_STS will be cleared on resume
345          * and use it to determine whether the system is rebooting or
346          * resuming. Clear WAK_STS for compatibility.
347          */
348         acpi_write_bit_register(ACPI_BITREG_WAKE_STATUS, 1);
349         acpi_gbl_system_awake_and_running = TRUE;
350
351         /* Enable power button */
352
353         (void)
354             acpi_write_bit_register(acpi_gbl_fixed_event_info
355                                     [ACPI_EVENT_POWER_BUTTON].
356                                     enable_register_id, ACPI_ENABLE_EVENT);
357
358         (void)
359             acpi_write_bit_register(acpi_gbl_fixed_event_info
360                                     [ACPI_EVENT_POWER_BUTTON].
361                                     status_register_id, ACPI_CLEAR_STATUS);
362
363         /*
364          * Enable BM arbitration. This feature is contained within an
365          * optional register (PM2 Control), so ignore a BAD_ADDRESS
366          * exception.
367          */
368         status = acpi_write_bit_register(ACPI_BITREG_ARB_DISABLE, 0);
369         if (ACPI_FAILURE(status) && (status != AE_BAD_ADDRESS)) {
370                 return_ACPI_STATUS(status);
371         }
372
373         acpi_hw_execute_sleep_method(METHOD_PATHNAME__SST, ACPI_SST_WORKING);
374         return_ACPI_STATUS(status);
375 }
376
377 #endif                          /* !ACPI_REDUCED_HARDWARE */