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