mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/crc.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

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