2 * Copyright (C) 2017, Bin Meng <bmeng.cn@gmail.com>
4 * SPDX-License-Identifier: GPL-2.0+
7 #ifndef __ASM_ACPI_S3_H__
8 #define __ASM_ACPI_S3_H__
10 #define WAKEUP_BASE 0x600
12 /* PM1_STATUS register */
13 #define WAK_STS (1 << 15)
14 #define PCIEXPWAK_STS (1 << 14)
15 #define RTC_STS (1 << 10)
16 #define SLPBTN_STS (1 << 9)
17 #define PWRBTN_STS (1 << 8)
18 #define GBL_STS (1 << 5)
19 #define BM_STS (1 << 4)
20 #define TMR_STS (1 << 0)
22 /* PM1_CNT register */
23 #define SLP_EN (1 << 13)
24 #define SLP_TYP_SHIFT 10
25 #define SLP_TYP (7 << SLP_TYP_SHIFT)
32 /* Memory size reserved for S3 resume */
33 #define S3_RESERVE_SIZE 0x1000
37 extern char __wakeup[];
38 extern int __wakeup_size;
40 enum acpi_sleep_state {
50 * acpi_ss_string() - get ACPI-defined sleep state string
52 * @pm1_cnt: ACPI-defined sleep state
53 * @return: a pointer to the sleep state string.
55 static inline char *acpi_ss_string(enum acpi_sleep_state state)
57 char *ss_string[] = { "S0", "S1", "S2", "S3", "S4", "S5"};
59 return ss_string[state];
63 * acpi_sleep_from_pm1() - get ACPI-defined sleep state from PM1_CNT register
65 * @pm1_cnt: PM1_CNT register value
66 * @return: ACPI-defined sleep state if given valid PM1_CNT register value,
69 static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt)
71 switch ((pm1_cnt & SLP_TYP) >> SLP_TYP_SHIFT) {
88 * chipset_prev_sleep_state() - Get chipset previous sleep state
90 * This returns chipset previous sleep state from ACPI registers.
91 * Platform codes must supply this routine in order to support ACPI S3.
93 * @return ACPI_S0/S1/S2/S3/S4/S5.
95 enum acpi_sleep_state chipset_prev_sleep_state(void);
98 * chipset_clear_sleep_state() - Clear chipset sleep state
100 * This clears chipset sleep state in ACPI registers.
101 * Platform codes must supply this routine in order to support ACPI S3.
103 void chipset_clear_sleep_state(void);
107 * acpi_resume() - Do ACPI S3 resume
109 * This calls U-Boot wake up assembly stub and jumps to OS's wake up vector.
111 * @fadt: FADT table pointer in the ACPI table
112 * @return: Never returns
114 void acpi_resume(struct acpi_fadt *fadt);
117 * acpi_s3_reserve() - Reserve memory for ACPI S3 resume
119 * This copies memory where real mode interrupt handler stubs reside to the
120 * reserved place on the stack.
122 * This routine should be called by reserve_arch() before U-Boot is relocated
123 * when ACPI S3 resume is enabled.
127 int acpi_s3_reserve(void);
129 #endif /* __ASSEMBLY__ */
131 #endif /* __ASM_ACPI_S3_H__ */