gd32f30x_ctc.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. /*!
  2. \file gd32f30x_ctc.h
  3. \brief definitions for the CTC
  4. */
  5. /*
  6. Copyright (C) 2017 GigaDevice
  7. 2017-02-10, V1.0.1, firmware for GD32F30x
  8. */
  9. #ifndef GD32F30X_CTC_H
  10. #define GD32F30X_CTC_H
  11. #include "gd32f30x.h"
  12. /* CTC definitions */
  13. #define CTC CTC_BASE
  14. /* registers definitions */
  15. #define CTC_CTL0 REG32((CTC) + 0x00U) /*!< CTC control register 0 */
  16. #define CTC_CTL1 REG32((CTC) + 0x04U) /*!< CTC control register 1 */
  17. #define CTC_STAT REG32((CTC) + 0x08U) /*!< CTC status register */
  18. #define CTC_INTC REG32((CTC) + 0x0CU) /*!< CTC interrupt clear register */
  19. /* bits definitions */
  20. /* CTC_CTL0 */
  21. #define CTC_CTL0_CKOKIE BIT(0) /*!< clock trim OK(CKOKIF) interrupt enable */
  22. #define CTC_CTL0_CKWARNIE BIT(1) /*!< clock trim warning(CKWARNIF) interrupt enable */
  23. #define CTC_CTL0_ERRIE BIT(2) /*!< error(ERRIF) interrupt enable */
  24. #define CTC_CTL0_EREFIE BIT(3) /*!< EREFIF interrupt enable */
  25. #define CTC_CTL0_CNTEN BIT(5) /*!< CTC counter enable */
  26. #define CTC_CTL0_AUTOTRIM BIT(6) /*!< hardware automatically trim mode */
  27. #define CTC_CTL0_SWREFPUL BIT(7) /*!< software reference source sync pulse */
  28. #define CTC_CTL0_TRIMVALUE BITS(8,13) /*!< IRC48M trim value */
  29. /* CTC_CTL1 */
  30. #define CTC_CTL1_RLVALUE BITS(0,15) /*!< CTC counter reload value */
  31. #define CTC_CTL1_CKLIM BITS(16,23) /*!< clock trim base limit value */
  32. #define CTC_CTL1_REFPSC BITS(24,26) /*!< reference signal source prescaler */
  33. #define CTC_CTL1_REFSEL BITS(28,29) /*!< reference signal source selection */
  34. #define CTC_CTL1_REFPOL BIT(31) /*!< reference signal source polarity */
  35. /* CTC_STAT */
  36. #define CTC_STAT_CKOKIF BIT(0) /*!< clock trim OK interrupt flag */
  37. #define CTC_STAT_CKWARNIF BIT(1) /*!< clock trim warning interrupt flag */
  38. #define CTC_STAT_ERRIF BIT(2) /*!< error interrupt flag */
  39. #define CTC_STAT_EREFIF BIT(3) /*!< expect reference interrupt flag */
  40. #define CTC_STAT_CKERR BIT(8) /*!< clock trim error bit */
  41. #define CTC_STAT_REFMISS BIT(9) /*!< reference sync pulse miss */
  42. #define CTC_STAT_TRIMERR BIT(10) /*!< trim value error bit */
  43. #define CTC_STAT_REFDIR BIT(15) /*!< CTC trim counter direction when reference sync pulse occurred */
  44. #define CTC_STAT_REFCAP BITS(16,31) /*!< CTC counter capture when reference sync pulse occurred */
  45. /* CTC_INTC */
  46. #define CTC_INTC_CKOKIC BIT(0) /*!< CKOKIF interrupt clear bit */
  47. #define CTC_INTC_CKWARNIC BIT(1) /*!< CKWARNIF interrupt clear bit */
  48. #define CTC_INTC_ERRIC BIT(2) /*!< ERRIF interrupt clear bit */
  49. #define CTC_INTC_EREFIC BIT(3) /*!< EREFIF interrupt clear bit */
  50. /* constants definitions */
  51. /* hardware automatically trim mode definitions */
  52. #define CTC_HARDWARE_TRIM_MODE_ENABLE CTC_CTL0_AUTOTRIM /*!< hardware automatically trim mode enable*/
  53. #define CTC_HARDWARE_TRIM_MODE_DISABLE ((uint32_t)0x00000000U) /*!< hardware automatically trim mode disable*/
  54. /* reference signal source polarity definitions */
  55. #define CTC_REFSOURCE_POLARITY_FALLING CTC_CTL1_REFPOL /*!< reference signal source polarity is falling edge*/
  56. #define CTC_REFSOURCE_POLARITY_RISING ((uint32_t)0x00000000U) /*!< reference signal source polarity is rising edge*/
  57. /* reference signal source selection definitions */
  58. #define CTL1_REFSEL(regval) (BITS(28,29) & ((uint32_t)(regval) << 28))
  59. #define CTC_REFSOURCE_GPIO CTL1_REFSEL(0) /*!< GPIO is selected */
  60. #define CTC_REFSOURCE_LXTAL CTL1_REFSEL(1) /*!< LXTAL is clock selected */
  61. #define CTC_REFSOURCE_USBSOF CTL1_REFSEL(2) /*!< USBDSOF or USBFSSOF selected */
  62. /* reference signal source prescaler definitions */
  63. #define CTL1_REFPSC(regval) (BITS(24,26) & ((uint32_t)(regval) << 24))
  64. #define CTC_REFSOURCE_PSC_OFF CTL1_REFPSC(0) /*!< reference signal not divided */
  65. #define CTC_REFSOURCE_PSC_DIV2 CTL1_REFPSC(1) /*!< reference signal divided by 2 */
  66. #define CTC_REFSOURCE_PSC_DIV4 CTL1_REFPSC(2) /*!< reference signal divided by 4 */
  67. #define CTC_REFSOURCE_PSC_DIV8 CTL1_REFPSC(3) /*!< reference signal divided by 8 */
  68. #define CTC_REFSOURCE_PSC_DIV16 CTL1_REFPSC(4) /*!< reference signal divided by 16 */
  69. #define CTC_REFSOURCE_PSC_DIV32 CTL1_REFPSC(5) /*!< reference signal divided by 32 */
  70. #define CTC_REFSOURCE_PSC_DIV64 CTL1_REFPSC(6) /*!< reference signal divided by 64 */
  71. #define CTC_REFSOURCE_PSC_DIV128 CTL1_REFPSC(7) /*!< reference signal divided by 128 */
  72. /* CTC interrupt enable definitions */
  73. #define CTC_INT_CKOK CTC_CTL0_CKOKIE /*!< clock trim OK interrupt enable */
  74. #define CTC_INT_CKWARN CTC_CTL0_CKWARNIE /*!< clock trim warning interrupt enable */
  75. #define CTC_INT_ERR CTC_CTL0_ERRIE /*!< error interrupt enable */
  76. #define CTC_INT_EREF CTC_CTL0_EREFIE /*!< expect reference interrupt enable */
  77. /* CTC interrupt source definitions */
  78. #define CTC_INT_FLAG_CKOK CTC_STAT_CKOKIF /*!< clock trim OK interrupt flag */
  79. #define CTC_INT_FLAG_CKWARN CTC_STAT_CKWARNIF /*!< clock trim warning interrupt flag */
  80. #define CTC_INT_FLAG_ERR CTC_STAT_ERRIF /*!< error interrupt flag */
  81. #define CTC_INT_FLAG_EREF CTC_STAT_EREFIF /*!< expect reference interrupt flag */
  82. #define CTC_INT_FLAG_CKERR CTC_STAT_CKERR /*!< clock trim error bit */
  83. #define CTC_INT_FLAG_REFMISS CTC_STAT_REFMISS /*!< reference sync pulse miss */
  84. #define CTC_INT_FLAG_TRIMERR CTC_STAT_TRIMERR /*!< trim value error */
  85. /* CTC flag definitions */
  86. #define CTC_FLAG_CKOK CTC_STAT_CKOKIF /*!< clock trim OK flag */
  87. #define CTC_FLAG_CKWARN CTC_STAT_CKWARNIF /*!< clock trim warning flag */
  88. #define CTC_FLAG_ERR CTC_STAT_ERRIF /*!< error flag */
  89. #define CTC_FLAG_EREF CTC_STAT_EREFIF /*!< expect reference flag */
  90. #define CTC_FLAG_CKERR CTC_STAT_CKERR /*!< clock trim error bit */
  91. #define CTC_FLAG_REFMISS CTC_STAT_REFMISS /*!< reference sync pulse miss */
  92. #define CTC_FLAG_TRIMERR CTC_STAT_TRIMERR /*!< trim value error bit */
  93. /* function declarations */
  94. /* reset ctc clock trim controller */
  95. void ctc_deinit(void);
  96. /* enable the CTC interrupt */
  97. void ctc_interrupt_enable(uint32_t ctc_interrupt);
  98. /* disable the CTC interrupt */
  99. void ctc_interrupt_disable(uint32_t ctc_interrupt);
  100. /* get CTC interrupt flag */
  101. FlagStatus ctc_interrupt_flag_get(uint32_t ctc_interrupt);
  102. /* clear CTC interrupt flag */
  103. void ctc_interrupt_flag_clear(uint32_t ctc_interrupt);
  104. /* get CTC flag */
  105. FlagStatus ctc_flag_get(uint32_t ctc_flag);
  106. /* clear CTC flag */
  107. void ctc_flag_clear(uint32_t ctc_flag);
  108. /* configure the IRC48M trim value */
  109. void ctc_irc48m_trim_value_config(uint8_t ctc_trim_value);
  110. /* generate software reference source sync pulse */
  111. void ctc_software_refsource_pulse_generate(void);
  112. /* configure hardware automatically trim mode */
  113. void ctc_hardware_trim_mode_config(uint32_t ctc_hardmode);
  114. /* enable CTC trim counter */
  115. void ctc_counter_enable(void);
  116. /* disable CTC trim counter */
  117. void ctc_counter_disable(void);
  118. /* configure reference signal source polarity */
  119. void ctc_refsource_polarity_config(uint32_t ctc_polarity);
  120. /* select reference signal source */
  121. void ctc_refsource_signal_select(uint32_t ctc_refs);
  122. /* configure reference signal source prescaler */
  123. void ctc_refsource_prescaler_config(uint32_t ctc_prescaler);
  124. /* configure clock trim base limit value */
  125. void ctc_clock_limit_value_config(uint8_t ctc_limit_value);
  126. /* configure CTC counter reload value */
  127. void ctc_counter_reload_value_config(uint16_t ctc_reload_value);
  128. /* read CTC counter capture value when reference sync pulse occurred */
  129. uint16_t ctc_counter_capture_value_read(void);
  130. /* read CTC trim counter direction when reference sync pulse occurred */
  131. FlagStatus ctc_counter_direction_read(void);
  132. /* read CTC counter reload value */
  133. uint16_t ctc_counter_reload_value_read(void);
  134. /* read the IRC48M trim value */
  135. uint8_t ctc_irc48m_trim_value_read(void);
  136. #endif /* GD32F30X_CTC_H */