gd32f3x0_cmp.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. /*!
  2. \file gd32f3x0_cmp.h
  3. \brief definitions for the CMP
  4. */
  5. /*
  6. Copyright (C) 2017 GigaDevice
  7. 2017-06-06, V1.0.0, firmware for GD32F3x0
  8. */
  9. #ifndef GD32F3X0_CMP_H
  10. #define GD32F3X0_CMP_H
  11. #include "gd32f3x0.h"
  12. /* CMP definitions */
  13. #define CMP CMP_BASE /*!< CMP base address */
  14. /* registers definitions */
  15. #define CMP_CS REG32((CMP) + 0x00U) /*!< CMP control and status register */
  16. /* CMP_CS bits definitions */
  17. #define CMP_CS_CMP0EN BIT(0) /*!< CMP0 enable */
  18. #define CMP_CS_CMP0SW BIT(1) /*!< CMP0 switch */
  19. #define CMP_CS_CMP0M BITS(2,3) /*!< CMP0 mode */
  20. #define CMP_CS_CMP0MSEL BITS(4,6) /*!< COMP0_M input selection */
  21. #define CMP_CS_CMP0OSEL BITS(8,10) /*!< CMP0 output selection */
  22. #define CMP_CS_CMP0PL BIT(11) /*!< polarity of CMP0 output */
  23. #define CMP_CS_CMP0HST BITS(12,13) /*!< CMP0 hysteresis */
  24. #define CMP_CS_CMP0O BIT(14) /*!< CMP0 output */
  25. #define CMP_CS_CMP0LK BIT(15) /*!< CMP0 lock */
  26. #define CMP_CS_CMP1EN BIT(16) /*!< CMP1 enable */
  27. #define CMP_CS_CMP1M BITS(18,19) /*!< CMP1 mode */
  28. #define CMP_CS_CMP1MSEL BITS(20,22) /*!< CMP1_M input selection */
  29. #define CMP_CS_WNDEN BIT(23) /*!< window mode enable */
  30. #define CMP_CS_CMP1OSEL BITS(24,26) /*!< CMP1 output selection */
  31. #define CMP_CS_CMP1PL BIT(27) /*!< polarity of CMP1 output */
  32. #define CMP_CS_CMP1HST BITS(28,29) /*!< CMP1 hysteresis */
  33. #define CMP_CS_CMP1O BIT(30) /*!< CMP1 output */
  34. #define CMP_CS_CMP1LK BIT(31) /*!< CMP1 lock */
  35. /* consts definitions */
  36. /* operating mode */
  37. typedef enum{
  38. CMP_HIGHSPEED = 0, /*!< high speed mode */
  39. CMP_MIDDLESPEED, /*!< medium speed mode */
  40. CMP_LOWSPEED, /*!< low speed mode */
  41. CMP_VERYLOWSPEED /*!< very-low speed mode */
  42. }operating_mode_enum;
  43. /* inverting input */
  44. typedef enum{
  45. CMP_1_4VREFINT = 0, /*!< VREFINT /4 input */
  46. CMP_1_2VREFINT, /*!< VREFINT /2 input */
  47. CMP_3_4VREFINT, /*!< VREFINT *3/4 input */
  48. CMP_VREFINT, /*!< VREFINT input */
  49. CMP_DAC, /*!< PA4 (DAC) input */
  50. CMP_PA5, /*!< PA5 input */
  51. CMP_PA_0_2 /*!< PA0 or PA2 input */
  52. }inverting_input_enum;
  53. /* hysteresis */
  54. typedef enum{
  55. CMP_HYSTERESIS_NO = 0, /*!< output no hysteresis */
  56. CMP_HYSTERESIS_LOW, /*!< output low hysteresis */
  57. CMP_HYSTERESIS_MIDDLE, /*!< output middle hysteresis */
  58. CMP_HYSTERESIS_HIGH /*!< output high hysteresis */
  59. }cmp_hysteresis_enum;
  60. /* output */
  61. typedef enum{
  62. CMP_OUTPUT_NONE = 0, /*!< output no selection */
  63. CMP_OUTPUT_TIMER0BKIN, /*!< TIMER 0 break input */
  64. CMP_OUTPUT_TIMER0IC0, /*!< TIMER 0 channel0 input capture */
  65. CMP_OUTPUT_TIMER0OCPRECLR, /*!< TIMER 0 OCPRE_CLR input */
  66. CMP_OUTPUT_TIMER1IC3, /*!< TIMER 1 channel3 input capture */
  67. CMP_OUTPUT_TIMER1OCPRECLR, /*!< TIMER 1 OCPRE_CLR input */
  68. CMP_OUTPUT_TIMER2IC0, /*!< TIMER 2 channel0 input capture */
  69. CMP_OUTPUT_TIMER2OCPRECLR /*!< TIMER 2 OCPRE_CLR input */
  70. }cmp_output_enum;
  71. /* CMP0 mode */
  72. #define CS_CMP0M(regval) (BITS(2,3) & ((uint32_t)(regval) << 2))
  73. #define CS_CMP0M_HIGHSPEED CS_CMP0M(0) /*!< CMP0 mode high speed */
  74. #define CS_CMP0M_MIDDLESPEED CS_CMP0M(1) /*!< CMP0 mode middle speed */
  75. #define CS_CMP0M_LOWSPEED CS_CMP0M(2) /*!< CMP0 mode low speed */
  76. #define CS_CMP0M_VERYLOWSPEED CS_CMP0M(3) /*!< CMP0 mode very low speed */
  77. /* comparator 0 inverting input */
  78. #define CS_CMP0MSEL(regval) (BITS(4,6) & ((uint32_t)(regval) << 4))
  79. #define CS_CMP0MSEL_1_4VREFINT CS_CMP0MSEL(0) /*!< CMP0 inverting input 1/4 Vrefint */
  80. #define CS_CMP0MSEL_1_2VREFINT CS_CMP0MSEL(1) /*!< CMP0 inverting input 1/2 Vrefint */
  81. #define CS_CMP0MSEL_3_4VREFINT CS_CMP0MSEL(2) /*!< CMP0 inverting input 3/4 Vrefint */
  82. #define CS_CMP0MSEL_VREFINT CS_CMP0MSEL(3) /*!< CMP0 inverting input Vrefint */
  83. #define CS_CMP0MSEL_DAC CS_CMP0MSEL(4) /*!< CMP0 inverting input DAC*/
  84. #define CS_CMP0MSEL_PA5 CS_CMP0MSEL(5) /*!< CMP0 inverting input PA5*/
  85. #define CS_CMP0MSEL_PA0 CS_CMP0MSEL(6) /*!< CMP0 inverting input PA0*/
  86. /* CMP0 output */
  87. #define CS_CMP0OSEL(regval) (BITS(8,10) & ((uint32_t)(regval) << 8))
  88. #define CS_CMP0OSEL_OUTPUT_NONE CS_CMP0OSEL(0) /*!< CMP0 output none */
  89. #define CS_CMP0OSEL_OUTPUT_TIMER0BKIN CS_CMP0OSEL(1) /*!< CMP0 output TIMER 0 break input */
  90. #define CS_CMP0OSEL_OUTPUT_TIMER0IC0 CS_CMP0OSEL(2) /*!< CMP0 output TIMER 0 channel 0 input capture */
  91. #define CS_CMP0OSEL_OUTPUT_TIMER0OCPRECLR CS_CMP0OSEL(3) /*!< CMP0 output TIMER 0 ocpreclear input */
  92. #define CS_CMP0OSEL_OUTPUT_TIMER1IC3 CS_CMP0OSEL(4) /*!< CMP0 output TIMER 1 channel 3 input capture */
  93. #define CS_CMP0OSEL_OUTPUT_TIMER1OCPRECLR CS_CMP0OSEL(5) /*!< CMP0 output TIMER 1 ocpreclear input */
  94. #define CS_CMP0OSEL_OUTPUT_TIMER2IC0 CS_CMP0OSEL(6) /*!< CMP0 output TIMER 2 channle 0 input capture */
  95. #define CS_CMP0OSEL_OUTPUT_TIMER2OCPRECLR CS_CMP0OSEL(7) /*!< CMP0 output TIMER 2 ocpreclear input */
  96. /* CMP0 hysteresis */
  97. #define CS_CMP0HST(regval) (BITS(12,13) & ((uint32_t)(regval) << 12))
  98. #define CS_CMP0HST_HYSTERESIS_NO CS_CMP0HST(0) /*!< CMP0 output no hysteresis */
  99. #define CS_CMP0HST_HYSTERESIS_LOW CS_CMP0HST(1) /*!< CMP0 output low hysteresis */
  100. #define CS_CMP0HST_HYSTERESIS_MIDDLE CS_CMP0HST(2) /*!< CMP0 output middle hysteresis */
  101. #define CS_CMP0HST_HYSTERESIS_HIGH CS_CMP0HST(3) /*!< CMP0 output high hysteresis */
  102. /* CMP1 mode */
  103. #define CS_CMP1M(regval) (BITS(18,19) & ((uint32_t)(regval) << 18))
  104. #define CS_CMP1M_HIGHSPEED CS_CMP1M(0) /*!< CMP1 mode high speed */
  105. #define CS_CMP1M_MIDDLESPEED CS_CMP1M(1) /*!< CMP1 mode middle speed */
  106. #define CS_CMP1M_LOWSPEED CS_CMP1M(2) /*!< CMP1 mode low speed */
  107. #define CS_CMP1M_VERYLOWSPEED CS_CMP1M(3) /*!< CMP1 mode very low speed */
  108. /* CMP1 inverting input */
  109. #define CS_CMP1MSEL(regval) (BITS(20,22) & ((uint32_t)(regval) << 20))
  110. #define CS_CMP1MSEL_1_4VREFINT CS_CMP1MSEL(0) /*!< CMP1 inverting input 1/4 Vrefint */
  111. #define CS_CMP1MSEL_1_2VREFINT CS_CMP1MSEL(1) /*!< CMP1 inverting input 1/2 Vrefint */
  112. #define CS_CMP1MSEL_3_4VREFINT CS_CMP1MSEL(2) /*!< CMP1 inverting input 3/4 Vrefint */
  113. #define CS_CMP1MSEL_VREFINT CS_CMP1MSEL(3) /*!< CMP1 inverting input Vrefint */
  114. #define CS_CMP1MSEL_DAC CS_CMP1MSEL(4) /*!< CMP1 inverting input DAC */
  115. #define CS_CMP1MSEL_PA5 CS_CMP1MSEL(5) /*!< CMP1 inverting input PA5 */
  116. #define CS_CMP1MSEL_PA2 CS_CMP1MSEL(6) /*!< CMP1 inverting input PA2 */
  117. /* CMP1 output */
  118. #define CS_CMP1OSEL(regval) (BITS(24,26) & ((uint32_t)(regval) << 24))
  119. #define CS_CMP1OSEL_OUTPUT_NONE CS_CMP1OSEL(0) /*!< CMP1 output none */
  120. #define CS_CMP1OSEL_OUTPUT_TIMER0BKIN CS_CMP1OSEL(1) /*!< CMP1 output TIMER 0 break input */
  121. #define CS_CMP1OSEL_OUTPUT_TIMER0IC0 CS_CMP1OSEL(2) /*!< CMP1 output TIMER 0 channel 0 input capture */
  122. #define CS_CMP1OSEL_OUTPUT_TIMER0OCPRECLR CS_CMP1OSEL(3) /*!< CMP1 output TIMER 0 ocpreclear input */
  123. #define CS_CMP1OSEL_OUTPUT_TIMER1IC3 CS_CMP1OSEL(4) /*!< CMP1 output TIMER 1 channel 3 input capture */
  124. #define CS_CMP1OSEL_OUTPUT_TIMER1OCPRECLR CS_CMP1OSEL(5) /*!< CMP1 output TIMER 1 ocpreclear input */
  125. #define CS_CMP1OSEL_OUTPUT_TIMER2IC0 CS_CMP1OSEL(6) /*!< CMP1 output TIMER 2 channle 0 input capture */
  126. #define CS_CMP1OSEL_OUTPUT_TIMER2OCPRECLR CS_CMP1OSEL(7) /*!< CMP1 output TIMER 2 ocpreclear input */
  127. /* CMP1 hysteresis */
  128. #define CS_CMP1HST(regval) (BITS(28,29) & ((uint32_t)(regval) << 28))
  129. #define CS_CMP1HST_HSTHYSTERESIS_NO CS_CMP1HST(0) /*!< CMP1 output no hysteresis */
  130. #define CS_CMP1HST_HYSTERESIS_LOW CS_CMP1HST(1) /*!< CMP1 output low hysteresis */
  131. #define CS_CMP1HST_HYSTERESIS_MIDDLE CS_CMP1HST(2) /*!< CMP1 output middle hysteresis */
  132. #define CS_CMP1HST_HYSTERESIS_HIGH CS_CMP1HST(3) /*!< CMP1 output high hysteresis */
  133. /* comparator x definitions */
  134. #define CMP0 ((uint32_t)0x00000000) /*!< comparator 0 */
  135. #define CMP1 ((uint32_t)0x00000010) /*!< comparator 1 */
  136. /* comparator output level */
  137. #define CMP_OUTPUTLEVEL_HIGH ((uint32_t)0x00000001) /*!< comparator output high */
  138. #define CMP_OUTPUTLEVEL_LOW ((uint32_t)0x00000000) /*!< comparator output low */
  139. /* output polarity of comparator */
  140. #define CMP_OUTPUT_POLARITY_INVERTED ((uint32_t)0x00000001) /*!< output is inverted */
  141. #define CMP_OUTPUT_POLARITY_NOINVERTED ((uint32_t)0x00000000) /*!< output is not inverted */
  142. /* function declarations */
  143. /* initialization functions */
  144. /* CMP deinit */
  145. void cmp_deinit(void);
  146. /* CMP mode init */
  147. void cmp_mode_init(uint32_t cmp_periph, operating_mode_enum operating_mode, inverting_input_enum inverting_input, cmp_hysteresis_enum output_hysteresis);
  148. /* CMP output init */
  149. void cmp_output_init(uint32_t cmp_periph, cmp_output_enum output_slection, uint32_t output_polarity);
  150. /* enable functions */
  151. /* enable CMP */
  152. void cmp_enable(uint32_t cmp_periph);
  153. /* disable CMP */
  154. void cmp_disable(uint32_t cmp_periph);
  155. /* enable CMP switch */
  156. void cmp_switch_enable(void);
  157. /* disable CMP switch */
  158. void cmp_switch_disable(void);
  159. /* enable the window mode */
  160. void cmp_window_enable(void);
  161. /* disable the window mode */
  162. void cmp_window_disable(void);
  163. /* lock the CMP */
  164. void cmp_lock_enable(uint32_t cmp_periph);
  165. /* unlock the CMP */
  166. void cmp_lock_disable(uint32_t cmp_periph);
  167. /* output functions */
  168. /* get output level */
  169. uint32_t cmp_output_level_get(uint32_t cmp_periph);
  170. #endif /* GD32F3X0_CMP_H */