Joris Aerts / mbed-src

mbed library sources

Dependents:   Marvino mbot

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_crc_ex.c@610:813dcc80987e, 2015-08-14 (annotated)

Committer:
mbed_official
Date:
Fri Aug 14 13:15:17 2015 +0100
Revision:
610:813dcc80987e
Parent:
573:ad23fe03a082 
Synchronized with git revision 6d84db41c6833e0b9b024741eb0616a5f62d5599



Full URL: https://github.com/mbedmicro/mbed/commit/6d84db41c6833e0b9b024741eb0616a5f62d5599/



DISCO_F746NG - Improvements

Who changed what in which revision?

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