lib/main/AT32F43x/Drivers/AT32F43x_StdPeriph_Driver/inc/at32f435_437_crc.h

   1 /**
   2   **************************************************************************
   3   * @file     at32f435_437_crc.h
   4   * @version  v2.1.0
   5   * @date     2022-08-16
   6   * @brief    at32f435_437 crc header file
   7   **************************************************************************
   8   *                       Copyright notice & Disclaimer
   9   *
  10   * The software Board Support Package (BSP) that is made available to
  11   * download from Artery official website is the copyrighted work of Artery.
  12   * Artery authorizes customers to use, copy, and distribute the BSP
  13   * software and its related documentation for the purpose of design and
  14   * development in conjunction with Artery microcontrollers. Use of the
  15   * software is governed by this copyright notice and the following disclaimer.
  16   *
  17   * THIS SOFTWARE IS PROVIDED ON "AS IS" BASIS WITHOUT WARRANTIES,
  18   * GUARANTEES OR REPRESENTATIONS OF ANY KIND. ARTERY EXPRESSLY DISCLAIMS,
  19   * TO THE FULLEST EXTENT PERMITTED BY LAW, ALL EXPRESS, IMPLIED OR
  20   * STATUTORY OR OTHER WARRANTIES, GUARANTEES OR REPRESENTATIONS,
  21   * INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
  22   * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  23   *
  24   **************************************************************************
  25   */
  26
  27 /* define to prevent recursive inclusion -------------------------------------*/
  28 #ifndef __AT32F435_437_CRC_H
  29 #define __AT32F435_437_CRC_H
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35
  36 /* includes ------------------------------------------------------------------*/
  37 #include "at32f435_437.h"
  38
  39 /** @addtogroup AT32F435_437_periph_driver
  40   * @{
  41   */
  42
  43 /** @addtogroup  CRC
  44   * @{
  45   */
  46
  47 /** @defgroup CRC_exported_types
  48   * @{
  49   */
  50
  51 /**
  52   * @brief crc reverse input data
  53   */
  54 typedef enum
  55 {
  56   CRC_REVERSE_INPUT_NO_AFFECTE           = 0x00, /*!< input data no reverse */
  57   CRC_REVERSE_INPUT_BY_BYTE              = 0x01, /*!< input data reverse by byte */
  58   CRC_REVERSE_INPUT_BY_HALFWORD          = 0x02, /*!< input data reverse by half word */
  59   CRC_REVERSE_INPUT_BY_WORD              = 0x03  /*!< input data reverse by word */
  60 } crc_reverse_input_type;
  61
  62 /**
  63   * @brief crc reverse output data
  64   */
  65 typedef enum
  66 {
  67   CRC_REVERSE_OUTPUT_NO_AFFECTE          = 0x00, /*!< output data no reverse */
  68   CRC_REVERSE_OUTPUT_DATA                = 0x01  /*!< output data reverse by word */
  69 } crc_reverse_output_type;
  70
  71 /**
  72  * @brief type define crc register all
  73  */
  74 typedef struct
  75 {
  76   /**
  77     * @brief crc dt register, offset:0x00
  78     */
  79   union
  80   {
  81     __IO uint32_t dt;
  82     struct
  83     {
  84       __IO uint32_t dt                   : 32; /* [31:0] */
  85     } dt_bit;
  86   };
  87
  88   /**
  89     * @brief crc cdt register, offset:0x04
  90     */
  91   union
  92   {
  93     __IO uint32_t cdt;
  94     struct
  95     {
  96       __IO uint32_t cdt                  : 8 ; /* [7:0] */
  97       __IO uint32_t reserved1            : 24 ;/* [31:8] */
  98     } cdt_bit;
  99   };
 100
 101   /**
 102     * @brief crc ctrl register, offset:0x08
 103     */
 104   union
 105   {
 106     __IO uint32_t ctrl;
 107     struct
 108     {
 109       __IO uint32_t rst                  : 1 ; /* [0] */
 110       __IO uint32_t reserved1            : 4 ; /* [4:1] */
 111       __IO uint32_t revid                : 2 ; /* [6:5] */
 112       __IO uint32_t revod                : 1 ; /* [7] */
 113       __IO uint32_t reserved2            : 24 ;/* [31:8] */
 114     } ctrl_bit;
 115   };
 116
 117   /**
 118     * @brief crm reserved1 register, offset:0x0C
 119     */
 120   __IO uint32_t reserved1;
 121
 122   /**
 123     * @brief crc idt register, offset:0x10
 124     */
 125   union
 126   {
 127     __IO uint32_t idt;
 128     struct
 129     {
 130       __IO uint32_t idt                  : 32; /* [31:0] */
 131     } idt_bit;
 132   };
 133
 134 } crc_type;
 135
 136 /**
 137   * @}
 138   */
 139
 140 #define CRC                              ((crc_type *) CRC_BASE)
 141
 142 /** @defgroup CRC_exported_functions
 143   * @{
 144   */
 145
 146 void crc_data_reset(void);
 147 uint32_t crc_one_word_calculate(uint32_t data);
 148 uint32_t crc_block_calculate(uint32_t *pbuffer, uint32_t length);
 149 uint32_t crc_data_get(void);
 150 void crc_common_data_set(uint8_t cdt_value);
 151 uint8_t crc_common_data_get(void);
 152 void crc_init_data_set(uint32_t value);
 153 void crc_reverse_input_data_set(crc_reverse_input_type value);
 154 void crc_reverse_output_data_set(crc_reverse_output_type value);
 155
 156 /**
 157   * @}
 158   */
 159
 160 /**
 161   * @}
 162   */
 163
 164 /**
 165   * @}
 166   */
 167
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171
 172 #endif