crc_001.h

Go to the documentation of this file.

/*
 * @brief Cyclic Redundancy Check (CRC) registers and driver functions
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __CRC_001_H_
#define __CRC_001_H_

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {     
 __IO    uint32_t    MODE;  
 __IO    uint32_t    SEED;  
 union {
  __I     uint32_t    SUM; 
  __O     uint32_t    WRDATA32; 
  __O     uint16_t    WRDATA16; 
  __O     uint8_t     WRDATA8; 
 };

} IP_CRC_001_T;

#define CRC_MODE_POLY_BITMASK   ((0x03)) 
#define CRC_MODE_POLY_CCITT     (0x00)  
#define CRC_MODE_POLY_CRC16     (0x01)  
#define CRC_MODE_POLY_CRC32     (0x02)  
#define CRC_MODE_WRDATA_BITMASK (0x03 << 2) 
#define CRC_MODE_WRDATA_BIT_RVS (1 << 2) 
#define CRC_MODE_WRDATA_CMPL    (1 << 3) 
#define CRC_MODE_SUM_BITMASK    (0x03 << 4) 
#define CRC_MODE_SUM_BIT_RVS    (1 << 4) 
#define CRC_MODE_SUM_CMPL       (1 << 5) 
#define MODE_CFG_CCITT      (0x00) 
#define MODE_CFG_CRC16      (0x15) 
#define MODE_CFG_CRC32      (0x36) 
#define CRC_SEED_CCITT  (0x0000FFFF)
#define CRC_SEED_CRC16  (0x00000000)
#define CRC_SEED_CRC32  (0xFFFFFFFF)
/*
 * @brief CRC polynomial
 */
typedef enum IP_CRC_001_POLY {
 CRC_POLY_CCITT = CRC_MODE_POLY_CCITT, 
 CRC_POLY_CRC16 = CRC_MODE_POLY_CRC16, 
 CRC_POLY_CRC32 = CRC_MODE_POLY_CRC32, 
 CRC_POLY_LAST,
} IP_CRC_001_POLY_T;

STATIC INLINE void IP_CRC_Init(IP_CRC_001_T *pCRC) {}

STATIC INLINE void IP_CRC_DeInit(IP_CRC_001_T *pCRC) {}

STATIC INLINE void IP_CRC_SetPoly(IP_CRC_001_T *pCRC, IP_CRC_001_POLY_T poly,
          uint32_t flags)
{
 pCRC->MODE = (uint32_t) poly | flags;
}

void IP_CRC_UseDefaultConfig(IP_CRC_001_T *pCRC, IP_CRC_001_POLY_T poly);

STATIC INLINE uint32_t IP_CRC_GetMode(IP_CRC_001_T *pCRC)
{
 return pCRC->MODE;
}

STATIC INLINE void IP_CRC_SetMode(IP_CRC_001_T *pCRC, uint32_t mode)
{
 pCRC->MODE = mode;
}

STATIC INLINE void IP_CRC_SetSeed(IP_CRC_001_T *pCRC, uint32_t Seed)
{
 pCRC->SEED = Seed;
}

STATIC INLINE uint32_t IP_CRC_GetSeed(IP_CRC_001_T *pCRC)
{
 return pCRC->SEED;
}

STATIC INLINE void IP_CRC_Write8(IP_CRC_001_T *pCRC, uint8_t data)
{
 pCRC->WRDATA8 = data;
}

STATIC INLINE void IP_CRC_Write16(IP_CRC_001_T *pCRC, uint16_t data)
{
 pCRC->WRDATA16 = (uint32_t) data;
}

STATIC INLINE void IP_CRC_Write32(IP_CRC_001_T *pCRC, uint32_t data)
{
 pCRC->WRDATA32 = data;
}

STATIC INLINE uint32_t IP_CRC_ReadSum(IP_CRC_001_T *pCRC)
{
 return pCRC->SUM;
}

uint32_t IP_CRC_CRC8(IP_CRC_001_T *pCRC, const uint8_t *data, uint32_t bytes);

uint32_t IP_CRC_CRC16(IP_CRC_001_T *pCRC, const uint16_t *data, uint32_t hwords);

uint32_t IP_CRC_CRC32(IP_CRC_001_T *pCRC, const uint32_t *data, uint32_t words);

#ifdef __cplusplus
}
#endif

#endif /* __CRC_001_H_ */