git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MPU_M23_Nuvoton_NuMaker_PFM_M2351_IAR_GCC/Nuvoton_Code/StdDriver/inc/crc.h

   1 /**************************************************************************//**\r
   2  * @file     crc.h\r
   3  * @version  V3.00\r
   4  * @brief    Cyclic Redundancy Check(CRC) driver header file\r
   5  *\r
   6  * @copyright (C) 2016 Nuvoton Technology Corp. All rights reserved.\r
   7  *****************************************************************************/\r
   8 #ifndef __CRC_H__\r
   9 #define __CRC_H__\r
  10 \r
  11 #ifdef __cplusplus\r
  12 extern "C"\r
  13 {\r
  14 #endif\r
  15 \r
  16 \r
  17 /** @addtogroup Standard_Driver Standard Driver\r
  18   @{\r
  19 */\r
  20 \r
  21 /** @addtogroup CRC_Driver CRC Driver\r
  22   @{\r
  23 */\r
  24 \r
  25 /** @addtogroup CRC_EXPORTED_CONSTANTS CRC Exported Constants\r
  26   @{\r
  27 */\r
  28 /*---------------------------------------------------------------------------------------------------------*/\r
  29 /*  CRC Polynomial Mode Constant Definitions                                                               */\r
  30 /*---------------------------------------------------------------------------------------------------------*/\r
  31 #define CRC_CCITT           (0UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CCITT \hideinitializer */\r
  32 #define CRC_8               (1UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CRC8 \hideinitializer */\r
  33 #define CRC_16              (2UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CRC16 \hideinitializer */\r
  34 #define CRC_32              (3UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CRC32 \hideinitializer */\r
  35 \r
  36 /*---------------------------------------------------------------------------------------------------------*/\r
  37 /*  Checksum, Write data Constant Definitions                                                              */\r
  38 /*---------------------------------------------------------------------------------------------------------*/\r
  39 #define CRC_CHECKSUM_COM    (CRC_CTL_CHKSFMT_Msk)       /*!<CRC Checksum Complement \hideinitializer */\r
  40 #define CRC_CHECKSUM_RVS    (CRC_CTL_CHKSREV_Msk)       /*!<CRC Checksum Reverse \hideinitializer */\r
  41 #define CRC_WDATA_COM       (CRC_CTL_DATFMT_Msk)        /*!<CRC Write Data Complement \hideinitializer */\r
  42 #define CRC_WDATA_RVS       (CRC_CTL_DATREV_Msk)        /*!<CRC Write Data Reverse \hideinitializer */\r
  43 \r
  44 /*---------------------------------------------------------------------------------------------------------*/\r
  45 /*  CPU Write Data Length Constant Definitions                                                             */\r
  46 /*---------------------------------------------------------------------------------------------------------*/\r
  47 #define CRC_CPU_WDATA_8     (0UL << CRC_CTL_DATLEN_Pos) /*!<CRC CPU Write Data length is 8-bit \hideinitializer */\r
  48 #define CRC_CPU_WDATA_16    (1UL << CRC_CTL_DATLEN_Pos) /*!<CRC CPU Write Data length is 16-bit \hideinitializer */\r
  49 #define CRC_CPU_WDATA_32    (2UL << CRC_CTL_DATLEN_Pos) /*!<CRC CPU Write Data length is 32-bit \hideinitializer */\r
  50 \r
  51 /*@}*/ /* end of group CRC_EXPORTED_CONSTANTS */\r
  52 \r
  53 \r
  54 /** @addtogroup CRC_EXPORTED_FUNCTIONS CRC Exported Functions\r
  55   @{\r
  56 */\r
  57 \r
  58 /**\r
  59   * @brief      Set CRC Seed Value\r
  60   *\r
  61   * @param[in]  crc         The pointer of CRC module.\r
  62   * @param[in]  u32Seed     Seed value\r
  63   *\r
  64   * @return     None\r
  65   *\r
  66   * @details    This macro is used to set CRC seed value.\r
  67   *\r
  68   * @note       User must to perform CRC_CHKSINIT(CRC_CTL[1] CRC Engine Reset) to reload the new seed value\r
  69   *             to CRC controller.\r
  70   * \hideinitializer\r
  71   */\r
  72 #define CRC_SET_SEED(crc, u32Seed)          do{ (crc)->SEED = (u32Seed); (crc)->CTL |= CRC_CTL_CHKSINIT_Msk; }while(0)\r
  73 \r
  74 /**\r
  75   * @brief      Get CRC Seed Value\r
  76   *\r
  77   * @param[in]  crc         The pointer of CRC module.\r
  78   *\r
  79   * @return     CRC seed value\r
  80   *\r
  81   * @details    This macro gets the current CRC seed value.\r
  82  * \hideinitializer\r
  83   */\r
  84 #define CRC_GET_SEED(crc)                   ((crc)->SEED)\r
  85 \r
  86 /**\r
  87   * @brief      CRC Write Data\r
  88   *\r
  89   * @param[in]  crc         The pointer of CRC module.\r
  90   * @param[in]  u32Data     Write data\r
  91   *\r
  92   * @return     None\r
  93   *\r
  94   * @details    User can write data directly to CRC Write Data Register(CRC_DAT) by this macro to perform CRC operation.\r
  95  * \hideinitializer\r
  96   */\r
  97 #define CRC_WRITE_DATA(crc, u32Data)        ((crc)->DAT = (u32Data))\r
  98 \r
  99 \r
 100 void CRC_Open(uint32_t u32Mode, uint32_t u32Attribute, uint32_t u32Seed, uint32_t u32DataLen);\r
 101 uint32_t CRC_GetChecksum(void);\r
 102 \r
 103 /*@}*/ /* end of group CRC_EXPORTED_FUNCTIONS */\r
 104 \r
 105 /*@}*/ /* end of group CRC_Driver */\r
 106 \r
 107 /*@}*/ /* end of group Standard_Driver */\r
 108 \r
 109 #ifdef __cplusplus\r
 110 }\r
 111 #endif\r
 112 \r
 113 #endif /* __CRC_H__ */\r
 114 \r
 115 /*** (C) COPYRIGHT 2016 Nuvoton Technology Corp. ***/\r