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 - 2013, 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 <contrib/dev/acpica/include/acpi.h>
46#include <contrib/dev/acpica/include/accommon.h>
47
48#define _COMPONENT          ACPI_HARDWARE
49        ACPI_MODULE_NAME    ("hwsleep")
50
51
52#if (!ACPI_REDUCED_HARDWARE) /* Entire module */
53/*******************************************************************************
54 *
55 * FUNCTION:    AcpiHwLegacySleep
56 *
57 * PARAMETERS:  SleepState          - Which sleep state to enter
58 *
59 * RETURN:      Status
60 *
61 * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers
62 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
63 *
64 ******************************************************************************/
65
66ACPI_STATUS
67AcpiHwLegacySleep (
68    UINT8                   SleepState)
69{
70    ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
71    ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
72    UINT32                  Pm1aControl;
73    UINT32                  Pm1bControl;
74    UINT32                  InValue;
75    UINT32                  Retry;
76    ACPI_STATUS             Status;
77
78
79    ACPI_FUNCTION_TRACE (HwLegacySleep);
80
81
82    SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
83    SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
84
85    /* Clear wake status */
86
87    Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
88    if (ACPI_FAILURE (Status))
89    {
90        return_ACPI_STATUS (Status);
91    }
92
93    /* Clear all fixed and general purpose status bits */
94
95    Status = AcpiHwClearAcpiStatus ();
96    if (ACPI_FAILURE (Status))
97    {
98        return_ACPI_STATUS (Status);
99    }
100
101    /*
102     * 1) Disable/Clear all GPEs
103     * 2) Enable all wakeup GPEs
104     */
105    Status = AcpiHwDisableAllGpes ();
106    if (ACPI_FAILURE (Status))
107    {
108        return_ACPI_STATUS (Status);
109    }
110    AcpiGbl_SystemAwakeAndRunning = FALSE;
111
112    Status = AcpiHwEnableAllWakeupGpes ();
113    if (ACPI_FAILURE (Status))
114    {
115        return_ACPI_STATUS (Status);
116    }
117
118    /* Get current value of PM1A control */
119
120    Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
121                &Pm1aControl);
122    if (ACPI_FAILURE (Status))
123    {
124        return_ACPI_STATUS (Status);
125    }
126    ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
127        "Entering sleep state [S%u]\n", SleepState));
128
129    /* Clear the SLP_EN and SLP_TYP fields */
130
131    Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
132                     SleepEnableRegInfo->AccessBitMask);
133    Pm1bControl = Pm1aControl;
134
135    /* Insert the SLP_TYP bits */
136
137    Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
138    Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
139
140    /*
141     * We split the writes of SLP_TYP and SLP_EN to workaround
142     * poorly implemented hardware.
143     */
144
145    /* Write #1: write the SLP_TYP data to the PM1 Control registers */
146
147    Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
148    if (ACPI_FAILURE (Status))
149    {
150        return_ACPI_STATUS (Status);
151    }
152
153    /* Insert the sleep enable (SLP_EN) bit */
154
155    Pm1aControl |= SleepEnableRegInfo->AccessBitMask;
156    Pm1bControl |= SleepEnableRegInfo->AccessBitMask;
157
158    /* Flush caches, as per ACPI specification */
159
160    ACPI_FLUSH_CPU_CACHE ();
161
162    /* Write #2: Write both SLP_TYP + SLP_EN */
163
164    Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
165    if (ACPI_FAILURE (Status))
166    {
167        return_ACPI_STATUS (Status);
168    }
169
170    if (SleepState > ACPI_STATE_S3)
171    {
172        /*
173         * We wanted to sleep > S3, but it didn't happen (by virtue of the
174         * fact that we are still executing!)
175         *
176         * Wait ten seconds, then try again. This is to get S4/S5 to work on
177         * all machines.
178         *
179         * We wait so long to allow chipsets that poll this reg very slowly
180         * to still read the right value. Ideally, this block would go
181         * away entirely.
182         */
183        AcpiOsStall (10 * ACPI_USEC_PER_SEC);
184
185        Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL,
186                    SleepEnableRegInfo->AccessBitMask);
187        if (ACPI_FAILURE (Status))
188        {
189            return_ACPI_STATUS (Status);
190        }
191    }
192
193    /* Wait for transition back to Working State */
194
195    Retry = 1000;
196    do
197    {
198        Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
199        if (ACPI_FAILURE (Status))
200        {
201            return_ACPI_STATUS (Status);
202        }
203
204        if (AcpiGbl_EnableInterpreterSlack)
205        {
206            /*
207             * Some BIOSs don't set WAK_STS at all.  Give up waiting after
208             * 1000 retries if it still isn't set.
209             */
210            if (Retry-- == 0)
211            {
212                break;
213            }
214        }
215
216    } while (!InValue);
217
218    return_ACPI_STATUS (AE_OK);
219}
220
221
222/*******************************************************************************
223 *
224 * FUNCTION:    AcpiHwLegacyWakePrep
225 *
226 * PARAMETERS:  SleepState          - Which sleep state we just exited
227 *
228 * RETURN:      Status
229 *
230 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
231 *              sleep.
232 *              Called with interrupts ENABLED.
233 *
234 ******************************************************************************/
235
236ACPI_STATUS
237AcpiHwLegacyWakePrep (
238    UINT8                   SleepState)
239{
240    ACPI_STATUS             Status;
241    ACPI_BIT_REGISTER_INFO  *SleepTypeRegInfo;
242    ACPI_BIT_REGISTER_INFO  *SleepEnableRegInfo;
243    UINT32                  Pm1aControl;
244    UINT32                  Pm1bControl;
245
246
247    ACPI_FUNCTION_TRACE (HwLegacyWakePrep);
248
249    /*
250     * Set SLP_TYPE and SLP_EN to state S0.
251     * This is unclear from the ACPI Spec, but it is required
252     * by some machines.
253     */
254    Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
255                    &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
256    if (ACPI_SUCCESS (Status))
257    {
258        SleepTypeRegInfo =
259            AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
260        SleepEnableRegInfo =
261            AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
262
263        /* Get current value of PM1A control */
264
265        Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
266                    &Pm1aControl);
267        if (ACPI_SUCCESS (Status))
268        {
269            /* Clear the SLP_EN and SLP_TYP fields */
270
271            Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
272                SleepEnableRegInfo->AccessBitMask);
273            Pm1bControl = Pm1aControl;
274
275            /* Insert the SLP_TYP bits */
276
277            Pm1aControl |= (AcpiGbl_SleepTypeA <<
278                SleepTypeRegInfo->BitPosition);
279            Pm1bControl |= (AcpiGbl_SleepTypeB <<
280                SleepTypeRegInfo->BitPosition);
281
282            /* Write the control registers and ignore any errors */
283
284            (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
285        }
286    }
287
288    return_ACPI_STATUS (Status);
289}
290
291
292/*******************************************************************************
293 *
294 * FUNCTION:    AcpiHwLegacyWake
295 *
296 * PARAMETERS:  SleepState          - Which sleep state we just exited
297 *
298 * RETURN:      Status
299 *
300 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
301 *              Called with interrupts ENABLED.
302 *
303 ******************************************************************************/
304
305ACPI_STATUS
306AcpiHwLegacyWake (
307    UINT8                   SleepState)
308{
309    ACPI_STATUS             Status;
310
311
312    ACPI_FUNCTION_TRACE (HwLegacyWake);
313
314
315    /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
316
317    AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
318    AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING);
319
320    /*
321     * GPEs must be enabled before _WAK is called as GPEs
322     * might get fired there
323     *
324     * Restore the GPEs:
325     * 1) Disable/Clear all GPEs
326     * 2) Enable all runtime GPEs
327     */
328    Status = AcpiHwDisableAllGpes ();
329    if (ACPI_FAILURE (Status))
330    {
331        return_ACPI_STATUS (Status);
332    }
333
334    Status = AcpiHwEnableAllRuntimeGpes ();
335    if (ACPI_FAILURE (Status))
336    {
337        return_ACPI_STATUS (Status);
338    }
339
340    /*
341     * Now we can execute _WAK, etc. Some machines require that the GPEs
342     * are enabled before the wake methods are executed.
343     */
344    AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState);
345
346    /*
347     * Some BIOS code assumes that WAK_STS will be cleared on resume
348     * and use it to determine whether the system is rebooting or
349     * resuming. Clear WAK_STS for compatibility.
350     */
351    (void) AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
352    AcpiGbl_SystemAwakeAndRunning = TRUE;
353
354    /* Enable power button */
355
356    (void) AcpiWriteBitRegister(
357            AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
358            ACPI_ENABLE_EVENT);
359
360    (void) AcpiWriteBitRegister(
361            AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
362            ACPI_CLEAR_STATUS);
363
364    AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING);
365    return_ACPI_STATUS (Status);
366}
367
368#endif /* !ACPI_REDUCED_HARDWARE */
369