hc32f460_boot/mcu/lib/inc/hc32_ll_crc.h

/**
 *******************************************************************************
 * @file  hc32_ll_crc.h
 * @brief This file contains all the functions prototypes of the CRC driver
 *        library.
 @verbatim
   Change Logs:
   Date             Author          Notes
   2022-03-31       CDT             First version
   2023-06-30       CDT             Reconstruct interface function relate to calculate CRC
                                    Modify return type of function CRC_DeInit
   2023-09-30       CDT             Modify comment
                                    Delete and modify some of group/function relate to calculate CRC
 @endverbatim
 *******************************************************************************
 * Copyright (C) 2022-2023, Xiaohua Semiconductor Co., Ltd. All rights reserved.
 *
 * This software component is licensed by XHSC under BSD 3-Clause license
 * (the "License"); You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at:
 *                    opensource.org/licenses/BSD-3-Clause
 *
 *******************************************************************************
 */
#ifndef __HC32_LL_CRC_H__
#define __HC32_LL_CRC_H__

/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C"
{
#endif

/*******************************************************************************
 * Include files
 ******************************************************************************/
#include "hc32_ll_def.h"

#include "hc32f4xx.h"
#include "hc32f4xx_conf.h"

/**
 * @addtogroup LL_Driver
 * @{
 */

/**
 * @addtogroup LL_CRC
 * @{
 */

#if (LL_CRC_ENABLE == DDL_ON)

/*******************************************************************************
 * Global type definitions ('typedef')
 ******************************************************************************/
/**
 * @defgroup CRC_Global_Types CRC Global Types
 * @{
 */

/**
 * @brief CRC initialization structure definition
 */
typedef struct {
    uint32_t u32Protocol;   /*!< Specifies CRC Protocol.
                                 This parameter can be a value of @ref CRC_Protocol_Control_Bit */
    uint32_t u32InitValue;  /*!< Specifies initial CRC value.
                                 This parameter can be CRC_INIT_VALUE_DEFAULT @ref CRC_Init_Value_Default */
    uint32_t u32RefIn;      /*!< Specifies CRC Retroflexion Input.
                                 This parameter can be a value of @ref CRC_Retroflexion_Input */
    uint32_t u32RefOut;     /*!< Specifies CRC Retroflexion Output.
                                 This parameter can be a value of @ref CRC_Retroflexion_Output */
    uint32_t u32XorOut;     /*!< Specifies CRC XOR Output.
                                 This parameter can be a value of @ref CRC_XOR_Output */
} stc_crc_init_t;

/**
 * @}
 */

/*******************************************************************************
 * Global pre-processor symbols/macros ('#define')
 ******************************************************************************/
/**
 * @defgroup CRC_Global_Macros CRC Global Macros
 * @{
 */

/**
 * @defgroup CRC_Protocol_Control_Bit CRC Protocol Control Bit
 * @{
 */
#define CRC_CRC16                   (0x0UL)
#define CRC_CRC32                   (CRC_CR_CR)
/**
 * @}
 */

/**
 * @defgroup CRC_DATA_Bit_Width CRC Data Bit Width
 * @{
 */
#define CRC_DATA_WIDTH_8BIT         (1U)
#define CRC_DATA_WIDTH_16BIT        (2U)
#define CRC_DATA_WIDTH_32BIT        (4U)
/**
 * @}
 */

/**
 * @defgroup CRC_Init_Value_Default CRC Default Computation Initialization Value
 * @{
 */
#define CRC_INIT_VALUE_DEFAULT      (0xFFFFFFFFUL)
/**
 * @}
 */

/**
 * @defgroup CRC_Retroflexion_Input CRC Retroflexion Input
 * @{
 */
#define CRC_REFIN_DISABLE           (0x0UL)
#define CRC_REFIN_ENABLE            (CRC_CR_REFIN)
/**
 * @}
 */

/**
 * @defgroup CRC_Retroflexion_Output CRC Retroflexion Output
 * @{
 */
#define CRC_REFOUT_DISABLE          (0x0UL)
#define CRC_REFOUT_ENABLE           (CRC_CR_REFOUT)
/**
 * @}
 */

/**
 * @defgroup CRC_XOR_Output CRC XOR Output
 * @{
 */
#define CRC_XOROUT_DISABLE          (0x0UL)
#define CRC_XOROUT_ENABLE           (CRC_CR_XOROUT)
/**
 * @}
 */

/**
 * @}
 */

/*******************************************************************************
 * Global variable definitions ('extern')
 ******************************************************************************/

/*******************************************************************************
  Global function prototypes (definition in C source)
 ******************************************************************************/
/**
 * @addtogroup CRC_Global_Functions
 * @{
 */
int32_t CRC_StructInit(stc_crc_init_t *pstcCrcInit);
int32_t CRC_Init(const stc_crc_init_t *pstcCrcInit);
int32_t CRC_DeInit(void);

en_flag_status_t CRC_GetResultStatus(void);

uint16_t CRC_CRC16_AccumulateData(uint8_t u8DataWidth, const void *pvData, uint32_t u32Len);
uint16_t CRC_CRC16_Calculate(uint16_t u16InitValue, uint8_t u8DataWidth, const void *pvData, uint32_t u32Len);
en_flag_status_t CRC_CRC16_CheckData(uint16_t u16InitValue, uint8_t u8DataWidth, const void *pvData, uint32_t u32Len, uint16_t u16ExpectValue);
en_flag_status_t CRC_CRC16_GetCheckResult(uint16_t u16ExpectValue);

uint32_t CRC_CRC32_AccumulateData(uint8_t u8DataWidth, const void *pvData, uint32_t u32Len);
uint32_t CRC_CRC32_Calculate(uint32_t u32InitValue, uint8_t u8DataWidth, const void *pvData, uint32_t u32Len);
en_flag_status_t CRC_CRC32_CheckData(uint32_t u32InitValue, uint8_t u8DataWidth, const void *pvData, uint32_t u32Len, uint32_t u32ExpectValue);
en_flag_status_t CRC_CRC32_GetCheckResult(uint32_t u32ExpectValue);

/**
 * @}
 */

#endif /* LL_CRC_ENABLE */

/**
 * @}
 */

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif /* __HC32_LL_CRC_H__ */

/*******************************************************************************
 * EOF (not truncated)
 ******************************************************************************/