sys_pmm.h 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. /** @file sys_pmm.h
  2. * @brief PMM Driver Header File
  3. * @date 29.May.2013
  4. * @version 03.05.02
  5. *
  6. * This file contains:
  7. * - Definitions
  8. * - Types
  9. * .
  10. * which are relevant for the System driver.
  11. */
  12. /* (c) Texas Instruments 2009-2013, All rights reserved. */
  13. #ifndef __SYS_PMM_H__
  14. #define __SYS_PMM_H__
  15. #include "reg_pmm.h"
  16. /* USER CODE BEGIN (0) */
  17. /* USER CODE END */
  18. /* Bit Masks */
  19. #define PMM_LOGICPDPWRCTRL0_LOGICPDON0 (0xFU << 24U) /*PD2*/
  20. #define PMM_LOGICPDPWRCTRL0_LOGICPDON1 (0xFU << 16U) /*PD3*/
  21. #define PMM_LOGICPDPWRCTRL0_LOGICPDON2 (0xFU << 8U) /*PD4*/
  22. #define PMM_LOGICPDPWRCTRL0_LOGICPDON3 (0xFU << 0U) /*PD5*/
  23. #define PMM_MEMPDPWRCTRL0_MEMPDON0 (0xFU << 24U) /*RAM_PD1*/
  24. #define PMM_MEMPDPWRCTRL0_MEMPDON1 (0xFU << 16U) /*RAM_PD2*/
  25. #define PMM_MEMPDPWRCTRL0_MEMPDON2 (0xFU << 8U) /*RAM_PD3*/
  26. #define PMM_LOGICPDPWRSTAT_DOMAINON (1U << 8U)
  27. #define PMM_LOGICPDPWRSTAT_LOGICPDPWRSTAT (0x3U << 0U)
  28. #define PMM_MEMPDPWRSTAT_DOMAINON (1U << 8U)
  29. #define PMM_MEMPDPWRSTAT_MEMPDPWRSTAT (0x3U << 0U)
  30. #define PMM_GLOBALCTRL1_AUTOCLKWAKEENA (1U << 0U)
  31. /* Configuration registers initial value */
  32. #define PMM_LOGICPDPWRCTRL0_CONFIGVALUE (((1U)?0x5U:0xAU) << 24U) \
  33. | (((1U)?0x5U:0xAU) << 16U) \
  34. | (((0U)?0x5U:0xAU) << 8U) \
  35. | (((1U)?0x5U:0xAU) << 0U)
  36. #define PMM_MEMPDPWRCTRL0_CONFIGVALUE (((1U)?0x5U:0xAU) << 24U) \
  37. | (((1U)?0x5U:0xAU) << 16U) \
  38. | (((1U)?0x5U:0xAU) << 8U)
  39. #define PMM_PDCLKDISREG_CONFIGVALUE ((!1U) << 0U)\
  40. | ((!1U) << 1U)\
  41. | ((!0U) << 2U)\
  42. | ((!1U) << 3U)
  43. #define PMM_GLOBALCTRL1_CONFIGVALUE (0U << 8U) | (0U << 0U)
  44. /** @enum pmmLogicPDTag
  45. * @brief PMM Logic Power Domain
  46. *
  47. * Used to define PMM Logic Power Domain
  48. */
  49. typedef enum pmmLogicPDTag
  50. {
  51. PMM_LOGICPD1 = 4U, /*-- NOT USED*/
  52. PMM_LOGICPD2 = 0U,
  53. PMM_LOGICPD3 = 1U,
  54. PMM_LOGICPD4 = 2U,
  55. PMM_LOGICPD5 = 3U
  56. }pmm_LogicPD_t;
  57. /** @enum pmmMemPDTag
  58. * @brief PMM Memory-Only Power Domain
  59. *
  60. * Used to define PMM Memory-Only Power Domain
  61. */
  62. typedef enum pmmMemPDTag
  63. {
  64. PMM_MEMPD1 = 0U,
  65. PMM_MEMPD2 = 1U,
  66. PMM_MEMPD3 = 2U
  67. }pmm_MemPD_t;
  68. /** @enum pmmModeTag
  69. * @brief PSCON operating mode
  70. *
  71. * Used to define the operating mode of PSCON Compare Block
  72. */
  73. typedef enum pmmModeTag
  74. {
  75. LockStep = 0x0U,
  76. SelfTest = 0x6U,
  77. ErrorForcing = 0x9U,
  78. SelfTestErrorForcing = 0xFU
  79. }pmm_Mode_t;
  80. /*Pmm Configuration Registers*/
  81. typedef struct pmm_config_reg
  82. {
  83. uint32 CONFIG_LOGICPDPWRCTRL0;
  84. uint32 CONFIG_MEMPDPWRCTRL0;
  85. uint32 CONFIG_PDCLKDISREG;
  86. uint32 CONFIG_GLOBALCTRL1;
  87. }pmm_config_reg_t;
  88. /**
  89. * @defgroup PMM PMM
  90. * @brief Power Management Module
  91. *
  92. * The PMM provides memory-mapped registers that control the states of the supported power domains.
  93. * The PMM includes interfaces to the Power Mode Controller (PMC) and the Power State Controller (PSCON).
  94. * The PMC and PSCON control the power up/down sequence of each power domain.
  95. *
  96. * Related files:
  97. * - reg_pmm.h
  98. * - sys_pmm.h
  99. * - sys_pmm.c
  100. *
  101. * @addtogroup PMM
  102. * @{
  103. */
  104. /* Pmm Interface Functions */
  105. void pmmInit(void);
  106. void pmmTurnONLogicPowerDomain(pmm_LogicPD_t logicPD);
  107. void pmmTurnONMemPowerDomain(pmm_MemPD_t memPD);
  108. void pmmTurnOFFLogicPowerDomain(pmm_LogicPD_t logicPD);
  109. void pmmTurnOFFMemPowerDomain(pmm_MemPD_t memPD);
  110. boolean pmmIsLogicPowerDomainActive(pmm_LogicPD_t logicPD);
  111. boolean pmmIsMemPowerDomainActive(pmm_MemPD_t memPD);
  112. void pmmGetConfigValue(pmm_config_reg_t *config_reg, config_value_type_t type);
  113. void pmmSetMode(pmm_Mode_t mode);
  114. boolean pmmPerformSelfTest(void);
  115. /**@}*/
  116. /* USER CODE BEGIN (1) */
  117. /* USER CODE END */
  118. #endif