1*83d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */
24372c111SBin Meng /*
34372c111SBin Meng * Copyright (C) 2017, Bin Meng <bmeng.cn@gmail.com>
44372c111SBin Meng */
54372c111SBin Meng
64372c111SBin Meng #ifndef __ASM_ACPI_S3_H__
74372c111SBin Meng #define __ASM_ACPI_S3_H__
84372c111SBin Meng
92b2d666fSBin Meng #define WAKEUP_BASE 0x600
102b2d666fSBin Meng
114372c111SBin Meng /* PM1_STATUS register */
124372c111SBin Meng #define WAK_STS (1 << 15)
134372c111SBin Meng #define PCIEXPWAK_STS (1 << 14)
144372c111SBin Meng #define RTC_STS (1 << 10)
154372c111SBin Meng #define SLPBTN_STS (1 << 9)
164372c111SBin Meng #define PWRBTN_STS (1 << 8)
174372c111SBin Meng #define GBL_STS (1 << 5)
184372c111SBin Meng #define BM_STS (1 << 4)
194372c111SBin Meng #define TMR_STS (1 << 0)
204372c111SBin Meng
214372c111SBin Meng /* PM1_CNT register */
224372c111SBin Meng #define SLP_EN (1 << 13)
234372c111SBin Meng #define SLP_TYP_SHIFT 10
244372c111SBin Meng #define SLP_TYP (7 << SLP_TYP_SHIFT)
254372c111SBin Meng #define SLP_TYP_S0 0
264372c111SBin Meng #define SLP_TYP_S1 1
274372c111SBin Meng #define SLP_TYP_S3 5
284372c111SBin Meng #define SLP_TYP_S4 6
294372c111SBin Meng #define SLP_TYP_S5 7
304372c111SBin Meng
315ae5aa93SBin Meng /* Memory size reserved for S3 resume */
325ae5aa93SBin Meng #define S3_RESERVE_SIZE 0x1000
335ae5aa93SBin Meng
342b2d666fSBin Meng #ifndef __ASSEMBLY__
352b2d666fSBin Meng
362b2d666fSBin Meng extern char __wakeup[];
372b2d666fSBin Meng extern int __wakeup_size;
382b2d666fSBin Meng
394372c111SBin Meng enum acpi_sleep_state {
404372c111SBin Meng ACPI_S0,
414372c111SBin Meng ACPI_S1,
424372c111SBin Meng ACPI_S2,
434372c111SBin Meng ACPI_S3,
444372c111SBin Meng ACPI_S4,
454372c111SBin Meng ACPI_S5,
464372c111SBin Meng };
474372c111SBin Meng
484372c111SBin Meng /**
49b727961bSBin Meng * acpi_ss_string() - get ACPI-defined sleep state string
50b727961bSBin Meng *
51b727961bSBin Meng * @pm1_cnt: ACPI-defined sleep state
52b727961bSBin Meng * @return: a pointer to the sleep state string.
53b727961bSBin Meng */
acpi_ss_string(enum acpi_sleep_state state)54b727961bSBin Meng static inline char *acpi_ss_string(enum acpi_sleep_state state)
55b727961bSBin Meng {
56b727961bSBin Meng char *ss_string[] = { "S0", "S1", "S2", "S3", "S4", "S5"};
57b727961bSBin Meng
58b727961bSBin Meng return ss_string[state];
59b727961bSBin Meng }
60b727961bSBin Meng
61b727961bSBin Meng /**
624372c111SBin Meng * acpi_sleep_from_pm1() - get ACPI-defined sleep state from PM1_CNT register
634372c111SBin Meng *
644372c111SBin Meng * @pm1_cnt: PM1_CNT register value
654372c111SBin Meng * @return: ACPI-defined sleep state if given valid PM1_CNT register value,
664372c111SBin Meng * -EINVAL otherwise.
674372c111SBin Meng */
acpi_sleep_from_pm1(u32 pm1_cnt)684372c111SBin Meng static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt)
694372c111SBin Meng {
704372c111SBin Meng switch ((pm1_cnt & SLP_TYP) >> SLP_TYP_SHIFT) {
714372c111SBin Meng case SLP_TYP_S0:
724372c111SBin Meng return ACPI_S0;
734372c111SBin Meng case SLP_TYP_S1:
744372c111SBin Meng return ACPI_S1;
754372c111SBin Meng case SLP_TYP_S3:
764372c111SBin Meng return ACPI_S3;
774372c111SBin Meng case SLP_TYP_S4:
784372c111SBin Meng return ACPI_S4;
794372c111SBin Meng case SLP_TYP_S5:
804372c111SBin Meng return ACPI_S5;
814372c111SBin Meng }
824372c111SBin Meng
834372c111SBin Meng return -EINVAL;
844372c111SBin Meng }
854372c111SBin Meng
861206723bSBin Meng /**
871206723bSBin Meng * chipset_prev_sleep_state() - Get chipset previous sleep state
881206723bSBin Meng *
891206723bSBin Meng * This returns chipset previous sleep state from ACPI registers.
901206723bSBin Meng * Platform codes must supply this routine in order to support ACPI S3.
911206723bSBin Meng *
921206723bSBin Meng * @return ACPI_S0/S1/S2/S3/S4/S5.
931206723bSBin Meng */
941206723bSBin Meng enum acpi_sleep_state chipset_prev_sleep_state(void);
951206723bSBin Meng
961206723bSBin Meng /**
971206723bSBin Meng * chipset_clear_sleep_state() - Clear chipset sleep state
981206723bSBin Meng *
991206723bSBin Meng * This clears chipset sleep state in ACPI registers.
1001206723bSBin Meng * Platform codes must supply this routine in order to support ACPI S3.
1011206723bSBin Meng */
1021206723bSBin Meng void chipset_clear_sleep_state(void);
1031206723bSBin Meng
1040f4e2588SBin Meng struct acpi_fadt;
1053a34cae0SBin Meng /**
1063a34cae0SBin Meng * acpi_resume() - Do ACPI S3 resume
1073a34cae0SBin Meng *
1083a34cae0SBin Meng * This calls U-Boot wake up assembly stub and jumps to OS's wake up vector.
1093a34cae0SBin Meng *
1100f4e2588SBin Meng * @fadt: FADT table pointer in the ACPI table
1113a34cae0SBin Meng * @return: Never returns
1123a34cae0SBin Meng */
1130f4e2588SBin Meng void acpi_resume(struct acpi_fadt *fadt);
1143a34cae0SBin Meng
1155ae5aa93SBin Meng /**
1165ae5aa93SBin Meng * acpi_s3_reserve() - Reserve memory for ACPI S3 resume
1175ae5aa93SBin Meng *
1185ae5aa93SBin Meng * This copies memory where real mode interrupt handler stubs reside to the
1195ae5aa93SBin Meng * reserved place on the stack.
1205ae5aa93SBin Meng *
1215ae5aa93SBin Meng * This routine should be called by reserve_arch() before U-Boot is relocated
1225ae5aa93SBin Meng * when ACPI S3 resume is enabled.
1235ae5aa93SBin Meng *
1245ae5aa93SBin Meng * @return: 0 always
1255ae5aa93SBin Meng */
1265ae5aa93SBin Meng int acpi_s3_reserve(void);
1275ae5aa93SBin Meng
1282b2d666fSBin Meng #endif /* __ASSEMBLY__ */
1292b2d666fSBin Meng
1304372c111SBin Meng #endif /* __ASM_ACPI_S3_H__ */
131