Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/crc_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1 /** \addtogroup hal */
ommpy 0:d383e2dee0f7 2 /** @{*/
ommpy 0:d383e2dee0f7 3 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 4 * Copyright (c) 2018 ARM Limited
ommpy 0:d383e2dee0f7 5 * SPDX-License-Identifier: Apache-2.0
ommpy 0:d383e2dee0f7 6 *
ommpy 0:d383e2dee0f7 7 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 8 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 9 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 10 *
ommpy 0:d383e2dee0f7 11 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 12 *
ommpy 0:d383e2dee0f7 13 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 14 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 16 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 17 * limitations under the License.
ommpy 0:d383e2dee0f7 18 */
ommpy 0:d383e2dee0f7 19 #ifndef MBED_CRC_HAL_API_H
ommpy 0:d383e2dee0f7 20 #define MBED_CRC_HAL_API_H
ommpy 0:d383e2dee0f7 21
ommpy 0:d383e2dee0f7 22 #include <stdbool.h>
ommpy 0:d383e2dee0f7 23 #include <stddef.h>
ommpy 0:d383e2dee0f7 24 #include <stdint.h>
ommpy 0:d383e2dee0f7 25
ommpy 0:d383e2dee0f7 26 /** CRC Polynomial value
ommpy 0:d383e2dee0f7 27 *
ommpy 0:d383e2dee0f7 28 * Different polynomial values supported
ommpy 0:d383e2dee0f7 29 */
ommpy 0:d383e2dee0f7 30 typedef enum crc_polynomial {
ommpy 0:d383e2dee0f7 31 POLY_OTHER = 0,
ommpy 0:d383e2dee0f7 32 POLY_8BIT_CCITT = 0x07, // x8+x2+x+1
ommpy 0:d383e2dee0f7 33 POLY_7BIT_SD = 0x9, // x7+x3+1;
ommpy 0:d383e2dee0f7 34 POLY_16BIT_CCITT = 0x1021, // x16+x12+x5+1
ommpy 0:d383e2dee0f7 35 POLY_16BIT_IBM = 0x8005, // x16+x15+x2+1
ommpy 0:d383e2dee0f7 36 POLY_32BIT_ANSI = 0x04C11DB7, // x32+x26+x23+x22+x16+x12+x11+x10+x8+x7+x5+x4+x2+x+1
ommpy 0:d383e2dee0f7 37 POLY_32BIT_REV_ANSI = 0xEDB88320
ommpy 0:d383e2dee0f7 38 } crc_polynomial_t;
ommpy 0:d383e2dee0f7 39
ommpy 0:d383e2dee0f7 40 typedef struct crc_mbed_config {
ommpy 0:d383e2dee0f7 41 /** CRC Polynomial. Example polynomial: 0x21 = 0010_0011 = x^5+x+1 */
ommpy 0:d383e2dee0f7 42 uint32_t polynomial;
ommpy 0:d383e2dee0f7 43 /** CRC Bit Width */
ommpy 0:d383e2dee0f7 44 uint32_t width;
ommpy 0:d383e2dee0f7 45 /** Initial seed value for the computation. */
ommpy 0:d383e2dee0f7 46 uint32_t initial_xor;
ommpy 0:d383e2dee0f7 47 /** Final xor value for the computation. */
ommpy 0:d383e2dee0f7 48 uint32_t final_xor;
ommpy 0:d383e2dee0f7 49 /** Reflect bits on input. */
ommpy 0:d383e2dee0f7 50 bool reflect_in;
ommpy 0:d383e2dee0f7 51 /** Reflect bits in final result before returning. */
ommpy 0:d383e2dee0f7 52 bool reflect_out;
ommpy 0:d383e2dee0f7 53 } crc_mbed_config_t;
ommpy 0:d383e2dee0f7 54
ommpy 0:d383e2dee0f7 55 #if DEVICE_CRC
ommpy 0:d383e2dee0f7 56
ommpy 0:d383e2dee0f7 57 #ifdef __cplusplus
ommpy 0:d383e2dee0f7 58 extern "C" {
ommpy 0:d383e2dee0f7 59 #endif
ommpy 0:d383e2dee0f7 60
ommpy 0:d383e2dee0f7 61 /**
ommpy 0:d383e2dee0f7 62 * \defgroup hal_crc Hardware CRC
ommpy 0:d383e2dee0f7 63 *
ommpy 0:d383e2dee0f7 64 * The Hardware CRC HAL API provides a low-level interface to the Hardware CRC
ommpy 0:d383e2dee0f7 65 * module of a target platform.
ommpy 0:d383e2dee0f7 66 *
ommpy 0:d383e2dee0f7 67 * # Defined behaviour
ommpy 0:d383e2dee0f7 68 *
ommpy 0:d383e2dee0f7 69 * * Function hal_crc_is_supported() returns true if platform supports hardware
ommpy 0:d383e2dee0f7 70 * CRC for the given polynomial/width - verified by test ::crc_is_supported_test.
ommpy 0:d383e2dee0f7 71 * * Function hal_crc_is_supported() returns false if platform does not support hardware
ommpy 0:d383e2dee0f7 72 * CRC for the given polynomial/width - verified by test ::crc_is_supported_test.
ommpy 0:d383e2dee0f7 73 * * Function hal_crc_is_supported() returns false if given pointer to configuration
ommpy 0:d383e2dee0f7 74 * structure is undefined (NULL) - verified by test ::crc_is_supported_invalid_param_test.
ommpy 0:d383e2dee0f7 75 * * If CRC module does not support one of the following settings: initial_xor, final_xor
ommpy 0:d383e2dee0f7 76 * reflect_in, reflect_out, then these operations should be handled by the driver
ommpy 0:d383e2dee0f7 77 * - Verified by test ::crc_calc_single_test.
ommpy 0:d383e2dee0f7 78 * * Platform which supports hardware CRC must be able to handle at least one of the predefined
ommpy 0:d383e2dee0f7 79 * polynomial/width configurations that can be constructed in the MbedCRC class: POLY_8BIT_CCITT,
ommpy 0:d383e2dee0f7 80 * POLY_7BIT_SD, POLY_16BIT_CCITT, POLY_16BIT_IBM, POLY_32BIT_ANSI
ommpy 0:d383e2dee0f7 81 * - verified by test ::crc_is_supported_test, ::crc_calc_single_test.
ommpy 0:d383e2dee0f7 82 * * Function hal_crc_compute_partial_start() configures CRC module with the given configuration
ommpy 0:d383e2dee0f7 83 * - Verified by test ::crc_calc_single_test.
ommpy 0:d383e2dee0f7 84 * * Calling hal_crc_compute_partial_start() without finalising the
ommpy 0:d383e2dee0f7 85 * CRC calculation overrides the current configuration - Verified by test ::crc_reconfigure_test.
ommpy 0:d383e2dee0f7 86 * * Function hal_crc_compute_partial() writes data to the CRC module - verified by test ::crc_calc_single_test.
ommpy 0:d383e2dee0f7 87 * * Function hal_crc_compute_partial() can be call multiple times in succession in order to
ommpy 0:d383e2dee0f7 88 * provide additional data to CRC module - verified by test ::crc_calc_multi_test.
ommpy 0:d383e2dee0f7 89 * * Function hal_crc_compute_partial() does nothing if pointer to buffer is undefined or
ommpy 0:d383e2dee0f7 90 * data length is equal to 0 - verified by test ::crc_compute_partial_invalid_param_test.
ommpy 0:d383e2dee0f7 91 * * Function hal_crc_get_result() returns the checksum result from the CRC module
ommpy 0:d383e2dee0f7 92 * - verified by tests ::crc_calc_single_test, ::crc_calc_multi_test, ::crc_reconfigure_test.
ommpy 0:d383e2dee0f7 93 *
ommpy 0:d383e2dee0f7 94 * # Undefined behaviour
ommpy 0:d383e2dee0f7 95 *
ommpy 0:d383e2dee0f7 96 * * Calling hal_crc_compute_partial_start() function with invalid (unsupported) polynomial.
ommpy 0:d383e2dee0f7 97 * * Calling hal_crc_compute_partial() or hal_crc_get_result() functions before hal_crc_compute_partial_start().
ommpy 0:d383e2dee0f7 98 * * Calling hal_crc_get_result() function multiple times.
ommpy 0:d383e2dee0f7 99 *
ommpy 0:d383e2dee0f7 100 * # Non-functional requirements
ommpy 0:d383e2dee0f7 101 *
ommpy 0:d383e2dee0f7 102 * * CRC configuration provides the following settings:
ommpy 0:d383e2dee0f7 103 * * polynomial - CRC Polynomial,
ommpy 0:d383e2dee0f7 104 * * width - CRC bit width,
ommpy 0:d383e2dee0f7 105 * * initial_xor - seed value for the computation,
ommpy 0:d383e2dee0f7 106 * * final_xor - final xor value for the computation,
ommpy 0:d383e2dee0f7 107 * * reflect_in - reflect bits on input,
ommpy 0:d383e2dee0f7 108 * * reflect_out - reflect bits in final result before returning.
ommpy 0:d383e2dee0f7 109 *
ommpy 0:d383e2dee0f7 110 * # Potential bugs
ommpy 0:d383e2dee0f7 111 *
ommpy 0:d383e2dee0f7 112 * @{
ommpy 0:d383e2dee0f7 113 */
ommpy 0:d383e2dee0f7 114
ommpy 0:d383e2dee0f7 115 /**
ommpy 0:d383e2dee0f7 116 * \defgroup hal_crc_tests crc hal tests
ommpy 0:d383e2dee0f7 117 * The crc HAL tests ensure driver conformance to defined behaviour.
ommpy 0:d383e2dee0f7 118 *
ommpy 0:d383e2dee0f7 119 * To run the crc hal tests use the command:
ommpy 0:d383e2dee0f7 120 *
ommpy 0:d383e2dee0f7 121 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-crc*
ommpy 0:d383e2dee0f7 122 *
ommpy 0:d383e2dee0f7 123 */
ommpy 0:d383e2dee0f7 124
ommpy 0:d383e2dee0f7 125 /** Determine if the current platform supports hardware CRC for given polynomial
ommpy 0:d383e2dee0f7 126 *
ommpy 0:d383e2dee0f7 127 * The purpose of this function is to inform the CRC Platform API whether the
ommpy 0:d383e2dee0f7 128 * current platform has a hardware CRC module and that it can support the
ommpy 0:d383e2dee0f7 129 * requested polynomial.
ommpy 0:d383e2dee0f7 130 *
ommpy 0:d383e2dee0f7 131 * Supported polynomials are restricted to the named polynomials that can be
ommpy 0:d383e2dee0f7 132 * constructed in the MbedCRC class, POLY_8BIT_CCITT, POLY_7BIT_SD,
ommpy 0:d383e2dee0f7 133 * POLY_16BIT_CCITT, POLY_16BIT_IBM and POLY_32BIT_ANSI.
ommpy 0:d383e2dee0f7 134 *
ommpy 0:d383e2dee0f7 135 * The current platform must support the given polynomials default parameters
ommpy 0:d383e2dee0f7 136 * in order to return a true response. These include: reflect in, reflect out,
ommpy 0:d383e2dee0f7 137 * initial xor and final xor. For example, POLY_32BIT_ANSI requires an initial
ommpy 0:d383e2dee0f7 138 * and final xor of 0xFFFFFFFF, and reflection of both input and output. If any
ommpy 0:d383e2dee0f7 139 * of these settings cannot be configured, the polynomial is not supported.
ommpy 0:d383e2dee0f7 140 *
ommpy 0:d383e2dee0f7 141 * This function is thread safe; it safe to call from multiple contexts if
ommpy 0:d383e2dee0f7 142 * required.
ommpy 0:d383e2dee0f7 143 *
ommpy 0:d383e2dee0f7 144 * \param config Contains CRC configuration parameters for initializing the
ommpy 0:d383e2dee0f7 145 * hardware CRC module. For example, polynomial and initial seed
ommpy 0:d383e2dee0f7 146 * values.
ommpy 0:d383e2dee0f7 147 *
ommpy 0:d383e2dee0f7 148 * \return True if running if the polynomial is supported, false if not.
ommpy 0:d383e2dee0f7 149 */
ommpy 0:d383e2dee0f7 150 bool hal_crc_is_supported(const crc_mbed_config_t *config);
ommpy 0:d383e2dee0f7 151
ommpy 0:d383e2dee0f7 152 /** Initialize the hardware CRC module with the given polynomial
ommpy 0:d383e2dee0f7 153 *
ommpy 0:d383e2dee0f7 154 * After calling this function, the CRC HAL module is ready to receive data
ommpy 0:d383e2dee0f7 155 * using the hal_crc_compute_partial() function. The CRC module on the board
ommpy 0:d383e2dee0f7 156 * is configured internally with the specified configuration and is ready
ommpy 0:d383e2dee0f7 157 * to receive data.
ommpy 0:d383e2dee0f7 158 *
ommpy 0:d383e2dee0f7 159 * The platform configures itself based on the default configuration
ommpy 0:d383e2dee0f7 160 * parameters of the input polynomial.
ommpy 0:d383e2dee0f7 161 *
ommpy 0:d383e2dee0f7 162 * This function must be called before calling hal_crc_compute_partial().
ommpy 0:d383e2dee0f7 163 *
ommpy 0:d383e2dee0f7 164 * This function must be called with a valid polynomial supported by the
ommpy 0:d383e2dee0f7 165 * platform. The polynomial must be checked for support using the
ommpy 0:d383e2dee0f7 166 * hal_crc_is_supported() function.
ommpy 0:d383e2dee0f7 167 *
ommpy 0:d383e2dee0f7 168 * Calling hal_crc_compute_partial_start() multiple times without finalizing the
ommpy 0:d383e2dee0f7 169 * CRC calculation with hal_crc_get_result() overrides the current
ommpy 0:d383e2dee0f7 170 * configuration and state, and the intermediate result of the computation is
ommpy 0:d383e2dee0f7 171 * lost.
ommpy 0:d383e2dee0f7 172 *
ommpy 0:d383e2dee0f7 173 * This function is not thread safe. A CRC calculation must not be started from
ommpy 0:d383e2dee0f7 174 * two different threads or contexts at the same time; calling this function
ommpy 0:d383e2dee0f7 175 * from two different contexts may lead to configurations being overwritten and
ommpy 0:d383e2dee0f7 176 * results being lost.
ommpy 0:d383e2dee0f7 177 *
ommpy 0:d383e2dee0f7 178 * \param config Contains CRC configuration parameters for initializing the
ommpy 0:d383e2dee0f7 179 * hardware CRC module. For example, polynomial and initial seed
ommpy 0:d383e2dee0f7 180 * values.
ommpy 0:d383e2dee0f7 181 */
ommpy 0:d383e2dee0f7 182 void hal_crc_compute_partial_start(const crc_mbed_config_t *config);
ommpy 0:d383e2dee0f7 183
ommpy 0:d383e2dee0f7 184 /** Writes data to the current CRC module.
ommpy 0:d383e2dee0f7 185 *
ommpy 0:d383e2dee0f7 186 * Writes input data buffer bytes to the CRC data register. The CRC module
ommpy 0:d383e2dee0f7 187 * must interpret the data as an array of bytes.
ommpy 0:d383e2dee0f7 188 *
ommpy 0:d383e2dee0f7 189 * The final transformations are not applied to the data; the CRC module must
ommpy 0:d383e2dee0f7 190 * retain the intermediate result so that additional calls to this function
ommpy 0:d383e2dee0f7 191 * can be made, appending the additional data to the calculation.
ommpy 0:d383e2dee0f7 192 *
ommpy 0:d383e2dee0f7 193 * To obtain the final result of the CRC calculation, hal_crc_get_result() is
ommpy 0:d383e2dee0f7 194 * called to apply the final transformations to the data.
ommpy 0:d383e2dee0f7 195 *
ommpy 0:d383e2dee0f7 196 * If the function is passed an undefined pointer, or the size of the buffer is
ommpy 0:d383e2dee0f7 197 * specified to be 0, this function does nothing and returns.
ommpy 0:d383e2dee0f7 198 *
ommpy 0:d383e2dee0f7 199 * This function can be called multiple times in succession. This can be used
ommpy 0:d383e2dee0f7 200 * to calculate the CRC result of streamed data.
ommpy 0:d383e2dee0f7 201 *
ommpy 0:d383e2dee0f7 202 * This function is not thread safe. There is only one instance of the CRC
ommpy 0:d383e2dee0f7 203 * module active at a time. Calling this function from multiple contexts
ommpy 0:d383e2dee0f7 204 * appends different data to the same, single instance of the module, which causes an
ommpy 0:d383e2dee0f7 205 * erroneous value to be calculated.
ommpy 0:d383e2dee0f7 206 *
ommpy 0:d383e2dee0f7 207 * \param data Input data stream to be written into the CRC calculation
ommpy 0:d383e2dee0f7 208 * \param size Size of the data stream in bytes
ommpy 0:d383e2dee0f7 209 */
ommpy 0:d383e2dee0f7 210 void hal_crc_compute_partial(const uint8_t *data, const size_t size);
ommpy 0:d383e2dee0f7 211
ommpy 0:d383e2dee0f7 212 /* Reads the checksum result from the CRC module.
ommpy 0:d383e2dee0f7 213 *
ommpy 0:d383e2dee0f7 214 * Reads the final checksum result for the final checksum value. The returned
ommpy 0:d383e2dee0f7 215 * value is cast as an unsigned 32-bit integer. The actual size of the returned
ommpy 0:d383e2dee0f7 216 * result depends on the polynomial used to configure the CRC module.
ommpy 0:d383e2dee0f7 217 *
ommpy 0:d383e2dee0f7 218 * Additional transformations that are used in the default configuration of the
ommpy 0:d383e2dee0f7 219 * input polynomial are applied to the result before it is returned from this
ommpy 0:d383e2dee0f7 220 * function. These transformations include: the final xor being appended to the
ommpy 0:d383e2dee0f7 221 * calculation, and the result being reflected if required.
ommpy 0:d383e2dee0f7 222 *
ommpy 0:d383e2dee0f7 223 * Calling this function multiple times is undefined. The first call to this
ommpy 0:d383e2dee0f7 224 * function returns the final result of the CRC calculation. The return
ommpy 0:d383e2dee0f7 225 * value on successive calls is undefined because the contents of the register after
ommpy 0:d383e2dee0f7 226 * accessing them is platform-specific.
ommpy 0:d383e2dee0f7 227 *
ommpy 0:d383e2dee0f7 228 * This function is not thread safe. There is only one instance of the CRC
ommpy 0:d383e2dee0f7 229 * module active at a time. Calling this function from multiple contexts may
ommpy 0:d383e2dee0f7 230 * return incorrect data or affect the current state of the module.
ommpy 0:d383e2dee0f7 231 *
ommpy 0:d383e2dee0f7 232 * \return The final CRC checksum after the reflections and final calculations
ommpy 0:d383e2dee0f7 233 * have been applied.
ommpy 0:d383e2dee0f7 234 */
ommpy 0:d383e2dee0f7 235 uint32_t hal_crc_get_result(void);
ommpy 0:d383e2dee0f7 236
ommpy 0:d383e2dee0f7 237 /**@}*/
ommpy 0:d383e2dee0f7 238
ommpy 0:d383e2dee0f7 239 #ifdef __cplusplus
ommpy 0:d383e2dee0f7 240 };
ommpy 0:d383e2dee0f7 241 #endif
ommpy 0:d383e2dee0f7 242
ommpy 0:d383e2dee0f7 243 #endif // DEVICE_CRC
ommpy 0:d383e2dee0f7 244 #endif // MBED_CRC_HAL_API_H
ommpy 0:d383e2dee0f7 245
ommpy 0:d383e2dee0f7 246 /**@}*/