mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

targets/TARGET_STM/TARGET_STM32F0/device/stm32f0xx_hal_crc_ex.c@156:95d6b41a828b, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 15:03:32 2017 +0000
Revision:
156:95d6b41a828b
Parent:
149:156823d33999
Child:
180:96ed750bd169
This updates the lib to the mbed lib v134

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /**
<> 144:ef7eb2e8f9f7 2 ******************************************************************************
<> 144:ef7eb2e8f9f7 3 * @file stm32f0xx_hal_crc_ex.c
<> 144:ef7eb2e8f9f7 4 * @author MCD Application Team
<> 156:95d6b41a828b 5 * @version V1.5.0
<> 156:95d6b41a828b 6 * @date 04-November-2016
<> 144:ef7eb2e8f9f7 7 * @brief Extended CRC HAL module driver.
<> 144:ef7eb2e8f9f7 8 * This file provides firmware functions to manage the following
<> 144:ef7eb2e8f9f7 9 * functionalities of the CRC peripheral:
<> 144:ef7eb2e8f9f7 10 * + Extended initialization functions
<> 144:ef7eb2e8f9f7 11 *
<> 144:ef7eb2e8f9f7 12 @verbatim
<> 144:ef7eb2e8f9f7 13 ================================================================================
<> 144:ef7eb2e8f9f7 14 ##### How to use this driver #####
<> 144:ef7eb2e8f9f7 15 ================================================================================
<> 144:ef7eb2e8f9f7 16 [..]
<> 144:ef7eb2e8f9f7 17 (+) Extended initialization
<> 144:ef7eb2e8f9f7 18 (+) Set or not user-defined generating
<> 144:ef7eb2e8f9f7 19 polynomial other than default one
<> 144:ef7eb2e8f9f7 20
<> 144:ef7eb2e8f9f7 21 @endverbatim
<> 144:ef7eb2e8f9f7 22 ******************************************************************************
<> 144:ef7eb2e8f9f7 23 * @attention
<> 144:ef7eb2e8f9f7 24 *
<> 144:ef7eb2e8f9f7 25 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
<> 144:ef7eb2e8f9f7 26 *
<> 144:ef7eb2e8f9f7 27 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 28 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 29 * 1. Redistributions of source code must retain the above copyright notice,
<> 144:ef7eb2e8f9f7 30 * this list of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 31 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 144:ef7eb2e8f9f7 32 * this list of conditions and the following disclaimer in the documentation
<> 144:ef7eb2e8f9f7 33 * and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 34 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 144:ef7eb2e8f9f7 35 * may be used to endorse or promote products derived from this software
<> 144:ef7eb2e8f9f7 36 * without specific prior written permission.
<> 144:ef7eb2e8f9f7 37 *
<> 144:ef7eb2e8f9f7 38 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 144:ef7eb2e8f9f7 39 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 144:ef7eb2e8f9f7 40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 41 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 144:ef7eb2e8f9f7 42 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 144:ef7eb2e8f9f7 43 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 144:ef7eb2e8f9f7 44 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 144:ef7eb2e8f9f7 45 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 144:ef7eb2e8f9f7 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 144:ef7eb2e8f9f7 47 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 48 *
<> 144:ef7eb2e8f9f7 49 ******************************************************************************
<> 144:ef7eb2e8f9f7 50 */
<> 144:ef7eb2e8f9f7 51
<> 144:ef7eb2e8f9f7 52 /* Includes ------------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 53 #include "stm32f0xx_hal.h"
<> 144:ef7eb2e8f9f7 54
<> 144:ef7eb2e8f9f7 55 /** @addtogroup STM32F0xx_HAL_Driver
<> 144:ef7eb2e8f9f7 56 * @{
<> 144:ef7eb2e8f9f7 57 */
<> 144:ef7eb2e8f9f7 58
<> 144:ef7eb2e8f9f7 59 /** @defgroup CRCEx CRCEx
<> 144:ef7eb2e8f9f7 60 * @brief CRC Extended HAL module driver
<> 144:ef7eb2e8f9f7 61 * @{
<> 144:ef7eb2e8f9f7 62 */
<> 144:ef7eb2e8f9f7 63
<> 144:ef7eb2e8f9f7 64 #ifdef HAL_CRC_MODULE_ENABLED
<> 144:ef7eb2e8f9f7 65
<> 144:ef7eb2e8f9f7 66 /* Private typedef -----------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 67 /* Private define ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 68 /* Private macro -------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 69 /* Private variables ---------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 70 /* Private function prototypes -----------------------------------------------*/
<> 144:ef7eb2e8f9f7 71 /* Private functions ---------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 72
<> 144:ef7eb2e8f9f7 73 /** @defgroup CRCEx_Exported_Functions CRCEx Exported Functions
<> 144:ef7eb2e8f9f7 74 * @{
<> 144:ef7eb2e8f9f7 75 */
<> 144:ef7eb2e8f9f7 76
<> 144:ef7eb2e8f9f7 77 /** @defgroup CRCEx_Exported_Functions_Group1 Extended Initialization/de-initialization functions
<> 144:ef7eb2e8f9f7 78 * @brief Extended Initialization and Configuration functions.
<> 144:ef7eb2e8f9f7 79 *
<> 144:ef7eb2e8f9f7 80 @verbatim
<> 144:ef7eb2e8f9f7 81 ===============================================================================
<> 144:ef7eb2e8f9f7 82 ##### Initialization and Configuration functions #####
<> 144:ef7eb2e8f9f7 83 ===============================================================================
<> 144:ef7eb2e8f9f7 84 [..] This section provides functions allowing to:
<> 144:ef7eb2e8f9f7 85 (+) Initialize the CRC generating polynomial: if programmable polynomial
<> 144:ef7eb2e8f9f7 86 feature is applicable to device, set default or non-default generating
<> 144:ef7eb2e8f9f7 87 polynomial according to hcrc->Init.DefaultPolynomialUse parameter.
<> 144:ef7eb2e8f9f7 88 If feature is non-applicable to device in use, HAL_CRCEx_Init straight
<> 144:ef7eb2e8f9f7 89 away reports HAL_OK.
<> 144:ef7eb2e8f9f7 90 (+) Set the generating polynomial
<> 144:ef7eb2e8f9f7 91
<> 144:ef7eb2e8f9f7 92 @endverbatim
<> 144:ef7eb2e8f9f7 93 * @{
<> 144:ef7eb2e8f9f7 94 */
<> 144:ef7eb2e8f9f7 95
<> 144:ef7eb2e8f9f7 96
<> 144:ef7eb2e8f9f7 97 /**
<> 144:ef7eb2e8f9f7 98 * @brief Extended initialization to set generating polynomial
<> 144:ef7eb2e8f9f7 99 * @param hcrc: CRC handle
<> 144:ef7eb2e8f9f7 100 * @retval HAL status
<> 144:ef7eb2e8f9f7 101 */
<> 144:ef7eb2e8f9f7 102 HAL_StatusTypeDef HAL_CRCEx_Init(CRC_HandleTypeDef *hcrc)
<> 144:ef7eb2e8f9f7 103 {
<> 144:ef7eb2e8f9f7 104 #if defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined (STM32F098xx)
<> 144:ef7eb2e8f9f7 105 /* check whether or not non-default generating polynomial has been
<> 144:ef7eb2e8f9f7 106 * picked up by user */
<> 144:ef7eb2e8f9f7 107 assert_param(IS_DEFAULT_POLYNOMIAL(hcrc->Init.DefaultPolynomialUse));
<> 144:ef7eb2e8f9f7 108 if (hcrc->Init.DefaultPolynomialUse == DEFAULT_POLYNOMIAL_ENABLE)
<> 144:ef7eb2e8f9f7 109 {
<> 144:ef7eb2e8f9f7 110 /* initialize IP with default generating polynomial */
<> 144:ef7eb2e8f9f7 111 WRITE_REG(hcrc->Instance->POL, DEFAULT_CRC32_POLY);
<> 144:ef7eb2e8f9f7 112 MODIFY_REG(hcrc->Instance->CR, CRC_CR_POLYSIZE, CRC_POLYLENGTH_32B);
<> 144:ef7eb2e8f9f7 113 }
<> 144:ef7eb2e8f9f7 114 else
<> 144:ef7eb2e8f9f7 115 {
<> 144:ef7eb2e8f9f7 116 /* initialize CRC IP with generating polynomial defined by user */
<> 144:ef7eb2e8f9f7 117 if (HAL_CRCEx_Polynomial_Set(hcrc, hcrc->Init.GeneratingPolynomial, hcrc->Init.CRCLength) != HAL_OK)
<> 144:ef7eb2e8f9f7 118 {
<> 144:ef7eb2e8f9f7 119 return HAL_ERROR;
<> 144:ef7eb2e8f9f7 120 }
<> 144:ef7eb2e8f9f7 121 }
<> 144:ef7eb2e8f9f7 122 #endif /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined (STM32F098xx) */
<> 144:ef7eb2e8f9f7 123
<> 144:ef7eb2e8f9f7 124 return HAL_OK;
<> 144:ef7eb2e8f9f7 125 }
<> 144:ef7eb2e8f9f7 126
<> 144:ef7eb2e8f9f7 127 /**
<> 144:ef7eb2e8f9f7 128 * @brief Set the Reverse Input data mode.
<> 144:ef7eb2e8f9f7 129 * @param hcrc: CRC handle
<> 144:ef7eb2e8f9f7 130 * @param InputReverseMode: Input Data inversion mode
<> 144:ef7eb2e8f9f7 131 * This parameter can be one of the following values:
<> 144:ef7eb2e8f9f7 132 * @arg CRC_INPUTDATA_NOINVERSION: no change in bit order (default value)
<> 144:ef7eb2e8f9f7 133 * @arg CRC_INPUTDATA_INVERSION_BYTE: Byte-wise bit reversal
<> 144:ef7eb2e8f9f7 134 * @arg CRC_INPUTDATA_INVERSION_HALFWORD: HalfWord-wise bit reversal
<> 144:ef7eb2e8f9f7 135 * @arg CRC_INPUTDATA_INVERSION_WORD: Word-wise bit reversal
<> 144:ef7eb2e8f9f7 136 * @retval HAL status
<> 144:ef7eb2e8f9f7 137 */
<> 144:ef7eb2e8f9f7 138 HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t InputReverseMode)
<> 144:ef7eb2e8f9f7 139 {
<> 144:ef7eb2e8f9f7 140 /* Check the parameters */
<> 144:ef7eb2e8f9f7 141 assert_param(IS_CRC_INPUTDATA_INVERSION_MODE(InputReverseMode));
<> 144:ef7eb2e8f9f7 142
<> 144:ef7eb2e8f9f7 143 /* Change CRC peripheral state */
<> 144:ef7eb2e8f9f7 144 hcrc->State = HAL_CRC_STATE_BUSY;
<> 144:ef7eb2e8f9f7 145
<> 144:ef7eb2e8f9f7 146 /* set input data inversion mode */
<> 144:ef7eb2e8f9f7 147 MODIFY_REG(hcrc->Instance->CR, CRC_CR_REV_IN, InputReverseMode);
<> 144:ef7eb2e8f9f7 148 /* Change CRC peripheral state */
<> 144:ef7eb2e8f9f7 149 hcrc->State = HAL_CRC_STATE_READY;
<> 144:ef7eb2e8f9f7 150
<> 144:ef7eb2e8f9f7 151 /* Return function status */
<> 144:ef7eb2e8f9f7 152 return HAL_OK;
<> 144:ef7eb2e8f9f7 153 }
<> 144:ef7eb2e8f9f7 154
<> 144:ef7eb2e8f9f7 155 /**
<> 144:ef7eb2e8f9f7 156 * @brief Set the Reverse Output data mode.
<> 144:ef7eb2e8f9f7 157 * @param hcrc: CRC handle
<> 144:ef7eb2e8f9f7 158 * @param OutputReverseMode: Output Data inversion mode
<> 144:ef7eb2e8f9f7 159 * This parameter can be one of the following values:
<> 144:ef7eb2e8f9f7 160 * @arg CRC_OUTPUTDATA_INVERSION_DISABLE: no CRC inversion (default value)
<> 144:ef7eb2e8f9f7 161 * @arg CRC_OUTPUTDATA_INVERSION_ENABLE: bit-level inversion (e.g for a 8-bit CRC: 0xB5 becomes 0xAD)
<> 144:ef7eb2e8f9f7 162 * @retval HAL status
<> 144:ef7eb2e8f9f7 163 */
<> 144:ef7eb2e8f9f7 164 HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t OutputReverseMode)
<> 144:ef7eb2e8f9f7 165 {
<> 144:ef7eb2e8f9f7 166 /* Check the parameters */
<> 144:ef7eb2e8f9f7 167 assert_param(IS_CRC_OUTPUTDATA_INVERSION_MODE(OutputReverseMode));
<> 144:ef7eb2e8f9f7 168
<> 144:ef7eb2e8f9f7 169 /* Change CRC peripheral state */
<> 144:ef7eb2e8f9f7 170 hcrc->State = HAL_CRC_STATE_BUSY;
<> 144:ef7eb2e8f9f7 171
<> 144:ef7eb2e8f9f7 172 /* set output data inversion mode */
<> 144:ef7eb2e8f9f7 173 MODIFY_REG(hcrc->Instance->CR, CRC_CR_REV_OUT, OutputReverseMode);
<> 144:ef7eb2e8f9f7 174
<> 144:ef7eb2e8f9f7 175 /* Change CRC peripheral state */
<> 144:ef7eb2e8f9f7 176 hcrc->State = HAL_CRC_STATE_READY;
<> 144:ef7eb2e8f9f7 177
<> 144:ef7eb2e8f9f7 178 /* Return function status */
<> 144:ef7eb2e8f9f7 179 return HAL_OK;
<> 144:ef7eb2e8f9f7 180 }
<> 144:ef7eb2e8f9f7 181
<> 144:ef7eb2e8f9f7 182 #if defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || defined (STM32F091xC) || defined (STM32F098xx)
<> 144:ef7eb2e8f9f7 183 /**
<> 144:ef7eb2e8f9f7 184 * @brief Initializes the CRC polynomial if different from default one.
<> 144:ef7eb2e8f9f7 185 * @param hcrc: CRC handle
<> 144:ef7eb2e8f9f7 186 * @param Pol: CRC generating polynomial (7, 8, 16 or 32-bit long)
<> 144:ef7eb2e8f9f7 187 * This parameter is written in normal representation, e.g.
<> 144:ef7eb2e8f9f7 188 * for a polynomial of degree 7, X^7 + X^6 + X^5 + X^2 + 1 is written 0x65
<> 144:ef7eb2e8f9f7 189 * for a polynomial of degree 16, X^16 + X^12 + X^5 + 1 is written 0x1021
<> 144:ef7eb2e8f9f7 190 * @param PolyLength: CRC polynomial length
<> 144:ef7eb2e8f9f7 191 * This parameter can be one of the following values:
<> 144:ef7eb2e8f9f7 192 * @arg CRC_POLYLENGTH_7B: 7-bit long CRC (generating polynomial of degree 7)
<> 144:ef7eb2e8f9f7 193 * @arg CRC_POLYLENGTH_8B: 8-bit long CRC (generating polynomial of degree 8)
<> 144:ef7eb2e8f9f7 194 * @arg CRC_POLYLENGTH_16B: 16-bit long CRC (generating polynomial of degree 16)
<> 144:ef7eb2e8f9f7 195 * @arg CRC_POLYLENGTH_32B: 32-bit long CRC (generating polynomial of degree 32)
<> 144:ef7eb2e8f9f7 196 * @retval HAL status
<> 144:ef7eb2e8f9f7 197 */
<> 144:ef7eb2e8f9f7 198 HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set(CRC_HandleTypeDef *hcrc, uint32_t Pol, uint32_t PolyLength)
<> 144:ef7eb2e8f9f7 199 {
<> 156:95d6b41a828b 200 uint32_t msb = 31U; /* polynomial degree is 32 at most, so msb is initialized to max value */
<> 144:ef7eb2e8f9f7 201
<> 144:ef7eb2e8f9f7 202 /* Check the parameters */
<> 144:ef7eb2e8f9f7 203 assert_param(IS_CRC_POL_LENGTH(PolyLength));
<> 144:ef7eb2e8f9f7 204
<> 144:ef7eb2e8f9f7 205 /* check polynomial definition vs polynomial size:
<> 144:ef7eb2e8f9f7 206 * polynomial length must be aligned with polynomial
<> 144:ef7eb2e8f9f7 207 * definition. HAL_ERROR is reported if Pol degree is
<> 144:ef7eb2e8f9f7 208 * larger than that indicated by PolyLength.
<> 144:ef7eb2e8f9f7 209 * Look for MSB position: msb will contain the degree of
<> 144:ef7eb2e8f9f7 210 * the second to the largest polynomial member. E.g., for
<> 144:ef7eb2e8f9f7 211 * X^7 + X^6 + X^5 + X^2 + 1, msb = 6. */
<> 156:95d6b41a828b 212 while (((Pol & (1U << msb)) == 0U) && (msb-- > 0U))
<> 144:ef7eb2e8f9f7 213 {}
<> 144:ef7eb2e8f9f7 214
<> 144:ef7eb2e8f9f7 215 switch (PolyLength)
<> 144:ef7eb2e8f9f7 216 {
<> 144:ef7eb2e8f9f7 217 case CRC_POLYLENGTH_7B:
<> 144:ef7eb2e8f9f7 218 if (msb >= HAL_CRC_LENGTH_7B)
<> 144:ef7eb2e8f9f7 219 {
<> 144:ef7eb2e8f9f7 220 return HAL_ERROR;
<> 144:ef7eb2e8f9f7 221 }
<> 144:ef7eb2e8f9f7 222 break;
<> 144:ef7eb2e8f9f7 223 case CRC_POLYLENGTH_8B:
<> 144:ef7eb2e8f9f7 224 if (msb >= HAL_CRC_LENGTH_8B)
<> 144:ef7eb2e8f9f7 225 {
<> 144:ef7eb2e8f9f7 226 return HAL_ERROR;
<> 144:ef7eb2e8f9f7 227 }
<> 144:ef7eb2e8f9f7 228 break;
<> 144:ef7eb2e8f9f7 229 case CRC_POLYLENGTH_16B:
<> 144:ef7eb2e8f9f7 230 if (msb >= HAL_CRC_LENGTH_16B)
<> 144:ef7eb2e8f9f7 231 {
<> 144:ef7eb2e8f9f7 232 return HAL_ERROR;
<> 144:ef7eb2e8f9f7 233 }
<> 144:ef7eb2e8f9f7 234 break;
<> 144:ef7eb2e8f9f7 235 case CRC_POLYLENGTH_32B:
<> 144:ef7eb2e8f9f7 236 /* no polynomial definition vs. polynomial length issue possible */
<> 144:ef7eb2e8f9f7 237 break;
<> 144:ef7eb2e8f9f7 238 default:
<> 144:ef7eb2e8f9f7 239 break;
<> 144:ef7eb2e8f9f7 240 }
<> 144:ef7eb2e8f9f7 241
<> 144:ef7eb2e8f9f7 242 /* set generating polynomial */
<> 144:ef7eb2e8f9f7 243 WRITE_REG(hcrc->Instance->POL, Pol);
<> 144:ef7eb2e8f9f7 244
<> 144:ef7eb2e8f9f7 245 /* set generating polynomial size */
<> 144:ef7eb2e8f9f7 246 MODIFY_REG(hcrc->Instance->CR, CRC_CR_POLYSIZE, PolyLength);
<> 144:ef7eb2e8f9f7 247
<> 144:ef7eb2e8f9f7 248 /* Return function status */
<> 144:ef7eb2e8f9f7 249 return HAL_OK;
<> 144:ef7eb2e8f9f7 250 }
<> 144:ef7eb2e8f9f7 251 #endif /* #if defined (STM32F071xB) || defined (STM32F072xB) || defined (STM32F078xx) || defined (STM32F091xC) || defined (STM32F098xx) */
<> 144:ef7eb2e8f9f7 252
<> 144:ef7eb2e8f9f7 253 /**
<> 144:ef7eb2e8f9f7 254 * @}
<> 144:ef7eb2e8f9f7 255 */
<> 144:ef7eb2e8f9f7 256
<> 144:ef7eb2e8f9f7 257
<> 144:ef7eb2e8f9f7 258 /**
<> 144:ef7eb2e8f9f7 259 * @}
<> 144:ef7eb2e8f9f7 260 */
<> 144:ef7eb2e8f9f7 261
<> 144:ef7eb2e8f9f7 262
<> 144:ef7eb2e8f9f7 263 #endif /* HAL_CRC_MODULE_ENABLED */
<> 144:ef7eb2e8f9f7 264 /**
<> 144:ef7eb2e8f9f7 265 * @}
<> 144:ef7eb2e8f9f7 266 */
<> 144:ef7eb2e8f9f7 267
<> 144:ef7eb2e8f9f7 268 /**
<> 144:ef7eb2e8f9f7 269 * @}
<> 144:ef7eb2e8f9f7 270 */
<> 144:ef7eb2e8f9f7 271
<> 144:ef7eb2e8f9f7 272 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/