The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_FF_LPC546XX/TOOLCHAIN_GCC_ARM/fsl_crc.h@172:65be27845400, 2019-02-20 (annotated)
- Committer:
- AnnaBridge
- Date:
- Wed Feb 20 20:53:29 2019 +0000
- Revision:
- 172:65be27845400
- Parent:
- 171:3a7713b1edbc
mbed library release version 165
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 171:3a7713b1edbc | 1 | /* |
AnnaBridge | 171:3a7713b1edbc | 2 | * The Clear BSD License |
AnnaBridge | 171:3a7713b1edbc | 3 | * Copyright (c) 2015-2016, Freescale Semiconductor, Inc. |
AnnaBridge | 171:3a7713b1edbc | 4 | * Copyright 2016-2017 NXP |
AnnaBridge | 171:3a7713b1edbc | 5 | * All rights reserved. |
AnnaBridge | 171:3a7713b1edbc | 6 | * |
AnnaBridge | 171:3a7713b1edbc | 7 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 171:3a7713b1edbc | 8 | * are permitted (subject to the limitations in the disclaimer below) provided |
AnnaBridge | 171:3a7713b1edbc | 9 | * that the following conditions are met: |
AnnaBridge | 171:3a7713b1edbc | 10 | * |
AnnaBridge | 171:3a7713b1edbc | 11 | * o Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 171:3a7713b1edbc | 12 | * of conditions and the following disclaimer. |
AnnaBridge | 171:3a7713b1edbc | 13 | * |
AnnaBridge | 171:3a7713b1edbc | 14 | * o Redistributions in binary form must reproduce the above copyright notice, this |
AnnaBridge | 171:3a7713b1edbc | 15 | * list of conditions and the following disclaimer in the documentation and/or |
AnnaBridge | 171:3a7713b1edbc | 16 | * other materials provided with the distribution. |
AnnaBridge | 171:3a7713b1edbc | 17 | * |
AnnaBridge | 171:3a7713b1edbc | 18 | * o Neither the name of the copyright holder nor the names of its |
AnnaBridge | 171:3a7713b1edbc | 19 | * contributors may be used to endorse or promote products derived from this |
AnnaBridge | 171:3a7713b1edbc | 20 | * software without specific prior written permission. |
AnnaBridge | 171:3a7713b1edbc | 21 | * |
AnnaBridge | 171:3a7713b1edbc | 22 | * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. |
AnnaBridge | 171:3a7713b1edbc | 23 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 171:3a7713b1edbc | 24 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 171:3a7713b1edbc | 25 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 171:3a7713b1edbc | 26 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 171:3a7713b1edbc | 27 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 171:3a7713b1edbc | 28 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 171:3a7713b1edbc | 29 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 171:3a7713b1edbc | 30 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 171:3a7713b1edbc | 31 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 171:3a7713b1edbc | 32 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 171:3a7713b1edbc | 33 | */ |
AnnaBridge | 171:3a7713b1edbc | 34 | |
AnnaBridge | 171:3a7713b1edbc | 35 | #ifndef _FSL_CRC_H_ |
AnnaBridge | 171:3a7713b1edbc | 36 | #define _FSL_CRC_H_ |
AnnaBridge | 171:3a7713b1edbc | 37 | |
AnnaBridge | 171:3a7713b1edbc | 38 | #include "fsl_common.h" |
AnnaBridge | 171:3a7713b1edbc | 39 | |
AnnaBridge | 171:3a7713b1edbc | 40 | /*! |
AnnaBridge | 171:3a7713b1edbc | 41 | * @addtogroup crc |
AnnaBridge | 171:3a7713b1edbc | 42 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 43 | */ |
AnnaBridge | 171:3a7713b1edbc | 44 | |
AnnaBridge | 171:3a7713b1edbc | 45 | /*! @file */ |
AnnaBridge | 171:3a7713b1edbc | 46 | |
AnnaBridge | 171:3a7713b1edbc | 47 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 48 | * Definitions |
AnnaBridge | 171:3a7713b1edbc | 49 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 50 | |
AnnaBridge | 171:3a7713b1edbc | 51 | /*! @name Driver version */ |
AnnaBridge | 171:3a7713b1edbc | 52 | /*@{*/ |
AnnaBridge | 171:3a7713b1edbc | 53 | /*! @brief CRC driver version. Version 2.0.1. |
AnnaBridge | 171:3a7713b1edbc | 54 | * |
AnnaBridge | 171:3a7713b1edbc | 55 | * Current version: 2.0.1 |
AnnaBridge | 171:3a7713b1edbc | 56 | * |
AnnaBridge | 171:3a7713b1edbc | 57 | * Change log: |
AnnaBridge | 171:3a7713b1edbc | 58 | * - Version 2.0.0 |
AnnaBridge | 171:3a7713b1edbc | 59 | * - initial version |
AnnaBridge | 171:3a7713b1edbc | 60 | * - Version 2.0.1 |
AnnaBridge | 171:3a7713b1edbc | 61 | * - add explicit type cast when writing to WR_DATA |
AnnaBridge | 171:3a7713b1edbc | 62 | */ |
AnnaBridge | 171:3a7713b1edbc | 63 | #define FSL_CRC_DRIVER_VERSION (MAKE_VERSION(2, 0, 1)) |
AnnaBridge | 171:3a7713b1edbc | 64 | /*@}*/ |
AnnaBridge | 171:3a7713b1edbc | 65 | |
AnnaBridge | 171:3a7713b1edbc | 66 | #ifndef CRC_DRIVER_CUSTOM_DEFAULTS |
AnnaBridge | 171:3a7713b1edbc | 67 | /*! @brief Default configuration structure filled by CRC_GetDefaultConfig(). Uses CRC-16/CCITT-FALSE as default. */ |
AnnaBridge | 171:3a7713b1edbc | 68 | #define CRC_DRIVER_USE_CRC16_CCITT_FALSE_AS_DEFAULT 1 |
AnnaBridge | 171:3a7713b1edbc | 69 | #endif |
AnnaBridge | 171:3a7713b1edbc | 70 | |
AnnaBridge | 171:3a7713b1edbc | 71 | /*! @brief CRC polynomials to use. */ |
AnnaBridge | 171:3a7713b1edbc | 72 | typedef enum _crc_polynomial |
AnnaBridge | 171:3a7713b1edbc | 73 | { |
AnnaBridge | 171:3a7713b1edbc | 74 | kCRC_Polynomial_CRC_CCITT = 0U, /*!< x^16+x^12+x^5+1 */ |
AnnaBridge | 171:3a7713b1edbc | 75 | kCRC_Polynomial_CRC_16 = 1U, /*!< x^16+x^15+x^2+1 */ |
AnnaBridge | 171:3a7713b1edbc | 76 | kCRC_Polynomial_CRC_32 = 2U /*!< x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x+1 */ |
AnnaBridge | 171:3a7713b1edbc | 77 | } crc_polynomial_t; |
AnnaBridge | 171:3a7713b1edbc | 78 | |
AnnaBridge | 171:3a7713b1edbc | 79 | /*! |
AnnaBridge | 171:3a7713b1edbc | 80 | * @brief CRC protocol configuration. |
AnnaBridge | 171:3a7713b1edbc | 81 | * |
AnnaBridge | 171:3a7713b1edbc | 82 | * This structure holds the configuration for the CRC protocol. |
AnnaBridge | 171:3a7713b1edbc | 83 | * |
AnnaBridge | 171:3a7713b1edbc | 84 | */ |
AnnaBridge | 171:3a7713b1edbc | 85 | typedef struct _crc_config |
AnnaBridge | 171:3a7713b1edbc | 86 | { |
AnnaBridge | 171:3a7713b1edbc | 87 | crc_polynomial_t polynomial; /*!< CRC polynomial. */ |
AnnaBridge | 171:3a7713b1edbc | 88 | bool reverseIn; /*!< Reverse bits on input. */ |
AnnaBridge | 171:3a7713b1edbc | 89 | bool complementIn; /*!< Perform 1's complement on input. */ |
AnnaBridge | 171:3a7713b1edbc | 90 | bool reverseOut; /*!< Reverse bits on output. */ |
AnnaBridge | 171:3a7713b1edbc | 91 | bool complementOut; /*!< Perform 1's complement on output. */ |
AnnaBridge | 171:3a7713b1edbc | 92 | uint32_t seed; /*!< Starting checksum value. */ |
AnnaBridge | 171:3a7713b1edbc | 93 | } crc_config_t; |
AnnaBridge | 171:3a7713b1edbc | 94 | |
AnnaBridge | 171:3a7713b1edbc | 95 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 96 | * API |
AnnaBridge | 171:3a7713b1edbc | 97 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 98 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 99 | extern "C" { |
AnnaBridge | 171:3a7713b1edbc | 100 | #endif |
AnnaBridge | 171:3a7713b1edbc | 101 | |
AnnaBridge | 171:3a7713b1edbc | 102 | /*! |
AnnaBridge | 171:3a7713b1edbc | 103 | * @brief Enables and configures the CRC peripheral module. |
AnnaBridge | 171:3a7713b1edbc | 104 | * |
AnnaBridge | 171:3a7713b1edbc | 105 | * This functions enables the CRC peripheral clock in the LPC SYSCON block. |
AnnaBridge | 171:3a7713b1edbc | 106 | * It also configures the CRC engine and starts checksum computation by writing the seed. |
AnnaBridge | 171:3a7713b1edbc | 107 | * |
AnnaBridge | 171:3a7713b1edbc | 108 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 109 | * @param config CRC module configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 110 | */ |
AnnaBridge | 171:3a7713b1edbc | 111 | void CRC_Init(CRC_Type *base, const crc_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 112 | |
AnnaBridge | 171:3a7713b1edbc | 113 | /*! |
AnnaBridge | 171:3a7713b1edbc | 114 | * @brief Disables the CRC peripheral module. |
AnnaBridge | 171:3a7713b1edbc | 115 | * |
AnnaBridge | 171:3a7713b1edbc | 116 | * This functions disables the CRC peripheral clock in the LPC SYSCON block. |
AnnaBridge | 171:3a7713b1edbc | 117 | * |
AnnaBridge | 171:3a7713b1edbc | 118 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 119 | */ |
AnnaBridge | 171:3a7713b1edbc | 120 | static inline void CRC_Deinit(CRC_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 121 | { |
AnnaBridge | 171:3a7713b1edbc | 122 | #if !(defined(FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) && FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) |
AnnaBridge | 171:3a7713b1edbc | 123 | /* disable clock to CRC */ |
AnnaBridge | 171:3a7713b1edbc | 124 | CLOCK_DisableClock(kCLOCK_Crc); |
AnnaBridge | 171:3a7713b1edbc | 125 | #endif /* FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL */ |
AnnaBridge | 171:3a7713b1edbc | 126 | } |
AnnaBridge | 171:3a7713b1edbc | 127 | |
AnnaBridge | 171:3a7713b1edbc | 128 | /*! |
AnnaBridge | 171:3a7713b1edbc | 129 | * @brief resets CRC peripheral module. |
AnnaBridge | 171:3a7713b1edbc | 130 | * |
AnnaBridge | 171:3a7713b1edbc | 131 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 132 | */ |
AnnaBridge | 171:3a7713b1edbc | 133 | void CRC_Reset(CRC_Type *base); |
AnnaBridge | 171:3a7713b1edbc | 134 | |
AnnaBridge | 171:3a7713b1edbc | 135 | /*! |
AnnaBridge | 171:3a7713b1edbc | 136 | * @brief Loads default values to CRC protocol configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 137 | * |
AnnaBridge | 171:3a7713b1edbc | 138 | * Loads default values to CRC protocol configuration structure. The default values are: |
AnnaBridge | 171:3a7713b1edbc | 139 | * @code |
AnnaBridge | 171:3a7713b1edbc | 140 | * config->polynomial = kCRC_Polynomial_CRC_CCITT; |
AnnaBridge | 171:3a7713b1edbc | 141 | * config->reverseIn = false; |
AnnaBridge | 171:3a7713b1edbc | 142 | * config->complementIn = false; |
AnnaBridge | 171:3a7713b1edbc | 143 | * config->reverseOut = false; |
AnnaBridge | 171:3a7713b1edbc | 144 | * config->complementOut = false; |
AnnaBridge | 171:3a7713b1edbc | 145 | * config->seed = 0xFFFFU; |
AnnaBridge | 171:3a7713b1edbc | 146 | * @endcode |
AnnaBridge | 171:3a7713b1edbc | 147 | * |
AnnaBridge | 171:3a7713b1edbc | 148 | * @param config CRC protocol configuration structure |
AnnaBridge | 171:3a7713b1edbc | 149 | */ |
AnnaBridge | 171:3a7713b1edbc | 150 | void CRC_GetDefaultConfig(crc_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 151 | |
AnnaBridge | 171:3a7713b1edbc | 152 | /*! |
AnnaBridge | 171:3a7713b1edbc | 153 | * @brief Loads actual values configured in CRC peripheral to CRC protocol configuration structure. |
AnnaBridge | 171:3a7713b1edbc | 154 | * |
AnnaBridge | 171:3a7713b1edbc | 155 | * The values, including seed, can be used to resume CRC calculation later. |
AnnaBridge | 171:3a7713b1edbc | 156 | |
AnnaBridge | 171:3a7713b1edbc | 157 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 158 | * @param config CRC protocol configuration structure |
AnnaBridge | 171:3a7713b1edbc | 159 | */ |
AnnaBridge | 171:3a7713b1edbc | 160 | void CRC_GetConfig(CRC_Type *base, crc_config_t *config); |
AnnaBridge | 171:3a7713b1edbc | 161 | |
AnnaBridge | 171:3a7713b1edbc | 162 | /*! |
AnnaBridge | 171:3a7713b1edbc | 163 | * @brief Writes data to the CRC module. |
AnnaBridge | 171:3a7713b1edbc | 164 | * |
AnnaBridge | 171:3a7713b1edbc | 165 | * Writes input data buffer bytes to CRC data register. |
AnnaBridge | 171:3a7713b1edbc | 166 | * |
AnnaBridge | 171:3a7713b1edbc | 167 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 168 | * @param data Input data stream, MSByte in data[0]. |
AnnaBridge | 171:3a7713b1edbc | 169 | * @param dataSize Size of the input data buffer in bytes. |
AnnaBridge | 171:3a7713b1edbc | 170 | */ |
AnnaBridge | 171:3a7713b1edbc | 171 | void CRC_WriteData(CRC_Type *base, const uint8_t *data, size_t dataSize); |
AnnaBridge | 171:3a7713b1edbc | 172 | |
AnnaBridge | 171:3a7713b1edbc | 173 | /*! |
AnnaBridge | 171:3a7713b1edbc | 174 | * @brief Reads 32-bit checksum from the CRC module. |
AnnaBridge | 171:3a7713b1edbc | 175 | * |
AnnaBridge | 171:3a7713b1edbc | 176 | * Reads CRC data register. |
AnnaBridge | 171:3a7713b1edbc | 177 | * |
AnnaBridge | 171:3a7713b1edbc | 178 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 179 | * @return final 32-bit checksum, after configured bit reverse and complement operations. |
AnnaBridge | 171:3a7713b1edbc | 180 | */ |
AnnaBridge | 171:3a7713b1edbc | 181 | static inline uint32_t CRC_Get32bitResult(CRC_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 182 | { |
AnnaBridge | 171:3a7713b1edbc | 183 | return base->SUM; |
AnnaBridge | 171:3a7713b1edbc | 184 | } |
AnnaBridge | 171:3a7713b1edbc | 185 | |
AnnaBridge | 171:3a7713b1edbc | 186 | /*! |
AnnaBridge | 171:3a7713b1edbc | 187 | * @brief Reads 16-bit checksum from the CRC module. |
AnnaBridge | 171:3a7713b1edbc | 188 | * |
AnnaBridge | 171:3a7713b1edbc | 189 | * Reads CRC data register. |
AnnaBridge | 171:3a7713b1edbc | 190 | * |
AnnaBridge | 171:3a7713b1edbc | 191 | * @param base CRC peripheral address. |
AnnaBridge | 171:3a7713b1edbc | 192 | * @return final 16-bit checksum, after configured bit reverse and complement operations. |
AnnaBridge | 171:3a7713b1edbc | 193 | */ |
AnnaBridge | 171:3a7713b1edbc | 194 | static inline uint16_t CRC_Get16bitResult(CRC_Type *base) |
AnnaBridge | 171:3a7713b1edbc | 195 | { |
AnnaBridge | 171:3a7713b1edbc | 196 | return (uint16_t)base->SUM; |
AnnaBridge | 171:3a7713b1edbc | 197 | } |
AnnaBridge | 171:3a7713b1edbc | 198 | |
AnnaBridge | 171:3a7713b1edbc | 199 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 200 | } |
AnnaBridge | 171:3a7713b1edbc | 201 | #endif |
AnnaBridge | 171:3a7713b1edbc | 202 | |
AnnaBridge | 171:3a7713b1edbc | 203 | /*! |
AnnaBridge | 171:3a7713b1edbc | 204 | *@} |
AnnaBridge | 171:3a7713b1edbc | 205 | */ |
AnnaBridge | 171:3a7713b1edbc | 206 | |
AnnaBridge | 171:3a7713b1edbc | 207 | #endif /* _FSL_CRC_H_ */ |