mbed official / mbed

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_SDT32620B/TOOLCHAIN_IAR/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?

UserRevisionLine numberNew contents of line
AnnaBridge 167:84c0a372a020 1 /**
AnnaBridge 167:84c0a372a020 2 * @file
AnnaBridge 167:84c0a372a020 3 * @brief CRC peripheral module function prototypes and data types.
AnnaBridge 167:84c0a372a020 4 */
AnnaBridge 167:84c0a372a020 5
AnnaBridge 167:84c0a372a020 6 /* ****************************************************************************
AnnaBridge 167:84c0a372a020 7 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 167:84c0a372a020 8 *
AnnaBridge 167:84c0a372a020 9 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 167:84c0a372a020 10 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 167:84c0a372a020 11 * to deal in the Software without restriction, including without limitation
AnnaBridge 167:84c0a372a020 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 167:84c0a372a020 13 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 167:84c0a372a020 14 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 167:84c0a372a020 15 *
AnnaBridge 167:84c0a372a020 16 * The above copyright notice and this permission notice shall be included
AnnaBridge 167:84c0a372a020 17 * in all copies or substantial portions of the Software.
AnnaBridge 167:84c0a372a020 18 *
AnnaBridge 167:84c0a372a020 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 167:84c0a372a020 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 167:84c0a372a020 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 167:84c0a372a020 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 167:84c0a372a020 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 167:84c0a372a020 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 167:84c0a372a020 25 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 167:84c0a372a020 26 *
AnnaBridge 167:84c0a372a020 27 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 167:84c0a372a020 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 167:84c0a372a020 29 * Products, Inc. Branding Policy.
AnnaBridge 167:84c0a372a020 30 *
AnnaBridge 167:84c0a372a020 31 * The mere transfer of this software does not imply any licenses
AnnaBridge 167:84c0a372a020 32 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 167:84c0a372a020 33 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 167:84c0a372a020 34 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 167:84c0a372a020 35 * ownership rights.
AnnaBridge 167:84c0a372a020 36 *
AnnaBridge 167:84c0a372a020 37 * $Date: 2016-10-10 16:57:56 -0500 (Mon, 10 Oct 2016) $
AnnaBridge 167:84c0a372a020 38 * $Revision: 24657 $
AnnaBridge 167:84c0a372a020 39 *
AnnaBridge 167:84c0a372a020 40 **************************************************************************** */
AnnaBridge 167:84c0a372a020 41
AnnaBridge 167:84c0a372a020 42 /* Define to prevent redundant inclusion */
AnnaBridge 167:84c0a372a020 43 #ifndef _CRC_H_
AnnaBridge 167:84c0a372a020 44 #define _CRC_H_
AnnaBridge 167:84c0a372a020 45
AnnaBridge 167:84c0a372a020 46 #ifdef __cplusplus
AnnaBridge 167:84c0a372a020 47 extern "C" {
AnnaBridge 167:84c0a372a020 48 #endif
AnnaBridge 167:84c0a372a020 49
AnnaBridge 167:84c0a372a020 50 /**
AnnaBridge 167:84c0a372a020 51 * @ingroup periphlibs
AnnaBridge 167:84c0a372a020 52 * @defgroup crc Cyclic Redundancy Check (CRC)
AnnaBridge 167:84c0a372a020 53 * @brief High-level API for CRC Peripheral Module
AnnaBridge 167:84c0a372a020 54 * @{
AnnaBridge 167:84c0a372a020 55 */
AnnaBridge 167:84c0a372a020 56
AnnaBridge 167:84c0a372a020 57 /**
AnnaBridge 167:84c0a372a020 58 * @page crc_overview Overview and Usage
AnnaBridge 167:84c0a372a020 59 * @parblock
AnnaBridge 167:84c0a372a020 60 * - Initialize the CRC for usage by calling either the CRC16_Init() function or the CRC32_Init() funciton
AnnaBridge 167:84c0a372a020 61 * + For CRC16, CCITT mode is enabled if the parameter is set
AnnaBridge 167:84c0a372a020 62 * + Select the Endian of the data for calculation
AnnaBridge 167:84c0a372a020 63 * - passing a 1 sets the module to little endian
AnnaBridge 167:84c0a372a020 64 * - passing a 0 sets the module to big endian
AnnaBridge 167:84c0a372a020 65 * - Set the intial CRC seed by calling CRC16_Reseed() or CRC32_Reseed()
AnnaBridge 167:84c0a372a020 66 * + This is the initial value of the CRC remainder to be used when the data is passed to the module
AnnaBridge 167:84c0a372a020 67 * - Pass data to the CRC engine using the methods:
AnnaBridge 167:84c0a372a020 68 * + CRC16_AddData()
AnnaBridge 167:84c0a372a020 69 * + CRC16_AddDataArray()
AnnaBridge 167:84c0a372a020 70 * + CRC32_AddData()
AnnaBridge 167:84c0a372a020 71 * + CRC32_AddDataArray()
AnnaBridge 167:84c0a372a020 72 * @note any data passed to the add methods of the peripheral is padded with zeros if it is less than
AnnaBridge 167:84c0a372a020 73 * 32-bits.
AnnaBridge 167:84c0a372a020 74 * @endparblock
AnnaBridge 167:84c0a372a020 75 */
AnnaBridge 167:84c0a372a020 76
AnnaBridge 167:84c0a372a020 77
AnnaBridge 167:84c0a372a020 78 /* **** Includes **** */
AnnaBridge 167:84c0a372a020 79 #include "mxc_config.h"
AnnaBridge 167:84c0a372a020 80 #include <string.h>
AnnaBridge 167:84c0a372a020 81 #include "crc_regs.h"
AnnaBridge 167:84c0a372a020 82
AnnaBridge 167:84c0a372a020 83 /* **** Definitions **** */
AnnaBridge 167:84c0a372a020 84
AnnaBridge 167:84c0a372a020 85 /* **** Globals **** */
AnnaBridge 167:84c0a372a020 86
AnnaBridge 167:84c0a372a020 87 /* **** Function Prototypes **** */
AnnaBridge 167:84c0a372a020 88
AnnaBridge 167:84c0a372a020 89 /**
AnnaBridge 167:84c0a372a020 90 * @brief Initialize CRC clock and select CRC16 mode and byte order.
AnnaBridge 167:84c0a372a020 91 *
AnnaBridge 167:84c0a372a020 92 * @param CCITT_TRUE CRC16-CCITT-TRUE = 1, CRC16-CCITT-FALSE = 0
AnnaBridge 167:84c0a372a020 93 * @param lilEndian byte order, little endian = 1, big endian = 0
AnnaBridge 167:84c0a372a020 94 */
AnnaBridge 167:84c0a372a020 95 void CRC16_Init(uint8_t CCITT_TRUE, uint8_t lilEndian);
AnnaBridge 167:84c0a372a020 96
AnnaBridge 167:84c0a372a020 97 /**
AnnaBridge 167:84c0a372a020 98 * @brief Initialize CRC clock and select byte order for CRC32.
AnnaBridge 167:84c0a372a020 99 *
AnnaBridge 167:84c0a372a020 100 * @param lilEndian byte order, little endian = 1, big endian = 0
AnnaBridge 167:84c0a372a020 101 */
AnnaBridge 167:84c0a372a020 102 void CRC32_Init(uint8_t lilEndian);
AnnaBridge 167:84c0a372a020 103
AnnaBridge 167:84c0a372a020 104 /**
AnnaBridge 167:84c0a372a020 105 * @brief Initialize CRC16 calculation.
AnnaBridge 167:84c0a372a020 106 *
AnnaBridge 167:84c0a372a020 107 * @param initData intial remainder to start the CRC16 calculation with
AnnaBridge 167:84c0a372a020 108 */
AnnaBridge 167:84c0a372a020 109 void CRC16_Reseed(uint16_t initData);
AnnaBridge 167:84c0a372a020 110
AnnaBridge 167:84c0a372a020 111 /**
AnnaBridge 167:84c0a372a020 112 * @brief Initialize CRC32 calculation.
AnnaBridge 167:84c0a372a020 113 *
AnnaBridge 167:84c0a372a020 114 * @param initData intial remainder to start the CRC32 calculation with
AnnaBridge 167:84c0a372a020 115 */
AnnaBridge 167:84c0a372a020 116 void CRC32_Reseed(uint32_t initData);
AnnaBridge 167:84c0a372a020 117
AnnaBridge 167:84c0a372a020 118 /**
AnnaBridge 167:84c0a372a020 119 * @brief Add data to the CRC16 calculation.
AnnaBridge 167:84c0a372a020 120 *
AnnaBridge 167:84c0a372a020 121 * @param data data to add to the CRC16 calculation
AnnaBridge 167:84c0a372a020 122 * @note data is padded with zeros if less than 32bits.
AnnaBridge 167:84c0a372a020 123 */
AnnaBridge 167:84c0a372a020 124 __STATIC_INLINE void CRC16_AddData(uint32_t data)
AnnaBridge 167:84c0a372a020 125 {
AnnaBridge 167:84c0a372a020 126 MXC_CRC_DATA->value16[0] = data;
AnnaBridge 167:84c0a372a020 127 }
AnnaBridge 167:84c0a372a020 128
AnnaBridge 167:84c0a372a020 129 /**
AnnaBridge 167:84c0a372a020 130 * @brief Add data to the CRC32 calculation
AnnaBridge 167:84c0a372a020 131 *
AnnaBridge 167:84c0a372a020 132 * @param data data to add to the CRC32 calculation
AnnaBridge 167:84c0a372a020 133 * @note data is padded with zeros if less than 32bits
AnnaBridge 167:84c0a372a020 134 */
AnnaBridge 167:84c0a372a020 135 __STATIC_INLINE void CRC32_AddData(uint32_t data)
AnnaBridge 167:84c0a372a020 136 {
AnnaBridge 167:84c0a372a020 137 MXC_CRC_DATA->value32[0] = data;
AnnaBridge 167:84c0a372a020 138 }
AnnaBridge 167:84c0a372a020 139
AnnaBridge 167:84c0a372a020 140 /**
AnnaBridge 167:84c0a372a020 141 * @brief Add an array of data to the CRC16 calculation
AnnaBridge 167:84c0a372a020 142 *
AnnaBridge 167:84c0a372a020 143 * @param data pointer to array of data
AnnaBridge 167:84c0a372a020 144 * @note data is padded with zeros if less than 32bits
AnnaBridge 167:84c0a372a020 145 *
AnnaBridge 167:84c0a372a020 146 * @param arrayLength number of elements in array
AnnaBridge 167:84c0a372a020 147 */
AnnaBridge 167:84c0a372a020 148 __STATIC_INLINE void CRC16_AddDataArray(uint32_t *data, uint32_t arrayLength)
AnnaBridge 167:84c0a372a020 149 {
AnnaBridge 167:84c0a372a020 150 memcpy((void *)(&(MXC_CRC_DATA->value16)), (void *)data, arrayLength * sizeof(data[0]));
AnnaBridge 167:84c0a372a020 151 }
AnnaBridge 167:84c0a372a020 152
AnnaBridge 167:84c0a372a020 153 /**
AnnaBridge 167:84c0a372a020 154 * @brief Add an array of data to the CRC32 calculation
AnnaBridge 167:84c0a372a020 155 *
AnnaBridge 167:84c0a372a020 156 * @param data pointer to array of data
AnnaBridge 167:84c0a372a020 157 * @note data is padded with zeros if less than 32bits
AnnaBridge 167:84c0a372a020 158 * @param arrayLength number of elements in array
AnnaBridge 167:84c0a372a020 159 */
AnnaBridge 167:84c0a372a020 160 __STATIC_INLINE void CRC32_AddDataArray(uint32_t *data, uint32_t arrayLength)
AnnaBridge 167:84c0a372a020 161 {
AnnaBridge 167:84c0a372a020 162 memcpy((void *)(&(MXC_CRC_DATA->value32)), (void *)data, arrayLength * sizeof(data[0]));
AnnaBridge 167:84c0a372a020 163 }
AnnaBridge 167:84c0a372a020 164
AnnaBridge 167:84c0a372a020 165 /**
AnnaBridge 167:84c0a372a020 166 * @brief Get the calculated CRC16 value
AnnaBridge 167:84c0a372a020 167 *
AnnaBridge 167:84c0a372a020 168 * @return CRC16 value
AnnaBridge 167:84c0a372a020 169 */
AnnaBridge 167:84c0a372a020 170 __STATIC_INLINE uint32_t CRC16_GetCRC()
AnnaBridge 167:84c0a372a020 171 {
AnnaBridge 167:84c0a372a020 172 return MXC_CRC_DATA->value16[0];
AnnaBridge 167:84c0a372a020 173 }
AnnaBridge 167:84c0a372a020 174
AnnaBridge 167:84c0a372a020 175 /**
AnnaBridge 167:84c0a372a020 176 * @brief Get the calculated CRC32 value
AnnaBridge 167:84c0a372a020 177 *
AnnaBridge 167:84c0a372a020 178 * @return CRC32 value
AnnaBridge 167:84c0a372a020 179 */
AnnaBridge 167:84c0a372a020 180 __STATIC_INLINE uint32_t CRC32_GetCRC()
AnnaBridge 167:84c0a372a020 181 {
AnnaBridge 167:84c0a372a020 182 return MXC_CRC_DATA->value32[0];
AnnaBridge 167:84c0a372a020 183 }
AnnaBridge 167:84c0a372a020 184
AnnaBridge 167:84c0a372a020 185 /**@} end of crc group */
AnnaBridge 167:84c0a372a020 186
AnnaBridge 167:84c0a372a020 187 #ifdef __cplusplus
AnnaBridge 167:84c0a372a020 188 }
AnnaBridge 167:84c0a372a020 189 #endif
AnnaBridge 167:84c0a372a020 190
AnnaBridge 167:84c0a372a020 191 #endif /* _CRC_H_ */