138 lines
5.8 KiB
C
138 lines
5.8 KiB
C
/**************************************************************************//**
|
|
* @file crc.h
|
|
* @version V3.00
|
|
* @brief Cyclic Redundancy Check(CRC) driver header file
|
|
*
|
|
* @copyright (C) 2019 Nuvoton Technology Corp. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
* 3. Neither the name of Nuvoton Technology Corp. nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*****************************************************************************/
|
|
#ifndef __CRC_H__
|
|
#define __CRC_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
|
|
/** @addtogroup Standard_Driver Standard Driver
|
|
@{
|
|
*/
|
|
|
|
/** @addtogroup CRC_Driver CRC Driver
|
|
@{
|
|
*/
|
|
|
|
/** @addtogroup CRC_EXPORTED_CONSTANTS CRC Exported Constants
|
|
@{
|
|
*/
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* CRC Polynomial Mode Constant Definitions */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
#define CRC_CCITT (0UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CCITT \hideinitializer */
|
|
#define CRC_8 (1UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CRC8 \hideinitializer */
|
|
#define CRC_16 (2UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CRC16 \hideinitializer */
|
|
#define CRC_32 (3UL << CRC_CTL_CRCMODE_Pos) /*!<CRC Polynomial Mode - CRC32 \hideinitializer */
|
|
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* Checksum, Write data Constant Definitions */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
#define CRC_CHECKSUM_COM (CRC_CTL_CHKSFMT_Msk) /*!<CRC Checksum Complement \hideinitializer */
|
|
#define CRC_CHECKSUM_RVS (CRC_CTL_CHKSREV_Msk) /*!<CRC Checksum Reverse \hideinitializer */
|
|
#define CRC_WDATA_COM (CRC_CTL_DATFMT_Msk) /*!<CRC Write Data Complement \hideinitializer */
|
|
#define CRC_WDATA_RVS (CRC_CTL_DATREV_Msk) /*!<CRC Write Data Reverse \hideinitializer */
|
|
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
/* CPU Write Data Length Constant Definitions */
|
|
/*---------------------------------------------------------------------------------------------------------*/
|
|
#define CRC_CPU_WDATA_8 (0UL << CRC_CTL_DATLEN_Pos) /*!<CRC CPU Write Data length is 8-bit \hideinitializer */
|
|
#define CRC_CPU_WDATA_16 (1UL << CRC_CTL_DATLEN_Pos) /*!<CRC CPU Write Data length is 16-bit \hideinitializer */
|
|
#define CRC_CPU_WDATA_32 (2UL << CRC_CTL_DATLEN_Pos) /*!<CRC CPU Write Data length is 32-bit \hideinitializer */
|
|
|
|
/*@}*/ /* end of group CRC_EXPORTED_CONSTANTS */
|
|
|
|
|
|
/** @addtogroup CRC_EXPORTED_FUNCTIONS CRC Exported Functions
|
|
@{
|
|
*/
|
|
|
|
/**
|
|
* @brief Set CRC Seed Value
|
|
*
|
|
* @param[in] crc The pointer of CRC module.
|
|
* @param[in] u32Seed Seed value
|
|
*
|
|
* @return None
|
|
*
|
|
* @details This macro is used to set CRC seed value.
|
|
*
|
|
* @note User must to perform CRC_CHKSINIT(CRC_CTL[1] CRC Engine Reset) to reload the new seed value
|
|
* to CRC controller.
|
|
* \hideinitializer
|
|
*/
|
|
#define CRC_SET_SEED(crc, u32Seed) do{ (crc)->SEED = (u32Seed); (crc)->CTL |= CRC_CTL_CHKSINIT_Msk; }while(0)
|
|
|
|
/**
|
|
* @brief Get CRC Seed Value
|
|
*
|
|
* @param[in] crc The pointer of CRC module.
|
|
*
|
|
* @return CRC seed value
|
|
*
|
|
* @details This macro gets the current CRC seed value.
|
|
* \hideinitializer
|
|
*/
|
|
#define CRC_GET_SEED(crc) ((crc)->SEED)
|
|
|
|
/**
|
|
* @brief CRC Write Data
|
|
*
|
|
* @param[in] crc The pointer of CRC module.
|
|
* @param[in] u32Data Write data
|
|
*
|
|
* @return None
|
|
*
|
|
* @details User can write data directly to CRC Write Data Register(CRC_DAT) by this macro to perform CRC operation.
|
|
* \hideinitializer
|
|
*/
|
|
#define CRC_WRITE_DATA(crc, u32Data) ((crc)->DAT = (u32Data))
|
|
|
|
|
|
void CRC_Open(uint32_t u32Mode, uint32_t u32Attribute, uint32_t u32Seed, uint32_t u32DataLen);
|
|
uint32_t CRC_GetChecksum(void);
|
|
|
|
/*@}*/ /* end of group CRC_EXPORTED_FUNCTIONS */
|
|
|
|
/*@}*/ /* end of group CRC_Driver */
|
|
|
|
/*@}*/ /* end of group Standard_Driver */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __CRC_H__ */
|
|
|
|
/*** (C) COPYRIGHT 2019 Nuvoton Technology Corp. ***/
|