hpm_crc_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2022 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_CRC_DRV_H
#define HPM_CRC_DRV_H
 
#include "hpm_common.h"
#include "hpm_crc_regs.h"
 
typedef enum crc_preset_enum {
    crc_preset_none = 0,
    crc_preset_crc32,         
    crc_preset_crc32_autosar, 
    crc_preset_crc16_ccitt,   
    crc_preset_crc16_xmodem,  
    crc_preset_crc16_modbus,  
    crc_preset_crc16_dnp,     
    crc_preset_crc16_x25,     
    crc_preset_crc16_usb,     
    crc_preset_crc16_maxim,   
    crc_preset_crc16_ibm,     
    crc_preset_crc8_maxim,    
    crc_preset_crc8_rohc,     
    crc_preset_crc8_itu,      
    crc_preset_crc8,          
    crc_preset_crc5_usb,      
} crc_preset_t;
 
typedef enum crc_refin_enum {
    crc_refin_false = 0, 
    crc_refin_true = 1,  
} crc_refin_t;
 
typedef enum crc_refout_enum {
    crc_refout_false = 0, 
    crc_refout_true = 1,  
} crc_refout_t;
 
typedef enum crc_in_byte_order_enum {
    crc_in_byte_order_lsb = 0, 
    crc_in_byte_order_msb = 1,  
} crc_in_byte_order_t;
 
#define CRC_POLY_WIDTH_4 (4U)
#define CRC_POLY_WIDTH_5 (5U)
#define CRC_POLY_WIDTH_6 (6U)
#define CRC_POLY_WIDTH_7 (7U)
#define CRC_POLY_WIDTH_8 (8U)
#define CRC_POLY_WIDTH_16 (16U)
#define CRC_POLY_WIDTH_24 (24U)
#define CRC_POLY_WIDTH_32 (32U)
 
typedef struct crc_channel_config {
    crc_preset_t preset;               
    uint32_t init;                     
    uint32_t poly;                     
    uint32_t poly_width;               
    crc_in_byte_order_t in_byte_order; 
    crc_refout_t refout;               
    crc_refin_t refin;                 
    uint32_t xorout;                   
} crc_channel_config_t;
 
#define CRC_REG_WRITE8(addr, data)\
{\
    uint32_t addr32 = (uint32_t)(addr);\
    (*(volatile uint8_t *)(addr32) = (data));\
}
 
#define CRC_REG_WRITE16(addr, data)\
{\
    uint32_t addr32 = (uint32_t)(addr);\
    (*(volatile uint16_t *)(addr32) = (data));\
}
 
#define CRC_REG_WRITE32(addr, data)\
{\
    uint32_t addr32 = (uint32_t)(addr);\
    (*(volatile uint32_t *)(addr32) = (data));\
}
 
#ifdef __cplusplus
extern "C" {
#endif
 
void crc_get_default_channel_config(crc_channel_config_t *cfg);
 
hpm_stat_t crc_setup_channel_config(CRC_Type *ptr, uint32_t ch_index,
                            crc_channel_config_t *cfg);
 
static inline void crc_calc_byte(CRC_Type *ptr, uint32_t ch_index, uint8_t data)
{
    CRC_REG_WRITE8(&ptr->CHN[ch_index].DATA, data);
}
 
void crc_calc_block_bytes(CRC_Type *ptr, uint32_t ch_index, uint8_t *pbuffer, uint32_t length);
 
static inline void crc_calc_half_word(CRC_Type *ptr, uint32_t ch_index, uint16_t data)
{
    CRC_REG_WRITE16(&ptr->CHN[ch_index].DATA, data);
}
 
void crc_calc_block_half_words(CRC_Type *ptr, uint32_t ch_index, uint16_t *pbuffer, uint32_t length);
 
static inline void crc_calc_word(CRC_Type *ptr, uint32_t ch_index, uint32_t data)
{
    CRC_REG_WRITE32(&ptr->CHN[ch_index].DATA, data);
}
 
void crc_calc_block_words(CRC_Type *ptr, uint32_t ch_index, uint32_t *pbuffer, uint32_t length);
 
void crc_calc_large_block_fast(CRC_Type *ptr, uint32_t ch_index, uint8_t *pbuffer, uint32_t length);
 
static inline uint32_t crc_get_result(CRC_Type *ptr, uint32_t ch_index)
{
    return ptr->CHN[ch_index].RESULT;
}
#ifdef __cplusplus
}
#endif
 
#endif /* HPM_CRC_DRV_H */