gd32f3x0_crc.h 4.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /*!
  2. \file gd32f3x0_crc.h
  3. \brief definitions for the CRC
  4. */
  5. /*
  6. Copyright (C) 2017 GigaDevice
  7. 2017-06-06, V1.0.0, firmware for GD32F3x0
  8. */
  9. #ifndef GD32F3X0_CRC_H
  10. #define GD32F3X0_CRC_H
  11. #include "gd32f3x0.h"
  12. /* CRC definitions */
  13. #define CRC CRC_BASE
  14. /* registers definitions */
  15. #define CRC_DATA REG32((CRC) + 0x00U) /*!< CRC data register */
  16. #define CRC_FDATA REG32((CRC) + 0x04U) /*!< CRC free data register */
  17. #define CRC_CTL REG32((CRC) + 0x08U) /*!< CRC control register */
  18. #define CRC_IDATA REG32((CRC) + 0x10U) /*!< CRC initialization data register */
  19. #define CRC_POLY REG32((CRC) + 0x14U) /*!< CRC polynomial register */
  20. /* bits definitions */
  21. /* CRC_DATA */
  22. #define CRC_DATA_DATA BITS(0,31) /*!< CRC data bits */
  23. /* CRC_FDATA */
  24. #define CRC_FDATA_FDATA BITS(0,7) /*!< CRC free data bits */
  25. /* CRC_CTL */
  26. #define CRC_CTL_RST BIT(0) /*!< CRC reset bit */
  27. #define CRC_CTL_PS BITS(3,4) /*!< size of polynomial function bits */
  28. #define CRC_CTL_REV_I BITS(5,6) /*!< input data reverse function bits */
  29. #define CRC_CTL_REV_O BIT(7) /*!< output data reverse function bit */
  30. /* CRC_INIT */
  31. #define CRC_IDATA_IDATA BITS(0,31) /*!< CRC initialization data bits */
  32. /* CRC_POLY */
  33. #define CRC_POLY_POLY BITS(0,31) /*!< CRC polynomial value bits */
  34. /* constants definitions */
  35. /* size of polynomial function */
  36. #define CTL_PS(regval) (BITS(3, 4) & ((regval) << 3))
  37. #define CRC_CTL_PS_32 CTL_PS(0) /*!< 32-bit polynomial for CRC calculation */
  38. #define CRC_CTL_PS_16 CTL_PS(1) /*!< 16-bit polynomial for CRC calculation */
  39. #define CRC_CTL_PS_8 CTL_PS(2) /*!< 8-bit polynomial for CRC calculation */
  40. #define CRC_CTL_PS_7 CTL_PS(3) /*!< 7-bit polynomial for CRC calculation */
  41. /* input data reverse function */
  42. #define CTL_REV_I(regval) (BITS(5, 6) & ((regval) << 5))
  43. #define CRC_INPUT_DATA_NOT CTL_REV_I(0) /*!< input data not reverse */
  44. #define CRC_INPUT_DATA_BYTE CTL_REV_I(1) /*!< input data reversed by byte type */
  45. #define CRC_INPUT_DATA_HALFWORD CTL_REV_I(2) /*!< input data reversed by half-word type */
  46. #define CRC_INPUT_DATA_WORD CTL_REV_I(3) /*!< input data reversed by word type */
  47. /* function declarations */
  48. /* deinit CRC calculation unit */
  49. void crc_deinit(void);
  50. /* enable the reverse operation of output data */
  51. void crc_reverse_output_data_enable(void);
  52. /* disable the reverse operation of output data */
  53. void crc_reverse_output_data_disable(void);
  54. /* reset data register to the value of initializaiton data register */
  55. void crc_data_register_reset(void);
  56. /* read the data register */
  57. uint32_t crc_data_register_read(void);
  58. /* read the free data register */
  59. uint8_t crc_free_data_register_read(void);
  60. /* write the free data register */
  61. void crc_free_data_register_write(uint8_t free_data);
  62. /* write the initial value register */
  63. void crc_init_data_register_write(uint32_t init_data);
  64. /* configure the CRC input data function */
  65. void crc_input_data_reverse_config(uint32_t data_reverse);
  66. /* configure the CRC size of polynomial function */
  67. void crc_polynomial_size_set(uint32_t poly_size);
  68. /* configure the CRC polynomial value function */
  69. void crc_polynomial_set(uint32_t poly);
  70. /* CRC calculate a 32-bit data */
  71. uint32_t crc_single_data_calculate(uint32_t sdata);
  72. /* CRC calculate a 32-bit data array */
  73. uint32_t crc_block_data_calculate(uint32_t array[], uint32_t size);
  74. #endif /* GD32F3X0_CRC_H */