Steve Kim / mbed-src-test

mbed library sources

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32L0/stm32l0xx_hal_crc_ex.c@590:0835b0fc9a03, 2015-07-14 (annotated)

Committer:
SteveKim
Date:
Tue Jul 14 10:20:51 2015 +0000
Revision:
590:0835b0fc9a03
Parent:
489:119543c9f674 
.

Who changed what in which revision?

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