acpi_s3.h 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  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. /* Memory size reserved for S3 resume */
  27. #define S3_RESERVE_SIZE 0x1000
  28. #ifndef __ASSEMBLY__
  29. extern char __wakeup[];
  30. extern int __wakeup_size;
  31. enum acpi_sleep_state {
  32. ACPI_S0,
  33. ACPI_S1,
  34. ACPI_S2,
  35. ACPI_S3,
  36. ACPI_S4,
  37. ACPI_S5,
  38. };
  39. /**
  40. * acpi_ss_string() - get ACPI-defined sleep state string
  41. *
  42. * @pm1_cnt: ACPI-defined sleep state
  43. * @return: a pointer to the sleep state string.
  44. */
  45. static inline char *acpi_ss_string(enum acpi_sleep_state state)
  46. {
  47. char *ss_string[] = { "S0", "S1", "S2", "S3", "S4", "S5"};
  48. return ss_string[state];
  49. }
  50. /**
  51. * acpi_sleep_from_pm1() - get ACPI-defined sleep state from PM1_CNT register
  52. *
  53. * @pm1_cnt: PM1_CNT register value
  54. * @return: ACPI-defined sleep state if given valid PM1_CNT register value,
  55. * -EINVAL otherwise.
  56. */
  57. static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt)
  58. {
  59. switch ((pm1_cnt & SLP_TYP) >> SLP_TYP_SHIFT) {
  60. case SLP_TYP_S0:
  61. return ACPI_S0;
  62. case SLP_TYP_S1:
  63. return ACPI_S1;
  64. case SLP_TYP_S3:
  65. return ACPI_S3;
  66. case SLP_TYP_S4:
  67. return ACPI_S4;
  68. case SLP_TYP_S5:
  69. return ACPI_S5;
  70. }
  71. return -EINVAL;
  72. }
  73. /**
  74. * chipset_prev_sleep_state() - Get chipset previous sleep state
  75. *
  76. * This returns chipset previous sleep state from ACPI registers.
  77. * Platform codes must supply this routine in order to support ACPI S3.
  78. *
  79. * @return ACPI_S0/S1/S2/S3/S4/S5.
  80. */
  81. enum acpi_sleep_state chipset_prev_sleep_state(void);
  82. /**
  83. * chipset_clear_sleep_state() - Clear chipset sleep state
  84. *
  85. * This clears chipset sleep state in ACPI registers.
  86. * Platform codes must supply this routine in order to support ACPI S3.
  87. */
  88. void chipset_clear_sleep_state(void);
  89. struct acpi_fadt;
  90. /**
  91. * acpi_resume() - Do ACPI S3 resume
  92. *
  93. * This calls U-Boot wake up assembly stub and jumps to OS's wake up vector.
  94. *
  95. * @fadt: FADT table pointer in the ACPI table
  96. * @return: Never returns
  97. */
  98. void acpi_resume(struct acpi_fadt *fadt);
  99. /**
  100. * acpi_s3_reserve() - Reserve memory for ACPI S3 resume
  101. *
  102. * This copies memory where real mode interrupt handler stubs reside to the
  103. * reserved place on the stack.
  104. *
  105. * This routine should be called by reserve_arch() before U-Boot is relocated
  106. * when ACPI S3 resume is enabled.
  107. *
  108. * @return: 0 always
  109. */
  110. int acpi_s3_reserve(void);
  111. #endif /* __ASSEMBLY__ */
  112. #endif /* __ASM_ACPI_S3_H__ */