Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/MbedCRC.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mohamedmoawya 0:e4c5e6ec922e 1 /* mbed Microcontroller Library
mohamedmoawya 0:e4c5e6ec922e 2 * Copyright (c) 2018 ARM Limited
mohamedmoawya 0:e4c5e6ec922e 3 *
mohamedmoawya 0:e4c5e6ec922e 4 * Licensed under the Apache License, Version 2.0 (the "License");
mohamedmoawya 0:e4c5e6ec922e 5 * you may not use this file except in compliance with the License.
mohamedmoawya 0:e4c5e6ec922e 6 * You may obtain a copy of the License at
mohamedmoawya 0:e4c5e6ec922e 7 *
mohamedmoawya 0:e4c5e6ec922e 8 * http://www.apache.org/licenses/LICENSE-2.0
mohamedmoawya 0:e4c5e6ec922e 9 *
mohamedmoawya 0:e4c5e6ec922e 10 * Unless required by applicable law or agreed to in writing, software
mohamedmoawya 0:e4c5e6ec922e 11 * distributed under the License is distributed on an "AS IS" BASIS,
mohamedmoawya 0:e4c5e6ec922e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mohamedmoawya 0:e4c5e6ec922e 13 * See the License for the specific language governing permissions and
mohamedmoawya 0:e4c5e6ec922e 14 * limitations under the License.
mohamedmoawya 0:e4c5e6ec922e 15 */
mohamedmoawya 0:e4c5e6ec922e 16 #ifndef MBED_CRC_API_H
mohamedmoawya 0:e4c5e6ec922e 17 #define MBED_CRC_API_H
mohamedmoawya 0:e4c5e6ec922e 18
mohamedmoawya 0:e4c5e6ec922e 19 #include "drivers/TableCRC.h"
mohamedmoawya 0:e4c5e6ec922e 20 #include "hal/crc_api.h"
mohamedmoawya 0:e4c5e6ec922e 21 #include "platform/mbed_assert.h"
mohamedmoawya 0:e4c5e6ec922e 22 #include "platform/SingletonPtr.h"
mohamedmoawya 0:e4c5e6ec922e 23 #include "platform/PlatformMutex.h"
mohamedmoawya 0:e4c5e6ec922e 24
mohamedmoawya 0:e4c5e6ec922e 25 /* This is invalid warning from the compiler for below section of code
mohamedmoawya 0:e4c5e6ec922e 26 if ((width < 8) && (NULL == _crc_table)) {
mohamedmoawya 0:e4c5e6ec922e 27 p_crc = (uint32_t)(p_crc << (8 - width));
mohamedmoawya 0:e4c5e6ec922e 28 }
mohamedmoawya 0:e4c5e6ec922e 29 Compiler warns of the shift operation with width as it is width=(std::uint8_t),
mohamedmoawya 0:e4c5e6ec922e 30 but we check for ( width < 8) before performing shift, so it should not be an issue.
mohamedmoawya 0:e4c5e6ec922e 31 */
mohamedmoawya 0:e4c5e6ec922e 32 #if defined ( __CC_ARM )
mohamedmoawya 0:e4c5e6ec922e 33 #pragma diag_suppress 62 // Shift count is negative
mohamedmoawya 0:e4c5e6ec922e 34 #elif defined ( __GNUC__ )
mohamedmoawya 0:e4c5e6ec922e 35 #pragma GCC diagnostic push
mohamedmoawya 0:e4c5e6ec922e 36 #pragma GCC diagnostic ignored "-Wshift-count-negative"
mohamedmoawya 0:e4c5e6ec922e 37 #elif defined (__ICCARM__)
mohamedmoawya 0:e4c5e6ec922e 38 #pragma diag_suppress=Pe062 // Shift count is negative
mohamedmoawya 0:e4c5e6ec922e 39 #endif
mohamedmoawya 0:e4c5e6ec922e 40
mohamedmoawya 0:e4c5e6ec922e 41 namespace mbed {
mohamedmoawya 0:e4c5e6ec922e 42 /** \addtogroup drivers */
mohamedmoawya 0:e4c5e6ec922e 43 /** @{*/
mohamedmoawya 0:e4c5e6ec922e 44
mohamedmoawya 0:e4c5e6ec922e 45 /** CRC object provides CRC generation through hardware/software
mohamedmoawya 0:e4c5e6ec922e 46 *
mohamedmoawya 0:e4c5e6ec922e 47 * ROM polynomial tables for supported polynomials (:: crc_polynomial_t) will be used for
mohamedmoawya 0:e4c5e6ec922e 48 * software CRC computation, if ROM tables are not available then CRC is computed runtime
mohamedmoawya 0:e4c5e6ec922e 49 * bit by bit for all data input.
mohamedmoawya 0:e4c5e6ec922e 50 * @note Synchronization level: Thread safe
mohamedmoawya 0:e4c5e6ec922e 51 *
mohamedmoawya 0:e4c5e6ec922e 52 * @tparam polynomial CRC polynomial value in hex
mohamedmoawya 0:e4c5e6ec922e 53 * @tparam width CRC polynomial width
mohamedmoawya 0:e4c5e6ec922e 54 *
mohamedmoawya 0:e4c5e6ec922e 55 * Example: Compute CRC data
mohamedmoawya 0:e4c5e6ec922e 56 * @code
mohamedmoawya 0:e4c5e6ec922e 57 *
mohamedmoawya 0:e4c5e6ec922e 58 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 59 *
mohamedmoawya 0:e4c5e6ec922e 60 * int main() {
mohamedmoawya 0:e4c5e6ec922e 61 * MbedCRC<POLY_32BIT_ANSI, 32> ct;
mohamedmoawya 0:e4c5e6ec922e 62 *
mohamedmoawya 0:e4c5e6ec922e 63 * char test[] = "123456789";
mohamedmoawya 0:e4c5e6ec922e 64 * uint32_t crc = 0;
mohamedmoawya 0:e4c5e6ec922e 65 *
mohamedmoawya 0:e4c5e6ec922e 66 * printf("\nPolynomial = 0x%lx Width = %d \n", ct.get_polynomial(), ct.get_width());
mohamedmoawya 0:e4c5e6ec922e 67 *
mohamedmoawya 0:e4c5e6ec922e 68 * ct.compute((void *)test, strlen((const char*)test), &crc);
mohamedmoawya 0:e4c5e6ec922e 69 *
mohamedmoawya 0:e4c5e6ec922e 70 * printf("The CRC of data \"123456789\" is : 0x%lx\n", crc);
mohamedmoawya 0:e4c5e6ec922e 71 * return 0;
mohamedmoawya 0:e4c5e6ec922e 72 * }
mohamedmoawya 0:e4c5e6ec922e 73 * @endcode
mohamedmoawya 0:e4c5e6ec922e 74 * Example: Compute CRC with data available in parts
mohamedmoawya 0:e4c5e6ec922e 75 * @code
mohamedmoawya 0:e4c5e6ec922e 76 *
mohamedmoawya 0:e4c5e6ec922e 77 * #include "mbed.h"
mohamedmoawya 0:e4c5e6ec922e 78 * int main() {
mohamedmoawya 0:e4c5e6ec922e 79 * MbedCRC<POLY_32BIT_ANSI, 32> ct;
mohamedmoawya 0:e4c5e6ec922e 80 *
mohamedmoawya 0:e4c5e6ec922e 81 * char test[] = "123456789";
mohamedmoawya 0:e4c5e6ec922e 82 * uint32_t crc = 0;
mohamedmoawya 0:e4c5e6ec922e 83 *
mohamedmoawya 0:e4c5e6ec922e 84 * printf("\nPolynomial = 0x%lx Width = %d \n", ct.get_polynomial(), ct.get_width());
mohamedmoawya 0:e4c5e6ec922e 85 * ct.compute_partial_start(&crc);
mohamedmoawya 0:e4c5e6ec922e 86 * ct.compute_partial((void *)&test, 4, &crc);
mohamedmoawya 0:e4c5e6ec922e 87 * ct.compute_partial((void *)&test[4], 5, &crc);
mohamedmoawya 0:e4c5e6ec922e 88 * ct.compute_partial_stop(&crc);
mohamedmoawya 0:e4c5e6ec922e 89 * printf("The CRC of data \"123456789\" is : 0x%lx\n", crc);
mohamedmoawya 0:e4c5e6ec922e 90 * return 0;
mohamedmoawya 0:e4c5e6ec922e 91 * }
mohamedmoawya 0:e4c5e6ec922e 92 * @endcode
mohamedmoawya 0:e4c5e6ec922e 93 * @ingroup drivers
mohamedmoawya 0:e4c5e6ec922e 94 */
mohamedmoawya 0:e4c5e6ec922e 95
mohamedmoawya 0:e4c5e6ec922e 96 extern SingletonPtr<PlatformMutex> mbed_crc_mutex;
mohamedmoawya 0:e4c5e6ec922e 97
mohamedmoawya 0:e4c5e6ec922e 98 template <uint32_t polynomial = POLY_32BIT_ANSI, uint8_t width = 32>
mohamedmoawya 0:e4c5e6ec922e 99 class MbedCRC {
mohamedmoawya 0:e4c5e6ec922e 100
mohamedmoawya 0:e4c5e6ec922e 101 public:
mohamedmoawya 0:e4c5e6ec922e 102 enum CrcMode
mohamedmoawya 0:e4c5e6ec922e 103 {
mohamedmoawya 0:e4c5e6ec922e 104 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 105 HARDWARE = 0,
mohamedmoawya 0:e4c5e6ec922e 106 #endif
mohamedmoawya 0:e4c5e6ec922e 107 TABLE = 1,
mohamedmoawya 0:e4c5e6ec922e 108 BITWISE
mohamedmoawya 0:e4c5e6ec922e 109 };
mohamedmoawya 0:e4c5e6ec922e 110
mohamedmoawya 0:e4c5e6ec922e 111 typedef uint64_t crc_data_size_t;
mohamedmoawya 0:e4c5e6ec922e 112
mohamedmoawya 0:e4c5e6ec922e 113 /** Lifetime of CRC object
mohamedmoawya 0:e4c5e6ec922e 114 *
mohamedmoawya 0:e4c5e6ec922e 115 * @param initial_xor Inital value/seed to Xor
mohamedmoawya 0:e4c5e6ec922e 116 * @param final_xor Final Xor value
mohamedmoawya 0:e4c5e6ec922e 117 * @param reflect_data
mohamedmoawya 0:e4c5e6ec922e 118 * @param reflect_remainder
mohamedmoawya 0:e4c5e6ec922e 119 * @note Default constructor without any arguments is valid only for supported CRC polynomials. :: crc_polynomial_t
mohamedmoawya 0:e4c5e6ec922e 120 * MbedCRC <POLY_7BIT_SD, 7> ct; --- Valid POLY_7BIT_SD
mohamedmoawya 0:e4c5e6ec922e 121 * MbedCRC <0x1021, 16> ct; --- Valid POLY_16BIT_CCITT
mohamedmoawya 0:e4c5e6ec922e 122 * MbedCRC <POLY_16BIT_CCITT, 32> ct; --- Invalid, compilation error
mohamedmoawya 0:e4c5e6ec922e 123 * MbedCRC <POLY_16BIT_CCITT, 32> ct (i,f,rd,rr) Constructor can be used for not supported polynomials
mohamedmoawya 0:e4c5e6ec922e 124 * MbedCRC<POLY_16BIT_CCITT, 16> sd(0, 0, false, false); Constructor can also be used for supported
mohamedmoawya 0:e4c5e6ec922e 125 * polynomials with different intial/final/reflect values
mohamedmoawya 0:e4c5e6ec922e 126 *
mohamedmoawya 0:e4c5e6ec922e 127 */
mohamedmoawya 0:e4c5e6ec922e 128 MbedCRC(uint32_t initial_xor, uint32_t final_xor, bool reflect_data, bool reflect_remainder) :
mohamedmoawya 0:e4c5e6ec922e 129 _initial_value(initial_xor), _final_xor(final_xor), _reflect_data(reflect_data),
mohamedmoawya 0:e4c5e6ec922e 130 _reflect_remainder(reflect_remainder)
mohamedmoawya 0:e4c5e6ec922e 131 {
mohamedmoawya 0:e4c5e6ec922e 132 mbed_crc_ctor();
mohamedmoawya 0:e4c5e6ec922e 133 }
mohamedmoawya 0:e4c5e6ec922e 134 MbedCRC();
mohamedmoawya 0:e4c5e6ec922e 135 virtual ~MbedCRC()
mohamedmoawya 0:e4c5e6ec922e 136 {
mohamedmoawya 0:e4c5e6ec922e 137 // Do nothing
mohamedmoawya 0:e4c5e6ec922e 138 }
mohamedmoawya 0:e4c5e6ec922e 139
mohamedmoawya 0:e4c5e6ec922e 140 /** Compute CRC for the data input
mohamedmoawya 0:e4c5e6ec922e 141 * Compute CRC performs the initialization, computation and collection of
mohamedmoawya 0:e4c5e6ec922e 142 * final CRC.
mohamedmoawya 0:e4c5e6ec922e 143 *
mohamedmoawya 0:e4c5e6ec922e 144 * @param buffer Data bytes
mohamedmoawya 0:e4c5e6ec922e 145 * @param size Size of data
mohamedmoawya 0:e4c5e6ec922e 146 * @param crc CRC is the output value
mohamedmoawya 0:e4c5e6ec922e 147 * @return 0 on success, negative error code on failure
mohamedmoawya 0:e4c5e6ec922e 148 */
mohamedmoawya 0:e4c5e6ec922e 149 int32_t compute(void *buffer, crc_data_size_t size, uint32_t *crc)
mohamedmoawya 0:e4c5e6ec922e 150 {
mohamedmoawya 0:e4c5e6ec922e 151 MBED_ASSERT(crc != NULL);
mohamedmoawya 0:e4c5e6ec922e 152 int32_t status = 0;
mohamedmoawya 0:e4c5e6ec922e 153
mohamedmoawya 0:e4c5e6ec922e 154 status = compute_partial_start(crc);
mohamedmoawya 0:e4c5e6ec922e 155 if (0 != status) {
mohamedmoawya 0:e4c5e6ec922e 156 unlock();
mohamedmoawya 0:e4c5e6ec922e 157 return status;
mohamedmoawya 0:e4c5e6ec922e 158 }
mohamedmoawya 0:e4c5e6ec922e 159
mohamedmoawya 0:e4c5e6ec922e 160 status = compute_partial(buffer, size, crc);
mohamedmoawya 0:e4c5e6ec922e 161 if (0 != status) {
mohamedmoawya 0:e4c5e6ec922e 162 unlock();
mohamedmoawya 0:e4c5e6ec922e 163 return status;
mohamedmoawya 0:e4c5e6ec922e 164 }
mohamedmoawya 0:e4c5e6ec922e 165
mohamedmoawya 0:e4c5e6ec922e 166 status = compute_partial_stop(crc);
mohamedmoawya 0:e4c5e6ec922e 167 if (0 != status) {
mohamedmoawya 0:e4c5e6ec922e 168 *crc = 0;
mohamedmoawya 0:e4c5e6ec922e 169 }
mohamedmoawya 0:e4c5e6ec922e 170
mohamedmoawya 0:e4c5e6ec922e 171 return status;
mohamedmoawya 0:e4c5e6ec922e 172
mohamedmoawya 0:e4c5e6ec922e 173 }
mohamedmoawya 0:e4c5e6ec922e 174
mohamedmoawya 0:e4c5e6ec922e 175 /** Compute partial CRC for the data input.
mohamedmoawya 0:e4c5e6ec922e 176 *
mohamedmoawya 0:e4c5e6ec922e 177 * CRC data if not available fully, CRC can be computed in parts with available data.
mohamedmoawya 0:e4c5e6ec922e 178 *
mohamedmoawya 0:e4c5e6ec922e 179 * In case of hardware, intermediate values and states are saved by hardware. Mutex
mohamedmoawya 0:e4c5e6ec922e 180 * locking is used to serialize access to hardware CRC.
mohamedmoawya 0:e4c5e6ec922e 181 *
mohamedmoawya 0:e4c5e6ec922e 182 * In case of software CRC, previous CRC output should be passed as argument to the
mohamedmoawya 0:e4c5e6ec922e 183 * current compute_partial call. Please note the intermediate CRC value is maintained by
mohamedmoawya 0:e4c5e6ec922e 184 * application and not the driver.
mohamedmoawya 0:e4c5e6ec922e 185 *
mohamedmoawya 0:e4c5e6ec922e 186 * @pre: Call `compute_partial_start` to start the partial CRC calculation.
mohamedmoawya 0:e4c5e6ec922e 187 * @post: Call `compute_partial_stop` to get the final CRC value.
mohamedmoawya 0:e4c5e6ec922e 188 *
mohamedmoawya 0:e4c5e6ec922e 189 * @param buffer Data bytes
mohamedmoawya 0:e4c5e6ec922e 190 * @param size Size of data
mohamedmoawya 0:e4c5e6ec922e 191 * @param crc CRC value is intermediate CRC value filled by API.
mohamedmoawya 0:e4c5e6ec922e 192 * @return 0 on success or a negative error code on failure
mohamedmoawya 0:e4c5e6ec922e 193 * @note: CRC as output in compute_partial is not final CRC value, call `compute_partial_stop`
mohamedmoawya 0:e4c5e6ec922e 194 * to get final correct CRC value.
mohamedmoawya 0:e4c5e6ec922e 195 */
mohamedmoawya 0:e4c5e6ec922e 196 int32_t compute_partial(void *buffer, crc_data_size_t size, uint32_t *crc)
mohamedmoawya 0:e4c5e6ec922e 197 {
mohamedmoawya 0:e4c5e6ec922e 198 int32_t status = 0;
mohamedmoawya 0:e4c5e6ec922e 199
mohamedmoawya 0:e4c5e6ec922e 200 switch (_mode) {
mohamedmoawya 0:e4c5e6ec922e 201 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 202 case HARDWARE:
mohamedmoawya 0:e4c5e6ec922e 203 hal_crc_compute_partial((uint8_t *)buffer, size);
mohamedmoawya 0:e4c5e6ec922e 204 *crc = 0;
mohamedmoawya 0:e4c5e6ec922e 205 break;
mohamedmoawya 0:e4c5e6ec922e 206 #endif
mohamedmoawya 0:e4c5e6ec922e 207 case TABLE:
mohamedmoawya 0:e4c5e6ec922e 208 status = table_compute_partial(buffer, size, crc);
mohamedmoawya 0:e4c5e6ec922e 209 break;
mohamedmoawya 0:e4c5e6ec922e 210 case BITWISE:
mohamedmoawya 0:e4c5e6ec922e 211 status = bitwise_compute_partial(buffer, size, crc);
mohamedmoawya 0:e4c5e6ec922e 212 break;
mohamedmoawya 0:e4c5e6ec922e 213 default:
mohamedmoawya 0:e4c5e6ec922e 214 status = -1;
mohamedmoawya 0:e4c5e6ec922e 215 break;
mohamedmoawya 0:e4c5e6ec922e 216 }
mohamedmoawya 0:e4c5e6ec922e 217
mohamedmoawya 0:e4c5e6ec922e 218 return status;
mohamedmoawya 0:e4c5e6ec922e 219 }
mohamedmoawya 0:e4c5e6ec922e 220
mohamedmoawya 0:e4c5e6ec922e 221 /** Compute partial start, indicate start of partial computation.
mohamedmoawya 0:e4c5e6ec922e 222 *
mohamedmoawya 0:e4c5e6ec922e 223 * This API should be called before performing any partial computation
mohamedmoawya 0:e4c5e6ec922e 224 * with compute_partial API.
mohamedmoawya 0:e4c5e6ec922e 225 *
mohamedmoawya 0:e4c5e6ec922e 226 * @param crc Initial CRC value set by the API
mohamedmoawya 0:e4c5e6ec922e 227 * @return 0 on success or a negative in case of failure
mohamedmoawya 0:e4c5e6ec922e 228 * @note: CRC is an out parameter and must be reused with compute_partial
mohamedmoawya 0:e4c5e6ec922e 229 * and `compute_partial_stop` without any modifications in application.
mohamedmoawya 0:e4c5e6ec922e 230 */
mohamedmoawya 0:e4c5e6ec922e 231 int32_t compute_partial_start(uint32_t *crc)
mohamedmoawya 0:e4c5e6ec922e 232 {
mohamedmoawya 0:e4c5e6ec922e 233 MBED_ASSERT(crc != NULL);
mohamedmoawya 0:e4c5e6ec922e 234
mohamedmoawya 0:e4c5e6ec922e 235 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 236 if (_mode == HARDWARE) {
mohamedmoawya 0:e4c5e6ec922e 237 lock();
mohamedmoawya 0:e4c5e6ec922e 238 crc_mbed_config_t config;
mohamedmoawya 0:e4c5e6ec922e 239 config.polynomial = polynomial;
mohamedmoawya 0:e4c5e6ec922e 240 config.width = width;
mohamedmoawya 0:e4c5e6ec922e 241 config.initial_xor = _initial_value;
mohamedmoawya 0:e4c5e6ec922e 242 config.final_xor = _final_xor;
mohamedmoawya 0:e4c5e6ec922e 243 config.reflect_in = _reflect_data;
mohamedmoawya 0:e4c5e6ec922e 244 config.reflect_out = _reflect_remainder;
mohamedmoawya 0:e4c5e6ec922e 245
mohamedmoawya 0:e4c5e6ec922e 246 hal_crc_compute_partial_start(&config);
mohamedmoawya 0:e4c5e6ec922e 247 }
mohamedmoawya 0:e4c5e6ec922e 248 #endif
mohamedmoawya 0:e4c5e6ec922e 249
mohamedmoawya 0:e4c5e6ec922e 250 *crc = _initial_value;
mohamedmoawya 0:e4c5e6ec922e 251 return 0;
mohamedmoawya 0:e4c5e6ec922e 252 }
mohamedmoawya 0:e4c5e6ec922e 253
mohamedmoawya 0:e4c5e6ec922e 254 /** Get the final CRC value of partial computation.
mohamedmoawya 0:e4c5e6ec922e 255 *
mohamedmoawya 0:e4c5e6ec922e 256 * CRC value available in partial computation is not correct CRC, as some
mohamedmoawya 0:e4c5e6ec922e 257 * algorithms require remainder to be reflected and final value to be XORed
mohamedmoawya 0:e4c5e6ec922e 258 * This API is used to perform final computation to get correct CRC value.
mohamedmoawya 0:e4c5e6ec922e 259 *
mohamedmoawya 0:e4c5e6ec922e 260 * @param crc CRC result
mohamedmoawya 0:e4c5e6ec922e 261 * @return 0 on success or a negative in case of failure.
mohamedmoawya 0:e4c5e6ec922e 262 */
mohamedmoawya 0:e4c5e6ec922e 263 int32_t compute_partial_stop(uint32_t *crc)
mohamedmoawya 0:e4c5e6ec922e 264 {
mohamedmoawya 0:e4c5e6ec922e 265 MBED_ASSERT(crc != NULL);
mohamedmoawya 0:e4c5e6ec922e 266
mohamedmoawya 0:e4c5e6ec922e 267 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 268 if (_mode == HARDWARE) {
mohamedmoawya 0:e4c5e6ec922e 269 *crc = hal_crc_get_result();
mohamedmoawya 0:e4c5e6ec922e 270 unlock();
mohamedmoawya 0:e4c5e6ec922e 271 return 0;
mohamedmoawya 0:e4c5e6ec922e 272 }
mohamedmoawya 0:e4c5e6ec922e 273 #endif
mohamedmoawya 0:e4c5e6ec922e 274 uint32_t p_crc = *crc;
mohamedmoawya 0:e4c5e6ec922e 275 if ((width < 8) && (NULL == _crc_table)) {
mohamedmoawya 0:e4c5e6ec922e 276 p_crc = (uint32_t)(p_crc << (8 - width));
mohamedmoawya 0:e4c5e6ec922e 277 }
mohamedmoawya 0:e4c5e6ec922e 278 // Optimized algorithm for 32BitANSI does not need additional reflect_remainder
mohamedmoawya 0:e4c5e6ec922e 279 if ((TABLE == _mode) && (POLY_32BIT_REV_ANSI == polynomial)) {
mohamedmoawya 0:e4c5e6ec922e 280 *crc = (p_crc ^ _final_xor) & get_crc_mask();
mohamedmoawya 0:e4c5e6ec922e 281 } else {
mohamedmoawya 0:e4c5e6ec922e 282 *crc = (reflect_remainder(p_crc) ^ _final_xor) & get_crc_mask();
mohamedmoawya 0:e4c5e6ec922e 283 }
mohamedmoawya 0:e4c5e6ec922e 284 unlock();
mohamedmoawya 0:e4c5e6ec922e 285 return 0;
mohamedmoawya 0:e4c5e6ec922e 286 }
mohamedmoawya 0:e4c5e6ec922e 287
mohamedmoawya 0:e4c5e6ec922e 288 /** Get the current CRC polynomial.
mohamedmoawya 0:e4c5e6ec922e 289 *
mohamedmoawya 0:e4c5e6ec922e 290 * @return Polynomial value
mohamedmoawya 0:e4c5e6ec922e 291 */
mohamedmoawya 0:e4c5e6ec922e 292 uint32_t get_polynomial(void) const
mohamedmoawya 0:e4c5e6ec922e 293 {
mohamedmoawya 0:e4c5e6ec922e 294 return polynomial;
mohamedmoawya 0:e4c5e6ec922e 295 }
mohamedmoawya 0:e4c5e6ec922e 296
mohamedmoawya 0:e4c5e6ec922e 297 /** Get the current CRC width
mohamedmoawya 0:e4c5e6ec922e 298 *
mohamedmoawya 0:e4c5e6ec922e 299 * @return CRC width
mohamedmoawya 0:e4c5e6ec922e 300 */
mohamedmoawya 0:e4c5e6ec922e 301 uint8_t get_width(void) const
mohamedmoawya 0:e4c5e6ec922e 302 {
mohamedmoawya 0:e4c5e6ec922e 303 return width;
mohamedmoawya 0:e4c5e6ec922e 304 }
mohamedmoawya 0:e4c5e6ec922e 305
mohamedmoawya 0:e4c5e6ec922e 306 private:
mohamedmoawya 0:e4c5e6ec922e 307 uint32_t _initial_value;
mohamedmoawya 0:e4c5e6ec922e 308 uint32_t _final_xor;
mohamedmoawya 0:e4c5e6ec922e 309 bool _reflect_data;
mohamedmoawya 0:e4c5e6ec922e 310 bool _reflect_remainder;
mohamedmoawya 0:e4c5e6ec922e 311 uint32_t *_crc_table;
mohamedmoawya 0:e4c5e6ec922e 312 CrcMode _mode;
mohamedmoawya 0:e4c5e6ec922e 313
mohamedmoawya 0:e4c5e6ec922e 314 /** Acquire exclusive access to CRC hardware/software.
mohamedmoawya 0:e4c5e6ec922e 315 */
mohamedmoawya 0:e4c5e6ec922e 316 void lock()
mohamedmoawya 0:e4c5e6ec922e 317 {
mohamedmoawya 0:e4c5e6ec922e 318 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 319 if (_mode == HARDWARE) {
mohamedmoawya 0:e4c5e6ec922e 320 mbed_crc_mutex->lock();
mohamedmoawya 0:e4c5e6ec922e 321 }
mohamedmoawya 0:e4c5e6ec922e 322 #endif
mohamedmoawya 0:e4c5e6ec922e 323 }
mohamedmoawya 0:e4c5e6ec922e 324
mohamedmoawya 0:e4c5e6ec922e 325 /** Release exclusive access to CRC hardware/software.
mohamedmoawya 0:e4c5e6ec922e 326 */
mohamedmoawya 0:e4c5e6ec922e 327 virtual void unlock()
mohamedmoawya 0:e4c5e6ec922e 328 {
mohamedmoawya 0:e4c5e6ec922e 329 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 330 if (_mode == HARDWARE) {
mohamedmoawya 0:e4c5e6ec922e 331 mbed_crc_mutex->unlock();
mohamedmoawya 0:e4c5e6ec922e 332 }
mohamedmoawya 0:e4c5e6ec922e 333 #endif
mohamedmoawya 0:e4c5e6ec922e 334 }
mohamedmoawya 0:e4c5e6ec922e 335
mohamedmoawya 0:e4c5e6ec922e 336 /** Get the current CRC data size.
mohamedmoawya 0:e4c5e6ec922e 337 *
mohamedmoawya 0:e4c5e6ec922e 338 * @return CRC data size in bytes
mohamedmoawya 0:e4c5e6ec922e 339 */
mohamedmoawya 0:e4c5e6ec922e 340 uint8_t get_data_size(void) const
mohamedmoawya 0:e4c5e6ec922e 341 {
mohamedmoawya 0:e4c5e6ec922e 342 return (width <= 8 ? 1 : (width <= 16 ? 2 : 4));
mohamedmoawya 0:e4c5e6ec922e 343 }
mohamedmoawya 0:e4c5e6ec922e 344
mohamedmoawya 0:e4c5e6ec922e 345 /** Get the top bit of current CRC.
mohamedmoawya 0:e4c5e6ec922e 346 *
mohamedmoawya 0:e4c5e6ec922e 347 * @return Top bit is set high for respective data width of current CRC
mohamedmoawya 0:e4c5e6ec922e 348 * Top bit for CRC width less then 8 bits will be set as 8th bit.
mohamedmoawya 0:e4c5e6ec922e 349 */
mohamedmoawya 0:e4c5e6ec922e 350 uint32_t get_top_bit(void) const
mohamedmoawya 0:e4c5e6ec922e 351 {
mohamedmoawya 0:e4c5e6ec922e 352 return (width < 8 ? (1u << 7) : (uint32_t)(1ul << (width - 1)));
mohamedmoawya 0:e4c5e6ec922e 353 }
mohamedmoawya 0:e4c5e6ec922e 354
mohamedmoawya 0:e4c5e6ec922e 355 /** Get the CRC data mask.
mohamedmoawya 0:e4c5e6ec922e 356 *
mohamedmoawya 0:e4c5e6ec922e 357 * @return CRC data mask is generated based on current CRC width
mohamedmoawya 0:e4c5e6ec922e 358 */
mohamedmoawya 0:e4c5e6ec922e 359 uint32_t get_crc_mask(void) const
mohamedmoawya 0:e4c5e6ec922e 360 {
mohamedmoawya 0:e4c5e6ec922e 361 return (width < 8 ? ((1u << 8) - 1) : (uint32_t)((uint64_t)(1ull << width) - 1));
mohamedmoawya 0:e4c5e6ec922e 362 }
mohamedmoawya 0:e4c5e6ec922e 363
mohamedmoawya 0:e4c5e6ec922e 364 /** Final value of CRC is reflected.
mohamedmoawya 0:e4c5e6ec922e 365 *
mohamedmoawya 0:e4c5e6ec922e 366 * @param data final crc value, which should be reflected
mohamedmoawya 0:e4c5e6ec922e 367 * @return Reflected CRC value
mohamedmoawya 0:e4c5e6ec922e 368 */
mohamedmoawya 0:e4c5e6ec922e 369 uint32_t reflect_remainder(uint32_t data) const
mohamedmoawya 0:e4c5e6ec922e 370 {
mohamedmoawya 0:e4c5e6ec922e 371 if (_reflect_remainder) {
mohamedmoawya 0:e4c5e6ec922e 372 uint32_t reflection = 0x0;
mohamedmoawya 0:e4c5e6ec922e 373 uint8_t const nBits = (width < 8 ? 8 : width);
mohamedmoawya 0:e4c5e6ec922e 374
mohamedmoawya 0:e4c5e6ec922e 375 for (uint8_t bit = 0; bit < nBits; ++bit) {
mohamedmoawya 0:e4c5e6ec922e 376 if (data & 0x01) {
mohamedmoawya 0:e4c5e6ec922e 377 reflection |= (1 << ((nBits - 1) - bit));
mohamedmoawya 0:e4c5e6ec922e 378 }
mohamedmoawya 0:e4c5e6ec922e 379 data = (data >> 1);
mohamedmoawya 0:e4c5e6ec922e 380 }
mohamedmoawya 0:e4c5e6ec922e 381 return (reflection);
mohamedmoawya 0:e4c5e6ec922e 382 } else {
mohamedmoawya 0:e4c5e6ec922e 383 return data;
mohamedmoawya 0:e4c5e6ec922e 384 }
mohamedmoawya 0:e4c5e6ec922e 385 }
mohamedmoawya 0:e4c5e6ec922e 386
mohamedmoawya 0:e4c5e6ec922e 387 /** Data bytes are reflected.
mohamedmoawya 0:e4c5e6ec922e 388 *
mohamedmoawya 0:e4c5e6ec922e 389 * @param data value to be reflected
mohamedmoawya 0:e4c5e6ec922e 390 * @return Reflected data value
mohamedmoawya 0:e4c5e6ec922e 391 */
mohamedmoawya 0:e4c5e6ec922e 392 uint32_t reflect_bytes(uint32_t data) const
mohamedmoawya 0:e4c5e6ec922e 393 {
mohamedmoawya 0:e4c5e6ec922e 394 if (_reflect_data) {
mohamedmoawya 0:e4c5e6ec922e 395 uint32_t reflection = 0x0;
mohamedmoawya 0:e4c5e6ec922e 396
mohamedmoawya 0:e4c5e6ec922e 397 for (uint8_t bit = 0; bit < 8; ++bit) {
mohamedmoawya 0:e4c5e6ec922e 398 if (data & 0x01) {
mohamedmoawya 0:e4c5e6ec922e 399 reflection |= (1 << (7 - bit));
mohamedmoawya 0:e4c5e6ec922e 400 }
mohamedmoawya 0:e4c5e6ec922e 401 data = (data >> 1);
mohamedmoawya 0:e4c5e6ec922e 402 }
mohamedmoawya 0:e4c5e6ec922e 403 return (reflection);
mohamedmoawya 0:e4c5e6ec922e 404 } else {
mohamedmoawya 0:e4c5e6ec922e 405 return data;
mohamedmoawya 0:e4c5e6ec922e 406 }
mohamedmoawya 0:e4c5e6ec922e 407 }
mohamedmoawya 0:e4c5e6ec922e 408
mohamedmoawya 0:e4c5e6ec922e 409 /** Bitwise CRC computation.
mohamedmoawya 0:e4c5e6ec922e 410 *
mohamedmoawya 0:e4c5e6ec922e 411 * @param buffer data buffer
mohamedmoawya 0:e4c5e6ec922e 412 * @param size size of the data
mohamedmoawya 0:e4c5e6ec922e 413 * @param crc CRC value is filled in, but the value is not the final
mohamedmoawya 0:e4c5e6ec922e 414 * @return 0 on success or a negative error code on failure
mohamedmoawya 0:e4c5e6ec922e 415 */
mohamedmoawya 0:e4c5e6ec922e 416 int32_t bitwise_compute_partial(const void *buffer, crc_data_size_t size, uint32_t *crc) const
mohamedmoawya 0:e4c5e6ec922e 417 {
mohamedmoawya 0:e4c5e6ec922e 418 MBED_ASSERT(crc != NULL);
mohamedmoawya 0:e4c5e6ec922e 419
mohamedmoawya 0:e4c5e6ec922e 420 const uint8_t *data = static_cast<const uint8_t *>(buffer);
mohamedmoawya 0:e4c5e6ec922e 421 uint32_t p_crc = *crc;
mohamedmoawya 0:e4c5e6ec922e 422
mohamedmoawya 0:e4c5e6ec922e 423 if (width < 8) {
mohamedmoawya 0:e4c5e6ec922e 424 uint8_t data_byte;
mohamedmoawya 0:e4c5e6ec922e 425 for (crc_data_size_t byte = 0; byte < size; byte++) {
mohamedmoawya 0:e4c5e6ec922e 426 data_byte = reflect_bytes(data[byte]);
mohamedmoawya 0:e4c5e6ec922e 427 for (uint8_t bit = 8; bit > 0; --bit) {
mohamedmoawya 0:e4c5e6ec922e 428 p_crc <<= 1;
mohamedmoawya 0:e4c5e6ec922e 429 if ((data_byte ^ p_crc) & get_top_bit()) {
mohamedmoawya 0:e4c5e6ec922e 430 p_crc ^= polynomial;
mohamedmoawya 0:e4c5e6ec922e 431 }
mohamedmoawya 0:e4c5e6ec922e 432 data_byte <<= 1;
mohamedmoawya 0:e4c5e6ec922e 433 }
mohamedmoawya 0:e4c5e6ec922e 434 }
mohamedmoawya 0:e4c5e6ec922e 435 } else {
mohamedmoawya 0:e4c5e6ec922e 436 for (crc_data_size_t byte = 0; byte < size; byte++) {
mohamedmoawya 0:e4c5e6ec922e 437 p_crc ^= (reflect_bytes(data[byte]) << (width - 8));
mohamedmoawya 0:e4c5e6ec922e 438
mohamedmoawya 0:e4c5e6ec922e 439 // Perform modulo-2 division, a bit at a time
mohamedmoawya 0:e4c5e6ec922e 440 for (uint8_t bit = 8; bit > 0; --bit) {
mohamedmoawya 0:e4c5e6ec922e 441 if (p_crc & get_top_bit()) {
mohamedmoawya 0:e4c5e6ec922e 442 p_crc = (p_crc << 1) ^ polynomial;
mohamedmoawya 0:e4c5e6ec922e 443 } else {
mohamedmoawya 0:e4c5e6ec922e 444 p_crc = (p_crc << 1);
mohamedmoawya 0:e4c5e6ec922e 445 }
mohamedmoawya 0:e4c5e6ec922e 446 }
mohamedmoawya 0:e4c5e6ec922e 447 }
mohamedmoawya 0:e4c5e6ec922e 448 }
mohamedmoawya 0:e4c5e6ec922e 449 *crc = p_crc & get_crc_mask();
mohamedmoawya 0:e4c5e6ec922e 450 return 0;
mohamedmoawya 0:e4c5e6ec922e 451 }
mohamedmoawya 0:e4c5e6ec922e 452
mohamedmoawya 0:e4c5e6ec922e 453 /** CRC computation using ROM tables.
mohamedmoawya 0:e4c5e6ec922e 454 *
mohamedmoawya 0:e4c5e6ec922e 455 * @param buffer data buffer
mohamedmoawya 0:e4c5e6ec922e 456 * @param size size of the data
mohamedmoawya 0:e4c5e6ec922e 457 * @param crc CRC value is filled in, but the value is not the final
mohamedmoawya 0:e4c5e6ec922e 458 * @return 0 on success or a negative error code on failure
mohamedmoawya 0:e4c5e6ec922e 459 */
mohamedmoawya 0:e4c5e6ec922e 460 int32_t table_compute_partial(const void *buffer, crc_data_size_t size, uint32_t *crc) const
mohamedmoawya 0:e4c5e6ec922e 461 {
mohamedmoawya 0:e4c5e6ec922e 462 MBED_ASSERT(crc != NULL);
mohamedmoawya 0:e4c5e6ec922e 463
mohamedmoawya 0:e4c5e6ec922e 464 const uint8_t *data = static_cast<const uint8_t *>(buffer);
mohamedmoawya 0:e4c5e6ec922e 465 uint32_t p_crc = *crc;
mohamedmoawya 0:e4c5e6ec922e 466 uint8_t data_byte = 0;
mohamedmoawya 0:e4c5e6ec922e 467
mohamedmoawya 0:e4c5e6ec922e 468 if (width <= 8) {
mohamedmoawya 0:e4c5e6ec922e 469 uint8_t *crc_table = (uint8_t *)_crc_table;
mohamedmoawya 0:e4c5e6ec922e 470 for (crc_data_size_t byte = 0; byte < size; byte++) {
mohamedmoawya 0:e4c5e6ec922e 471 data_byte = reflect_bytes(data[byte]) ^ p_crc;
mohamedmoawya 0:e4c5e6ec922e 472 p_crc = crc_table[data_byte];
mohamedmoawya 0:e4c5e6ec922e 473 }
mohamedmoawya 0:e4c5e6ec922e 474 } else if (width <= 16) {
mohamedmoawya 0:e4c5e6ec922e 475 uint16_t *crc_table = (uint16_t *)_crc_table;
mohamedmoawya 0:e4c5e6ec922e 476 for (crc_data_size_t byte = 0; byte < size; byte++) {
mohamedmoawya 0:e4c5e6ec922e 477 data_byte = reflect_bytes(data[byte]) ^ (p_crc >> (width - 8));
mohamedmoawya 0:e4c5e6ec922e 478 p_crc = crc_table[data_byte] ^ (p_crc << 8);
mohamedmoawya 0:e4c5e6ec922e 479 }
mohamedmoawya 0:e4c5e6ec922e 480 } else {
mohamedmoawya 0:e4c5e6ec922e 481 uint32_t *crc_table = (uint32_t *)_crc_table;
mohamedmoawya 0:e4c5e6ec922e 482 if (POLY_32BIT_REV_ANSI == polynomial) {
mohamedmoawya 0:e4c5e6ec922e 483 for (crc_data_size_t i = 0; i < size; i++) {
mohamedmoawya 0:e4c5e6ec922e 484 p_crc = (p_crc >> 4) ^ crc_table[(p_crc ^ (data[i] >> 0)) & 0xf];
mohamedmoawya 0:e4c5e6ec922e 485 p_crc = (p_crc >> 4) ^ crc_table[(p_crc ^ (data[i] >> 4)) & 0xf];
mohamedmoawya 0:e4c5e6ec922e 486 }
mohamedmoawya 0:e4c5e6ec922e 487 }
mohamedmoawya 0:e4c5e6ec922e 488 else {
mohamedmoawya 0:e4c5e6ec922e 489 for (crc_data_size_t byte = 0; byte < size; byte++) {
mohamedmoawya 0:e4c5e6ec922e 490 data_byte = reflect_bytes(data[byte]) ^ (p_crc >> (width - 8));
mohamedmoawya 0:e4c5e6ec922e 491 p_crc = crc_table[data_byte] ^ (p_crc << 8);
mohamedmoawya 0:e4c5e6ec922e 492 }
mohamedmoawya 0:e4c5e6ec922e 493 }
mohamedmoawya 0:e4c5e6ec922e 494 }
mohamedmoawya 0:e4c5e6ec922e 495 *crc = p_crc & get_crc_mask();
mohamedmoawya 0:e4c5e6ec922e 496 return 0;
mohamedmoawya 0:e4c5e6ec922e 497 }
mohamedmoawya 0:e4c5e6ec922e 498
mohamedmoawya 0:e4c5e6ec922e 499 /** Constructor init called from all specialized cases of constructor.
mohamedmoawya 0:e4c5e6ec922e 500 * Note: All construtor common code should be in this function.
mohamedmoawya 0:e4c5e6ec922e 501 */
mohamedmoawya 0:e4c5e6ec922e 502 void mbed_crc_ctor(void)
mohamedmoawya 0:e4c5e6ec922e 503 {
mohamedmoawya 0:e4c5e6ec922e 504 MBED_STATIC_ASSERT(width <= 32, "Max 32-bit CRC supported");
mohamedmoawya 0:e4c5e6ec922e 505
mohamedmoawya 0:e4c5e6ec922e 506 #ifdef DEVICE_CRC
mohamedmoawya 0:e4c5e6ec922e 507 if (POLY_32BIT_REV_ANSI == polynomial) {
mohamedmoawya 0:e4c5e6ec922e 508 _crc_table = (uint32_t *)Table_CRC_32bit_Rev_ANSI;
mohamedmoawya 0:e4c5e6ec922e 509 _mode = TABLE;
mohamedmoawya 0:e4c5e6ec922e 510 return;
mohamedmoawya 0:e4c5e6ec922e 511 }
mohamedmoawya 0:e4c5e6ec922e 512 crc_mbed_config_t config;
mohamedmoawya 0:e4c5e6ec922e 513 config.polynomial = polynomial;
mohamedmoawya 0:e4c5e6ec922e 514 config.width = width;
mohamedmoawya 0:e4c5e6ec922e 515 config.initial_xor = _initial_value;
mohamedmoawya 0:e4c5e6ec922e 516 config.final_xor = _final_xor;
mohamedmoawya 0:e4c5e6ec922e 517 config.reflect_in = _reflect_data;
mohamedmoawya 0:e4c5e6ec922e 518 config.reflect_out = _reflect_remainder;
mohamedmoawya 0:e4c5e6ec922e 519
mohamedmoawya 0:e4c5e6ec922e 520 if (hal_crc_is_supported(&config)) {
mohamedmoawya 0:e4c5e6ec922e 521 _mode = HARDWARE;
mohamedmoawya 0:e4c5e6ec922e 522 return;
mohamedmoawya 0:e4c5e6ec922e 523 }
mohamedmoawya 0:e4c5e6ec922e 524 #endif
mohamedmoawya 0:e4c5e6ec922e 525
mohamedmoawya 0:e4c5e6ec922e 526 switch (polynomial) {
mohamedmoawya 0:e4c5e6ec922e 527 case POLY_32BIT_ANSI:
mohamedmoawya 0:e4c5e6ec922e 528 _crc_table = (uint32_t *)Table_CRC_32bit_ANSI;
mohamedmoawya 0:e4c5e6ec922e 529 break;
mohamedmoawya 0:e4c5e6ec922e 530 case POLY_32BIT_REV_ANSI:
mohamedmoawya 0:e4c5e6ec922e 531 _crc_table = (uint32_t *)Table_CRC_32bit_Rev_ANSI;
mohamedmoawya 0:e4c5e6ec922e 532 break;
mohamedmoawya 0:e4c5e6ec922e 533 case POLY_8BIT_CCITT:
mohamedmoawya 0:e4c5e6ec922e 534 _crc_table = (uint32_t *)Table_CRC_8bit_CCITT;
mohamedmoawya 0:e4c5e6ec922e 535 break;
mohamedmoawya 0:e4c5e6ec922e 536 case POLY_7BIT_SD:
mohamedmoawya 0:e4c5e6ec922e 537 _crc_table = (uint32_t *)Table_CRC_7Bit_SD;
mohamedmoawya 0:e4c5e6ec922e 538 break;
mohamedmoawya 0:e4c5e6ec922e 539 case POLY_16BIT_CCITT:
mohamedmoawya 0:e4c5e6ec922e 540 _crc_table = (uint32_t *)Table_CRC_16bit_CCITT;
mohamedmoawya 0:e4c5e6ec922e 541 break;
mohamedmoawya 0:e4c5e6ec922e 542 case POLY_16BIT_IBM:
mohamedmoawya 0:e4c5e6ec922e 543 _crc_table = (uint32_t *)Table_CRC_16bit_IBM;
mohamedmoawya 0:e4c5e6ec922e 544 break;
mohamedmoawya 0:e4c5e6ec922e 545 default:
mohamedmoawya 0:e4c5e6ec922e 546 _crc_table = NULL;
mohamedmoawya 0:e4c5e6ec922e 547 break;
mohamedmoawya 0:e4c5e6ec922e 548 }
mohamedmoawya 0:e4c5e6ec922e 549 _mode = (_crc_table != NULL) ? TABLE : BITWISE;
mohamedmoawya 0:e4c5e6ec922e 550 }
mohamedmoawya 0:e4c5e6ec922e 551 };
mohamedmoawya 0:e4c5e6ec922e 552
mohamedmoawya 0:e4c5e6ec922e 553 #if defined ( __CC_ARM )
mohamedmoawya 0:e4c5e6ec922e 554 #elif defined ( __GNUC__ )
mohamedmoawya 0:e4c5e6ec922e 555 #pragma GCC diagnostic pop
mohamedmoawya 0:e4c5e6ec922e 556 #elif defined (__ICCARM__)
mohamedmoawya 0:e4c5e6ec922e 557 #endif
mohamedmoawya 0:e4c5e6ec922e 558
mohamedmoawya 0:e4c5e6ec922e 559 /** @}*/
mohamedmoawya 0:e4c5e6ec922e 560 } // namespace mbed
mohamedmoawya 0:e4c5e6ec922e 561
mohamedmoawya 0:e4c5e6ec922e 562 #endif