gd32f3x0_fwdgt.h 5.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /*!
  2. \file gd32f3x0_fwdgt.h
  3. \brief definitions for the FWDGT
  4. */
  5. /*
  6. Copyright (C) 2017 GigaDevice
  7. 2017-06-06, V1.0.0, firmware for GD32F3x0
  8. */
  9. #ifndef GD32F3X0_FWDGT_H
  10. #define GD32F3X0_FWDGT_H
  11. #include "gd32f3x0.h"
  12. /* FWDGT definitions */
  13. #define FWDGT FWDGT_BASE
  14. /* registers definitions */
  15. #define FWDGT_CTL REG32((FWDGT) + 0x00U) /*!< FWDGT control register */
  16. #define FWDGT_PSC REG32((FWDGT) + 0x04U) /*!< FWDGT prescaler register */
  17. #define FWDGT_RLD REG32((FWDGT) + 0x08U) /*!< FWDGT reload register */
  18. #define FWDGT_STAT REG32((FWDGT) + 0x0CU) /*!< FWDGT status register */
  19. #define FWDGT_WND REG32((FWDGT) + 0x10U) /*!< FWDGT window register */
  20. /* bits definitions */
  21. /* FWDGT_CTL */
  22. #define FWDGT_CTL_CMD BITS(0,15) /*!< FWDGT command value */
  23. /* FWDGT_PSC */
  24. #define FWDGT_PSC_PSC BITS(0,2) /*!< FWDGT prescaler divider value */
  25. /* FWDGT_RLD */
  26. #define FWDGT_RLD_RLD BITS(0,11) /*!< FWDGT counter reload value */
  27. /* FWDGT_STAT */
  28. #define FWDGT_STAT_PUD BIT(0) /*!< FWDGT prescaler divider value update */
  29. #define FWDGT_STAT_RUD BIT(1) /*!< FWDGT counter reload value update */
  30. #define FWDGT_STAT_WUD BIT(2) /*!< FWDGT counter window value update */
  31. /* FWDGT_WND */
  32. #define FWDGT_WND_WND BITS(0,11) /*!< FWDGT counter window value */
  33. /* constants definitions */
  34. /* FWDGT_CTL register value */
  35. #define CTL_CMD(regval) (BITS(0,15) & ((uint32_t)(regval) << 0U)) /*!< write value to FWDGT_CTL_CMD bit field */
  36. /* FWDGT_PSC register value */
  37. #define PSC_PSC(regval) (BITS(0,2) & ((uint32_t)(regval) << 0U))
  38. #define FWDGT_PSC_DIV4 ((uint8_t)PSC_PSC(0)) /*!< FWDGT prescaler set to 4 */
  39. #define FWDGT_PSC_DIV8 ((uint8_t)PSC_PSC(1)) /*!< FWDGT prescaler set to 8 */
  40. #define FWDGT_PSC_DIV16 ((uint8_t)PSC_PSC(2)) /*!< FWDGT prescaler set to 16 */
  41. #define FWDGT_PSC_DIV32 ((uint8_t)PSC_PSC(3)) /*!< FWDGT prescaler set to 32 */
  42. #define FWDGT_PSC_DIV64 ((uint8_t)PSC_PSC(4)) /*!< FWDGT prescaler set to 64 */
  43. #define FWDGT_PSC_DIV128 ((uint8_t)PSC_PSC(5)) /*!< FWDGT prescaler set to 128 */
  44. #define FWDGT_PSC_DIV256 ((uint8_t)PSC_PSC(6)) /*!< FWDGT prescaler set to 256 */
  45. /* FWDGT_RLD register value */
  46. #define RLD_RLD(regval) (BITS(0,11) & ((uint32_t)(regval) << 0U)) /*!< write value to FWDGT_RLD_RLD bit field */
  47. /* FWDGT_WND register value */
  48. #define WND_WND(regval) (BITS(0,11) & ((uint32_t)(regval) << 0U)) /*!< write value to FWDGT_WND_WND bit field */
  49. /* control value */
  50. #define FWDGT_WRITEACCESS_ENABLE ((uint16_t)0x5555U) /*!< FWDGT_CTL bits write access enable value */
  51. #define FWDGT_WRITEACCESS_DISABLE ((uint16_t)0x0000U) /*!< FWDGT_CTL bits write access disable value */
  52. #define FWDGT_KEY_RELOAD ((uint16_t)0xAAAAU) /*!< FWDGT_CTL bits fwdgt counter reload value */
  53. #define FWDGT_KEY_ENABLE ((uint16_t)0xCCCCU) /*!< FWDGT_CTL bits fwdgt counter enable value */
  54. /* FWDGT timeout value */
  55. #define FWDGT_WND_TIMEOUT ((uint32_t)0x000FFFFFU) /*!< FWDGT_WND register write operation state flag timeout */
  56. #define FWDGT_PSC_TIMEOUT ((uint32_t)0x000FFFFFU) /*!< FWDGT_PSC register write operation state flag timeout */
  57. #define FWDGT_RLD_TIMEOUT ((uint32_t)0x000FFFFFU) /*!< FWDGT_RLD register write operation state flag timeout */
  58. /* FWDGT flag definitions */
  59. #define FWDGT_FLAG_PUD FWDGT_STAT_PUD /*!< a write operation to FWDGT_PSC register is on going */
  60. #define FWDGT_FLAG_RUD FWDGT_STAT_RUD /*!< a write operation to FWDGT_RLD register is on going */
  61. #define FWDGT_FLAG_WUD FWDGT_STAT_WUD /*!< a write operation to FWDGT_WND register is on going */
  62. /* function declarations */
  63. /* disable write access to FWDGT_PSC,FWDGT_RLD and FWDGT_WND */
  64. void fwdgt_write_disable(void);
  65. /* start the free watchdog timer counter */
  66. void fwdgt_enable(void);
  67. /* configure the free watchdog timer counter window value */
  68. ErrStatus fwdgt_window_value_config(uint16_t window_value);
  69. /* reload the counter of FWDGT */
  70. void fwdgt_counter_reload(void);
  71. /* configure counter reload value, and prescaler divider value */
  72. ErrStatus fwdgt_config(uint16_t reload_value, uint8_t prescaler_div);
  73. /* get flag state of FWDGT */
  74. FlagStatus fwdgt_flag_get(uint16_t flag);
  75. #endif /* GD32F3X0_FWDGT_H */