Rizky Ardi Maulana / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

targets/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_K22F/drivers/fsl_crc.c@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /*
elessair 0:f269e3021894 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
elessair 0:f269e3021894 3 * All rights reserved.
elessair 0:f269e3021894 4 *
elessair 0:f269e3021894 5 * Redistribution and use in source and binary forms, with or without modification,
elessair 0:f269e3021894 6 * are permitted provided that the following conditions are met:
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * o Redistributions of source code must retain the above copyright notice, this list
elessair 0:f269e3021894 9 * of conditions and the following disclaimer.
elessair 0:f269e3021894 10 *
elessair 0:f269e3021894 11 * o Redistributions in binary form must reproduce the above copyright notice, this
elessair 0:f269e3021894 12 * list of conditions and the following disclaimer in the documentation and/or
elessair 0:f269e3021894 13 * other materials provided with the distribution.
elessair 0:f269e3021894 14 *
elessair 0:f269e3021894 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
elessair 0:f269e3021894 16 * contributors may be used to endorse or promote products derived from this
elessair 0:f269e3021894 17 * software without specific prior written permission.
elessair 0:f269e3021894 18 *
elessair 0:f269e3021894 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
elessair 0:f269e3021894 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
elessair 0:f269e3021894 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
elessair 0:f269e3021894 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
elessair 0:f269e3021894 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
elessair 0:f269e3021894 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
elessair 0:f269e3021894 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
elessair 0:f269e3021894 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
elessair 0:f269e3021894 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
elessair 0:f269e3021894 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
elessair 0:f269e3021894 29 */
elessair 0:f269e3021894 30 #include "fsl_crc.h"
elessair 0:f269e3021894 31
elessair 0:f269e3021894 32 /*******************************************************************************
elessair 0:f269e3021894 33 * Definitions
elessair 0:f269e3021894 34 ******************************************************************************/
elessair 0:f269e3021894 35
elessair 0:f269e3021894 36 #if defined(CRC_DRIVER_USE_CRC16_CCIT_FALSE_AS_DEFAULT) && CRC_DRIVER_USE_CRC16_CCIT_FALSE_AS_DEFAULT
elessair 0:f269e3021894 37 /* @brief Default user configuration structure for CRC-16-CCITT */
elessair 0:f269e3021894 38 #define CRC_DRIVER_DEFAULT_POLYNOMIAL 0x1021U
elessair 0:f269e3021894 39 /*< CRC-16-CCIT polynomial x**16 + x**12 + x**5 + x**0 */
elessair 0:f269e3021894 40 #define CRC_DRIVER_DEFAULT_SEED 0xFFFFU
elessair 0:f269e3021894 41 /*< Default initial checksum */
elessair 0:f269e3021894 42 #define CRC_DRIVER_DEFAULT_REFLECT_IN false
elessair 0:f269e3021894 43 /*< Default is no transpose */
elessair 0:f269e3021894 44 #define CRC_DRIVER_DEFAULT_REFLECT_OUT false
elessair 0:f269e3021894 45 /*< Default is transpose bytes */
elessair 0:f269e3021894 46 #define CRC_DRIVER_DEFAULT_COMPLEMENT_CHECKSUM false
elessair 0:f269e3021894 47 /*< Default is without complement of CRC data register read data */
elessair 0:f269e3021894 48 #define CRC_DRIVER_DEFAULT_CRC_BITS kCrcBits16
elessair 0:f269e3021894 49 /*< Default is 16-bit CRC protocol */
elessair 0:f269e3021894 50 #define CRC_DRIVER_DEFAULT_CRC_RESULT kCrcFinalChecksum
elessair 0:f269e3021894 51 /*< Default is resutl type is final checksum */
elessair 0:f269e3021894 52 #endif /* CRC_DRIVER_USE_CRC16_CCIT_FALSE_AS_DEFAULT */
elessair 0:f269e3021894 53
elessair 0:f269e3021894 54 /*! @brief CRC type of transpose of read write data */
elessair 0:f269e3021894 55 typedef enum _crc_transpose_type
elessair 0:f269e3021894 56 {
elessair 0:f269e3021894 57 kCrcTransposeNone = 0U, /*! No transpose */
elessair 0:f269e3021894 58 kCrcTransposeBits = 1U, /*! Tranpose bits in bytes */
elessair 0:f269e3021894 59 kCrcTransposeBitsAndBytes = 2U, /*! Transpose bytes and bits in bytes */
elessair 0:f269e3021894 60 kCrcTransposeBytes = 3U, /*! Transpose bytes */
elessair 0:f269e3021894 61 } crc_transpose_type_t;
elessair 0:f269e3021894 62
elessair 0:f269e3021894 63 /*!
elessair 0:f269e3021894 64 * @brief CRC module configuration.
elessair 0:f269e3021894 65 *
elessair 0:f269e3021894 66 * This structure holds the configuration for the CRC module.
elessair 0:f269e3021894 67 */
elessair 0:f269e3021894 68 typedef struct _crc_module_config
elessair 0:f269e3021894 69 {
elessair 0:f269e3021894 70 uint32_t polynomial; /*!< CRC Polynomial, MSBit first.@n
elessair 0:f269e3021894 71 Example polynomial: 0x1021 = 1_0000_0010_0001 = x^12+x^5+1 */
elessair 0:f269e3021894 72 uint32_t seed; /*!< Starting checksum value */
elessair 0:f269e3021894 73 crc_transpose_type_t readTranspose; /*!< Type of transpose when reading CRC result. */
elessair 0:f269e3021894 74 crc_transpose_type_t writeTranspose; /*!< Type of transpose when writing CRC input data. */
elessair 0:f269e3021894 75 bool complementChecksum; /*!< True if the result shall be complement of the actual checksum. */
elessair 0:f269e3021894 76 crc_bits_t crcBits; /*!< Selects 16- or 32- bit CRC protocol. */
elessair 0:f269e3021894 77 } crc_module_config_t;
elessair 0:f269e3021894 78
elessair 0:f269e3021894 79 /*******************************************************************************
elessair 0:f269e3021894 80 * Code
elessair 0:f269e3021894 81 ******************************************************************************/
elessair 0:f269e3021894 82
elessair 0:f269e3021894 83 /*!
elessair 0:f269e3021894 84 * @brief Returns transpose type for CRC protocol reflect in parameter.
elessair 0:f269e3021894 85 *
elessair 0:f269e3021894 86 * This functions helps to set writeTranspose member of crc_config_t structure. Reflect in is CRC protocol parameter.
elessair 0:f269e3021894 87 *
elessair 0:f269e3021894 88 * @param enable True or false for the selected CRC protocol Reflect In (refin) parameter.
elessair 0:f269e3021894 89 */
elessair 0:f269e3021894 90 static inline crc_transpose_type_t crc_GetTransposeTypeFromReflectIn(bool enable)
elessair 0:f269e3021894 91 {
elessair 0:f269e3021894 92 return ((enable) ? kCrcTransposeBitsAndBytes : kCrcTransposeBytes);
elessair 0:f269e3021894 93 }
elessair 0:f269e3021894 94
elessair 0:f269e3021894 95 /*!
elessair 0:f269e3021894 96 * @brief Returns transpose type for CRC protocol reflect out parameter.
elessair 0:f269e3021894 97 *
elessair 0:f269e3021894 98 * This functions helps to set readTranspose member of crc_config_t structure. Reflect out is CRC protocol parameter.
elessair 0:f269e3021894 99 *
elessair 0:f269e3021894 100 * @param enable True or false for the selected CRC protocol Reflect Out (refout) parameter.
elessair 0:f269e3021894 101 */
elessair 0:f269e3021894 102 static inline crc_transpose_type_t crc_GetTransposeTypeFromReflectOut(bool enable)
elessair 0:f269e3021894 103 {
elessair 0:f269e3021894 104 return ((enable) ? kCrcTransposeBitsAndBytes : kCrcTransposeNone);
elessair 0:f269e3021894 105 }
elessair 0:f269e3021894 106
elessair 0:f269e3021894 107 /*!
elessair 0:f269e3021894 108 * @brief Starts checksum computation.
elessair 0:f269e3021894 109 *
elessair 0:f269e3021894 110 * Configures the CRC module for the specified CRC protocol. @n
elessair 0:f269e3021894 111 * Starts the checksum computation by writing the seed value
elessair 0:f269e3021894 112 *
elessair 0:f269e3021894 113 * @param base CRC peripheral address.
elessair 0:f269e3021894 114 * @param config Pointer to protocol configuration structure.
elessair 0:f269e3021894 115 */
elessair 0:f269e3021894 116 static void crc_ConfigureAndStart(CRC_Type *base, const crc_module_config_t *config)
elessair 0:f269e3021894 117 {
elessair 0:f269e3021894 118 uint32_t crcControl;
elessair 0:f269e3021894 119
elessair 0:f269e3021894 120 /* pre-compute value for CRC control registger based on user configuraton without WAS field */
elessair 0:f269e3021894 121 crcControl = 0 | CRC_CTRL_TOT(config->writeTranspose) | CRC_CTRL_TOTR(config->readTranspose) |
elessair 0:f269e3021894 122 CRC_CTRL_FXOR(config->complementChecksum) | CRC_CTRL_TCRC(config->crcBits);
elessair 0:f269e3021894 123
elessair 0:f269e3021894 124 /* make sure the control register is clear - WAS is deasserted, and protocol is set */
elessair 0:f269e3021894 125 base->CTRL = crcControl;
elessair 0:f269e3021894 126
elessair 0:f269e3021894 127 /* write polynomial register */
elessair 0:f269e3021894 128 base->GPOLY = config->polynomial;
elessair 0:f269e3021894 129
elessair 0:f269e3021894 130 /* write pre-computed control register value along with WAS to start checksum computation */
elessair 0:f269e3021894 131 base->CTRL = crcControl | CRC_CTRL_WAS(true);
elessair 0:f269e3021894 132
elessair 0:f269e3021894 133 /* write seed (initial checksum) */
elessair 0:f269e3021894 134 base->DATA = config->seed;
elessair 0:f269e3021894 135
elessair 0:f269e3021894 136 /* deassert WAS by writing pre-computed CRC control register value */
elessair 0:f269e3021894 137 base->CTRL = crcControl;
elessair 0:f269e3021894 138 }
elessair 0:f269e3021894 139
elessair 0:f269e3021894 140 /*!
elessair 0:f269e3021894 141 * @brief Starts final checksum computation.
elessair 0:f269e3021894 142 *
elessair 0:f269e3021894 143 * Configures the CRC module for the specified CRC protocol. @n
elessair 0:f269e3021894 144 * Starts final checksum computation by writing the seed value.
elessair 0:f269e3021894 145 * @note CRC_Get16bitResult() or CRC_Get32bitResult() return final checksum
elessair 0:f269e3021894 146 * (output reflection and xor functions are applied).
elessair 0:f269e3021894 147 *
elessair 0:f269e3021894 148 * @param base CRC peripheral address.
elessair 0:f269e3021894 149 * @param protocolConfig Pointer to protocol configuration structure.
elessair 0:f269e3021894 150 */
elessair 0:f269e3021894 151 static void crc_SetProtocolConfig(CRC_Type *base, const crc_config_t *protocolConfig)
elessair 0:f269e3021894 152 {
elessair 0:f269e3021894 153 crc_module_config_t moduleConfig;
elessair 0:f269e3021894 154 /* convert protocol to CRC peripheral module configuration, prepare for final checksum */
elessair 0:f269e3021894 155 moduleConfig.polynomial = protocolConfig->polynomial;
elessair 0:f269e3021894 156 moduleConfig.seed = protocolConfig->seed;
elessair 0:f269e3021894 157 moduleConfig.readTranspose = crc_GetTransposeTypeFromReflectOut(protocolConfig->reflectOut);
elessair 0:f269e3021894 158 moduleConfig.writeTranspose = crc_GetTransposeTypeFromReflectIn(protocolConfig->reflectIn);
elessair 0:f269e3021894 159 moduleConfig.complementChecksum = protocolConfig->complementChecksum;
elessair 0:f269e3021894 160 moduleConfig.crcBits = protocolConfig->crcBits;
elessair 0:f269e3021894 161
elessair 0:f269e3021894 162 crc_ConfigureAndStart(base, &moduleConfig);
elessair 0:f269e3021894 163 }
elessair 0:f269e3021894 164
elessair 0:f269e3021894 165 /*!
elessair 0:f269e3021894 166 * @brief Starts intermediate checksum computation.
elessair 0:f269e3021894 167 *
elessair 0:f269e3021894 168 * Configures the CRC module for the specified CRC protocol. @n
elessair 0:f269e3021894 169 * Starts intermediate checksum computation by writing the seed value.
elessair 0:f269e3021894 170 * @note CRC_Get16bitResult() or CRC_Get32bitResult() return intermediate checksum (raw data register value).
elessair 0:f269e3021894 171 *
elessair 0:f269e3021894 172 * @param base CRC peripheral address.
elessair 0:f269e3021894 173 * @param protocolConfig Pointer to protocol configuration structure.
elessair 0:f269e3021894 174 */
elessair 0:f269e3021894 175 static void crc_SetRawProtocolConfig(CRC_Type *base, const crc_config_t *protocolConfig)
elessair 0:f269e3021894 176 {
elessair 0:f269e3021894 177 crc_module_config_t moduleConfig;
elessair 0:f269e3021894 178 /* convert protocol to CRC peripheral module configuration, prepare for intermediate checksum */
elessair 0:f269e3021894 179 moduleConfig.polynomial = protocolConfig->polynomial;
elessair 0:f269e3021894 180 moduleConfig.seed = protocolConfig->seed;
elessair 0:f269e3021894 181 moduleConfig.readTranspose =
elessair 0:f269e3021894 182 kCrcTransposeNone; /* intermediate checksum does no transpose of data register read value */
elessair 0:f269e3021894 183 moduleConfig.writeTranspose = crc_GetTransposeTypeFromReflectIn(protocolConfig->reflectIn);
elessair 0:f269e3021894 184 moduleConfig.complementChecksum = false; /* intermediate checksum does no xor of data register read value */
elessair 0:f269e3021894 185 moduleConfig.crcBits = protocolConfig->crcBits;
elessair 0:f269e3021894 186
elessair 0:f269e3021894 187 crc_ConfigureAndStart(base, &moduleConfig);
elessair 0:f269e3021894 188 }
elessair 0:f269e3021894 189
elessair 0:f269e3021894 190 void CRC_Init(CRC_Type *base, const crc_config_t *config)
elessair 0:f269e3021894 191 {
elessair 0:f269e3021894 192 /* ungate clock */
elessair 0:f269e3021894 193 CLOCK_EnableClock(kCLOCK_Crc0);
elessair 0:f269e3021894 194 /* configure CRC module and write the seed */
elessair 0:f269e3021894 195 if (config->crcResult == kCrcFinalChecksum)
elessair 0:f269e3021894 196 {
elessair 0:f269e3021894 197 crc_SetProtocolConfig(base, config);
elessair 0:f269e3021894 198 }
elessair 0:f269e3021894 199 else
elessair 0:f269e3021894 200 {
elessair 0:f269e3021894 201 crc_SetRawProtocolConfig(base, config);
elessair 0:f269e3021894 202 }
elessair 0:f269e3021894 203 }
elessair 0:f269e3021894 204
elessair 0:f269e3021894 205 void CRC_GetDefaultConfig(crc_config_t *config)
elessair 0:f269e3021894 206 {
elessair 0:f269e3021894 207 static const crc_config_t crc16ccit = {
elessair 0:f269e3021894 208 CRC_DRIVER_DEFAULT_POLYNOMIAL, CRC_DRIVER_DEFAULT_SEED,
elessair 0:f269e3021894 209 CRC_DRIVER_DEFAULT_REFLECT_IN, CRC_DRIVER_DEFAULT_REFLECT_OUT,
elessair 0:f269e3021894 210 CRC_DRIVER_DEFAULT_COMPLEMENT_CHECKSUM, CRC_DRIVER_DEFAULT_CRC_BITS,
elessair 0:f269e3021894 211 CRC_DRIVER_DEFAULT_CRC_RESULT,
elessair 0:f269e3021894 212 };
elessair 0:f269e3021894 213
elessair 0:f269e3021894 214 *config = crc16ccit;
elessair 0:f269e3021894 215 }
elessair 0:f269e3021894 216
elessair 0:f269e3021894 217 void CRC_WriteData(CRC_Type *base, const uint8_t *data, size_t dataSize)
elessair 0:f269e3021894 218 {
elessair 0:f269e3021894 219 const uint32_t *data32;
elessair 0:f269e3021894 220
elessair 0:f269e3021894 221 /* 8-bit reads and writes till source address is aligned 4 bytes */
elessair 0:f269e3021894 222 while ((dataSize) && ((uint32_t)data & 3U))
elessair 0:f269e3021894 223 {
elessair 0:f269e3021894 224 base->ACCESS8BIT.DATALL = *data;
elessair 0:f269e3021894 225 data++;
elessair 0:f269e3021894 226 dataSize--;
elessair 0:f269e3021894 227 }
elessair 0:f269e3021894 228
elessair 0:f269e3021894 229 /* use 32-bit reads and writes as long as possible */
elessair 0:f269e3021894 230 data32 = (const uint32_t *)data;
elessair 0:f269e3021894 231 while (dataSize >= sizeof(uint32_t))
elessair 0:f269e3021894 232 {
elessair 0:f269e3021894 233 base->DATA = *data32;
elessair 0:f269e3021894 234 data32++;
elessair 0:f269e3021894 235 dataSize -= sizeof(uint32_t);
elessair 0:f269e3021894 236 }
elessair 0:f269e3021894 237
elessair 0:f269e3021894 238 data = (const uint8_t *)data32;
elessair 0:f269e3021894 239
elessair 0:f269e3021894 240 /* 8-bit reads and writes till end of data buffer */
elessair 0:f269e3021894 241 while (dataSize)
elessair 0:f269e3021894 242 {
elessair 0:f269e3021894 243 base->ACCESS8BIT.DATALL = *data;
elessair 0:f269e3021894 244 data++;
elessair 0:f269e3021894 245 dataSize--;
elessair 0:f269e3021894 246 }
elessair 0:f269e3021894 247 }
elessair 0:f269e3021894 248
elessair 0:f269e3021894 249 uint16_t CRC_Get16bitResult(CRC_Type *base)
elessair 0:f269e3021894 250 {
elessair 0:f269e3021894 251 uint32_t retval;
elessair 0:f269e3021894 252 uint32_t totr; /* type of transpose read bitfield */
elessair 0:f269e3021894 253
elessair 0:f269e3021894 254 retval = base->DATA;
elessair 0:f269e3021894 255 totr = (base->CTRL & CRC_CTRL_TOTR_MASK) >> CRC_CTRL_TOTR_SHIFT;
elessair 0:f269e3021894 256
elessair 0:f269e3021894 257 /* check transpose type to get 16-bit out of 32-bit register */
elessair 0:f269e3021894 258 if (totr >= 2U)
elessair 0:f269e3021894 259 {
elessair 0:f269e3021894 260 /* transpose of bytes for read is set, the result CRC is in CRC_DATA[HU:HL] */
elessair 0:f269e3021894 261 retval &= 0xFFFF0000U;
elessair 0:f269e3021894 262 retval = retval >> 16U;
elessair 0:f269e3021894 263 }
elessair 0:f269e3021894 264 else
elessair 0:f269e3021894 265 {
elessair 0:f269e3021894 266 /* no transpose of bytes for read, the result CRC is in CRC_DATA[LU:LL] */
elessair 0:f269e3021894 267 retval &= 0x0000FFFFU;
elessair 0:f269e3021894 268 }
elessair 0:f269e3021894 269 return (uint16_t)retval;
elessair 0:f269e3021894 270 }