acpi_s3.h 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (C) 2017, Bin Meng <bmeng.cn@gmail.com>
  4. */
  5. #ifndef __ASM_ACPI_S3_H__
  6. #define __ASM_ACPI_S3_H__
  7. #define WAKEUP_BASE 0x600
  8. /* PM1_STATUS register */
  9. #define WAK_STS (1 << 15)
  10. #define PCIEXPWAK_STS (1 << 14)
  11. #define RTC_STS (1 << 10)
  12. #define SLPBTN_STS (1 << 9)
  13. #define PWRBTN_STS (1 << 8)
  14. #define GBL_STS (1 << 5)
  15. #define BM_STS (1 << 4)
  16. #define TMR_STS (1 << 0)
  17. /* PM1_CNT register */
  18. #define SLP_EN (1 << 13)
  19. #define SLP_TYP_SHIFT 10
  20. #define SLP_TYP (7 << SLP_TYP_SHIFT)
  21. #define SLP_TYP_S0 0
  22. #define SLP_TYP_S1 1
  23. #define SLP_TYP_S3 5
  24. #define SLP_TYP_S4 6
  25. #define SLP_TYP_S5 7
  26. /* PM1_STS register */
  27. #define RTC_EN BIT(10)
  28. #define PWRBTN_EN BIT(8)
  29. /* Memory size reserved for S3 resume */
  30. #define S3_RESERVE_SIZE 0x1000
  31. #ifndef __ASSEMBLY__
  32. extern char __wakeup[];
  33. extern int __wakeup_size;
  34. enum acpi_sleep_state {
  35. ACPI_S0,
  36. ACPI_S1,
  37. ACPI_S2,
  38. ACPI_S3,
  39. ACPI_S4,
  40. ACPI_S5,
  41. };
  42. /**
  43. * acpi_ss_string() - get ACPI-defined sleep state string
  44. *
  45. * @pm1_cnt: ACPI-defined sleep state
  46. * @return: a pointer to the sleep state string.
  47. */
  48. static inline char *acpi_ss_string(enum acpi_sleep_state state)
  49. {
  50. char *ss_string[] = { "S0", "S1", "S2", "S3", "S4", "S5"};
  51. return ss_string[state];
  52. }
  53. /**
  54. * acpi_sleep_from_pm1() - get ACPI-defined sleep state from PM1_CNT register
  55. *
  56. * @pm1_cnt: PM1_CNT register value
  57. * @return: ACPI-defined sleep state if given valid PM1_CNT register value,
  58. * -EINVAL otherwise.
  59. */
  60. static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt)
  61. {
  62. switch ((pm1_cnt & SLP_TYP) >> SLP_TYP_SHIFT) {
  63. case SLP_TYP_S0:
  64. return ACPI_S0;
  65. case SLP_TYP_S1:
  66. return ACPI_S1;
  67. case SLP_TYP_S3:
  68. return ACPI_S3;
  69. case SLP_TYP_S4:
  70. return ACPI_S4;
  71. case SLP_TYP_S5:
  72. return ACPI_S5;
  73. }
  74. return -EINVAL;
  75. }
  76. /**
  77. * chipset_prev_sleep_state() - Get chipset previous sleep state
  78. *
  79. * This returns chipset previous sleep state from ACPI registers.
  80. * Platform codes must supply this routine in order to support ACPI S3.
  81. *
  82. * @return ACPI_S0/S1/S2/S3/S4/S5.
  83. */
  84. enum acpi_sleep_state chipset_prev_sleep_state(void);
  85. /**
  86. * chipset_clear_sleep_state() - Clear chipset sleep state
  87. *
  88. * This clears chipset sleep state in ACPI registers.
  89. * Platform codes must supply this routine in order to support ACPI S3.
  90. */
  91. void chipset_clear_sleep_state(void);
  92. struct acpi_fadt;
  93. /**
  94. * acpi_resume() - Do ACPI S3 resume
  95. *
  96. * This calls U-Boot wake up assembly stub and jumps to OS's wake up vector.
  97. *
  98. * @fadt: FADT table pointer in the ACPI table
  99. * @return: Never returns
  100. */
  101. void acpi_resume(struct acpi_fadt *fadt);
  102. /**
  103. * acpi_s3_reserve() - Reserve memory for ACPI S3 resume
  104. *
  105. * This copies memory where real mode interrupt handler stubs reside to the
  106. * reserved place on the stack.
  107. *
  108. * This routine should be called by reserve_arch() before U-Boot is relocated
  109. * when ACPI S3 resume is enabled.
  110. *
  111. * @return: 0 always
  112. */
  113. int acpi_s3_reserve(void);
  114. #endif /* __ASSEMBLY__ */
  115. #endif /* __ASM_ACPI_S3_H__ */