1/******************************************************************************
2 *
3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#define EXPORT_ACPI_INTERFACES
153
154#include "acpi.h"
155#include "accommon.h"
156
157#define _COMPONENT          ACPI_HARDWARE
158        ACPI_MODULE_NAME    ("hwxfsleep")
159
160/* Local prototypes */
161
162#if (!ACPI_REDUCED_HARDWARE)
163static ACPI_STATUS
164AcpiHwSetFirmwareWakingVector (
165    ACPI_TABLE_FACS         *Facs,
166    ACPI_PHYSICAL_ADDRESS   PhysicalAddress,
167    ACPI_PHYSICAL_ADDRESS   PhysicalAddress64);
168#endif
169
170static ACPI_STATUS
171AcpiHwSleepDispatch (
172    UINT8                   SleepState,
173    UINT32                  FunctionId);
174
175/*
176 * Dispatch table used to efficiently branch to the various sleep
177 * functions.
178 */
179#define ACPI_SLEEP_FUNCTION_ID          0
180#define ACPI_WAKE_PREP_FUNCTION_ID      1
181#define ACPI_WAKE_FUNCTION_ID           2
182
183/* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */
184
185static ACPI_SLEEP_FUNCTIONS         AcpiSleepDispatch[] =
186{
187    {ACPI_STRUCT_INIT (LegacyFunction,
188                       ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep)),
189     ACPI_STRUCT_INIT (ExtendedFunction,
190                       AcpiHwExtendedSleep) },
191    {ACPI_STRUCT_INIT (LegacyFunction,
192                       ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep)),
193     ACPI_STRUCT_INIT (ExtendedFunction,
194                       AcpiHwExtendedWakePrep) },
195    {ACPI_STRUCT_INIT (LegacyFunction,
196                       ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake)),
197     ACPI_STRUCT_INIT (ExtendedFunction,
198                       AcpiHwExtendedWake) }
199};
200
201
202/*
203 * These functions are removed for the ACPI_REDUCED_HARDWARE case:
204 *      AcpiSetFirmwareWakingVector
205 *      AcpiEnterSleepStateS4bios
206 */
207
208#if (!ACPI_REDUCED_HARDWARE)
209/*******************************************************************************
210 *
211 * FUNCTION:    AcpiHwSetFirmwareWakingVector
212 *
213 * PARAMETERS:  Facs                - Pointer to FACS table
214 *              PhysicalAddress     - 32-bit physical address of ACPI real mode
215 *                                    entry point
216 *              PhysicalAddress64   - 64-bit physical address of ACPI protected
217 *                                    mode entry point
218 *
219 * RETURN:      Status
220 *
221 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
222 *
223 ******************************************************************************/
224
225static ACPI_STATUS
226AcpiHwSetFirmwareWakingVector (
227    ACPI_TABLE_FACS         *Facs,
228    ACPI_PHYSICAL_ADDRESS   PhysicalAddress,
229    ACPI_PHYSICAL_ADDRESS   PhysicalAddress64)
230{
231    ACPI_FUNCTION_TRACE (AcpiHwSetFirmwareWakingVector);
232
233
234    /*
235     * According to the ACPI specification 2.0c and later, the 64-bit
236     * waking vector should be cleared and the 32-bit waking vector should
237     * be used, unless we want the wake-up code to be called by the BIOS in
238     * Protected Mode. Some systems (for example HP dv5-1004nr) are known
239     * to fail to resume if the 64-bit vector is used.
240     */
241
242    /* Set the 32-bit vector */
243
244    Facs->FirmwareWakingVector = (UINT32) PhysicalAddress;
245
246    if (Facs->Length > 32)
247    {
248        if (Facs->Version >= 1)
249        {
250            /* Set the 64-bit vector */
251
252            Facs->XFirmwareWakingVector = PhysicalAddress64;
253        }
254        else
255        {
256            /* Clear the 64-bit vector if it exists */
257
258            Facs->XFirmwareWakingVector = 0;
259        }
260    }
261
262    return_ACPI_STATUS (AE_OK);
263}
264
265
266/*******************************************************************************
267 *
268 * FUNCTION:    AcpiSetFirmwareWakingVector
269 *
270 * PARAMETERS:  PhysicalAddress     - 32-bit physical address of ACPI real mode
271 *                                    entry point
272 *              PhysicalAddress64   - 64-bit physical address of ACPI protected
273 *                                    mode entry point
274 *
275 * RETURN:      Status
276 *
277 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS
278 *
279 ******************************************************************************/
280
281ACPI_STATUS
282AcpiSetFirmwareWakingVector (
283    ACPI_PHYSICAL_ADDRESS   PhysicalAddress,
284    ACPI_PHYSICAL_ADDRESS   PhysicalAddress64)
285{
286
287    ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector);
288
289    if (AcpiGbl_FACS)
290    {
291        (void) AcpiHwSetFirmwareWakingVector (AcpiGbl_FACS,
292            PhysicalAddress, PhysicalAddress64);
293    }
294
295    return_ACPI_STATUS (AE_OK);
296}
297
298ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector)
299
300
301/*******************************************************************************
302 *
303 * FUNCTION:    AcpiEnterSleepStateS4bios
304 *
305 * PARAMETERS:  None
306 *
307 * RETURN:      Status
308 *
309 * DESCRIPTION: Perform a S4 bios request.
310 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
311 *
312 ******************************************************************************/
313
314ACPI_STATUS
315AcpiEnterSleepStateS4bios (
316    void)
317{
318    UINT32                  InValue;
319    ACPI_STATUS             Status;
320
321
322    ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios);
323
324
325    /* Clear the wake status bit (PM1) */
326
327    Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
328    if (ACPI_FAILURE (Status))
329    {
330        return_ACPI_STATUS (Status);
331    }
332
333    Status = AcpiHwClearAcpiStatus ();
334    if (ACPI_FAILURE (Status))
335    {
336        return_ACPI_STATUS (Status);
337    }
338
339    /*
340     * 1) Disable all GPEs
341     * 2) Enable all wakeup GPEs
342     */
343    Status = AcpiHwDisableAllGpes ();
344    if (ACPI_FAILURE (Status))
345    {
346        return_ACPI_STATUS (Status);
347    }
348    AcpiGbl_SystemAwakeAndRunning = FALSE;
349
350    Status = AcpiHwEnableAllWakeupGpes ();
351    if (ACPI_FAILURE (Status))
352    {
353        return_ACPI_STATUS (Status);
354    }
355
356    Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand,
357        (UINT32) AcpiGbl_FADT.S4BiosRequest, 8);
358    if (ACPI_FAILURE (Status))
359    {
360        return_ACPI_STATUS (Status);
361    }
362
363    do {
364        AcpiOsStall (ACPI_USEC_PER_MSEC);
365        Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
366        if (ACPI_FAILURE (Status))
367        {
368            return_ACPI_STATUS (Status);
369        }
370
371    } while (!InValue);
372
373    return_ACPI_STATUS (AE_OK);
374}
375
376ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios)
377
378#endif /* !ACPI_REDUCED_HARDWARE */
379
380
381/*******************************************************************************
382 *
383 * FUNCTION:    AcpiHwSleepDispatch
384 *
385 * PARAMETERS:  SleepState          - Which sleep state to enter/exit
386 *              FunctionId          - Sleep, WakePrep, or Wake
387 *
388 * RETURN:      Status from the invoked sleep handling function.
389 *
390 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling
391 *              function.
392 *
393 ******************************************************************************/
394
395static ACPI_STATUS
396AcpiHwSleepDispatch (
397    UINT8                   SleepState,
398    UINT32                  FunctionId)
399{
400    ACPI_STATUS             Status;
401    ACPI_SLEEP_FUNCTIONS    *SleepFunctions = &AcpiSleepDispatch[FunctionId];
402
403
404#if (!ACPI_REDUCED_HARDWARE)
405    /*
406     * If the Hardware Reduced flag is set (from the FADT), we must
407     * use the extended sleep registers (FADT). Note: As per the ACPI
408     * specification, these extended registers are to be used for HW-reduced
409     * platforms only. They are not general-purpose replacements for the
410     * legacy PM register sleep support.
411     */
412    if (AcpiGbl_ReducedHardware)
413    {
414        Status = SleepFunctions->ExtendedFunction (SleepState);
415    }
416    else
417    {
418        /* Legacy sleep */
419
420        Status = SleepFunctions->LegacyFunction (SleepState);
421    }
422
423    return (Status);
424
425#else
426    /*
427     * For the case where reduced-hardware-only code is being generated,
428     * we know that only the extended sleep registers are available
429     */
430    Status = SleepFunctions->ExtendedFunction (SleepState);
431    return (Status);
432
433#endif /* !ACPI_REDUCED_HARDWARE */
434}
435
436
437/*******************************************************************************
438 *
439 * FUNCTION:    AcpiEnterSleepStatePrep
440 *
441 * PARAMETERS:  SleepState          - Which sleep state to enter
442 *
443 * RETURN:      Status
444 *
445 * DESCRIPTION: Prepare to enter a system sleep state.
446 *              This function must execute with interrupts enabled.
447 *              We break sleeping into 2 stages so that OSPM can handle
448 *              various OS-specific tasks between the two steps.
449 *
450 ******************************************************************************/
451
452ACPI_STATUS
453AcpiEnterSleepStatePrep (
454    UINT8                   SleepState)
455{
456    ACPI_STATUS             Status;
457    ACPI_OBJECT_LIST        ArgList;
458    ACPI_OBJECT             Arg;
459    UINT32                  SstValue;
460
461
462    ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep);
463
464
465    Status = AcpiGetSleepTypeData (SleepState,
466        &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
467    if (ACPI_FAILURE (Status))
468    {
469        return_ACPI_STATUS (Status);
470    }
471
472    Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
473        &AcpiGbl_SleepTypeAS0, &AcpiGbl_SleepTypeBS0);
474    if (ACPI_FAILURE (Status)) {
475        AcpiGbl_SleepTypeAS0 = ACPI_SLEEP_TYPE_INVALID;
476    }
477
478    /* Execute the _PTS method (Prepare To Sleep) */
479
480    ArgList.Count = 1;
481    ArgList.Pointer = &Arg;
482    Arg.Type = ACPI_TYPE_INTEGER;
483    Arg.Integer.Value = SleepState;
484
485    Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL);
486    if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND)
487    {
488        return_ACPI_STATUS (Status);
489    }
490
491    /* Setup the argument to the _SST method (System STatus) */
492
493    switch (SleepState)
494    {
495    case ACPI_STATE_S0:
496
497        SstValue = ACPI_SST_WORKING;
498        break;
499
500    case ACPI_STATE_S1:
501    case ACPI_STATE_S2:
502    case ACPI_STATE_S3:
503
504        SstValue = ACPI_SST_SLEEPING;
505        break;
506
507    case ACPI_STATE_S4:
508
509        SstValue = ACPI_SST_SLEEP_CONTEXT;
510        break;
511
512    default:
513
514        SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */
515        break;
516    }
517
518    /*
519     * Set the system indicators to show the desired sleep state.
520     * _SST is an optional method (return no error if not found)
521     */
522    AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue);
523    return_ACPI_STATUS (AE_OK);
524}
525
526ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep)
527
528
529/*******************************************************************************
530 *
531 * FUNCTION:    AcpiEnterSleepState
532 *
533 * PARAMETERS:  SleepState          - Which sleep state to enter
534 *
535 * RETURN:      Status
536 *
537 * DESCRIPTION: Enter a system sleep state
538 *              THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
539 *
540 ******************************************************************************/
541
542ACPI_STATUS
543AcpiEnterSleepState (
544    UINT8                   SleepState)
545{
546    ACPI_STATUS             Status;
547
548
549    ACPI_FUNCTION_TRACE (AcpiEnterSleepState);
550
551
552    if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) ||
553        (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX))
554    {
555        ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X",
556            AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB));
557        return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
558    }
559
560    Status = AcpiHwSleepDispatch (SleepState, ACPI_SLEEP_FUNCTION_ID);
561    return_ACPI_STATUS (Status);
562}
563
564ACPI_EXPORT_SYMBOL (AcpiEnterSleepState)
565
566
567/*******************************************************************************
568 *
569 * FUNCTION:    AcpiLeaveSleepStatePrep
570 *
571 * PARAMETERS:  SleepState          - Which sleep state we are exiting
572 *
573 * RETURN:      Status
574 *
575 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
576 *              sleep. Called with interrupts DISABLED.
577 *              We break wake/resume into 2 stages so that OSPM can handle
578 *              various OS-specific tasks between the two steps.
579 *
580 ******************************************************************************/
581
582ACPI_STATUS
583AcpiLeaveSleepStatePrep (
584    UINT8                   SleepState)
585{
586    ACPI_STATUS             Status;
587
588
589    ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep);
590
591
592    Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_PREP_FUNCTION_ID);
593    return_ACPI_STATUS (Status);
594}
595
596ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep)
597
598
599/*******************************************************************************
600 *
601 * FUNCTION:    AcpiLeaveSleepState
602 *
603 * PARAMETERS:  SleepState          - Which sleep state we are exiting
604 *
605 * RETURN:      Status
606 *
607 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
608 *              Called with interrupts ENABLED.
609 *
610 ******************************************************************************/
611
612ACPI_STATUS
613AcpiLeaveSleepState (
614    UINT8                   SleepState)
615{
616    ACPI_STATUS             Status;
617
618
619    ACPI_FUNCTION_TRACE (AcpiLeaveSleepState);
620
621
622    Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_FUNCTION_ID);
623    return_ACPI_STATUS (Status);
624}
625
626ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState)
627