tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F0/stm32f0xx_hal_crc_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f0xx_hal_crc_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.2.0
   6   * @date    11-December-2014
   7   * @brief   Header file of CRC HAL extension module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F0xx_HAL_CRC_EX_H
  40 #define __STM32F0xx_HAL_CRC_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f0xx_hal_def.h"
  48
  49 /** @addtogroup STM32F0xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup CRCEx CRCEx Extended HAL Module Driver
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /* Exported constants --------------------------------------------------------*/
  59 /** @defgroup CRCEx_Exported_Constants CRCEx Exported Constants
  60   * @{
  61   */
  62 /** @defgroup CRCEx_Input_Data_Inversion Input Data Inversion Modes
  63   * @{
  64   */
  65 #define CRC_INPUTDATA_INVERSION_NONE              ((uint32_t)0x00000000)
  66 #define CRC_INPUTDATA_INVERSION_BYTE              ((uint32_t)CRC_CR_REV_IN_0)
  67 #define CRC_INPUTDATA_INVERSION_HALFWORD          ((uint32_t)CRC_CR_REV_IN_1)
  68 #define CRC_INPUTDATA_INVERSION_WORD              ((uint32_t)CRC_CR_REV_IN)
  69
  70 #define IS_CRC_INPUTDATA_INVERSION_MODE(MODE)     (((MODE) == CRC_INPUTDATA_INVERSION_NONE) || \
  71                                                    ((MODE) == CRC_INPUTDATA_INVERSION_BYTE) || \
  72                                                    ((MODE) == CRC_INPUTDATA_INVERSION_HALFWORD) || \
  73                                                    ((MODE) == CRC_INPUTDATA_INVERSION_WORD))
  74 /**
  75   * @}
  76   */
  77
  78 /** @defgroup CRCEx_Output_Data_Inversion Output Data Inversion Modes
  79   * @{
  80   */
  81 #define CRC_OUTPUTDATA_INVERSION_DISABLED         ((uint32_t)0x00000000)
  82 #define CRC_OUTPUTDATA_INVERSION_ENABLED          ((uint32_t)CRC_CR_REV_OUT)
  83
  84 #define IS_CRC_OUTPUTDATA_INVERSION_MODE(MODE)    (((MODE) == CRC_OUTPUTDATA_INVERSION_DISABLED) || \
  85                                                    ((MODE) == CRC_OUTPUTDATA_INVERSION_ENABLED))
  86 /**
  87   * @}
  88   */
  89
  90 /** @defgroup CRCEx_Polynomial_Sizes Polynomial sizes to configure the IP
  91   * @{
  92   */
  93 #if defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx)
  94 #define CRC_POLYLENGTH_32B                  ((uint32_t)0x00000000)
  95 #define CRC_POLYLENGTH_16B                  ((uint32_t)CRC_CR_POLYSIZE_0)
  96 #define CRC_POLYLENGTH_8B                   ((uint32_t)CRC_CR_POLYSIZE_1)
  97 #define CRC_POLYLENGTH_7B                   ((uint32_t)CRC_CR_POLYSIZE)
  98 #define IS_CRC_POL_LENGTH(LENGTH)     (((LENGTH) == CRC_POLYLENGTH_32B) || \
  99                                        ((LENGTH) == CRC_POLYLENGTH_16B) || \
 100                                        ((LENGTH) == CRC_POLYLENGTH_8B)  || \
 101                                        ((LENGTH) == CRC_POLYLENGTH_7B))
 102 #else
 103 #define CRC_POLYLENGTH_32B                  ((uint32_t)0x00000000)
 104 #define IS_CRC_POL_LENGTH(LENGTH)     ((LENGTH) == CRC_POLYLENGTH_32B)
 105 #endif /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) */
 106 /**
 107   * @}
 108   */
 109
 110 /** @defgroup CRCEx_Polynomial_Size_Definitions CRC polynomial possible sizes actual definitions
 111   * @{
 112   */
 113 #if defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx)
 114 #define HAL_CRC_LENGTH_32B     32
 115 #define HAL_CRC_LENGTH_16B     16
 116 #define HAL_CRC_LENGTH_8B       8
 117 #define HAL_CRC_LENGTH_7B       7
 118 #else
 119 #define HAL_CRC_LENGTH_32B     32
 120 #endif /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) */
 121 /**
 122   * @}
 123   */
 124
 125 /**
 126   * @}
 127   */
 128 /* Exported macro ------------------------------------------------------------*/
 129
 130 /** @defgroup CRCEx_Exported_Macros CRCEx Exported Macros
 131   * @{
 132   */
 133
 134 /**
 135   * @brief  Set CRC output reversal
 136   * @param  __HANDLE__    : CRC handle
 137   * @retval None.
 138   */
 139 #define  __HAL_CRC_OUTPUTREVERSAL_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_REV_OUT)
 140
 141 /**
 142   * @brief  Unset CRC output reversal
 143   * @param  __HANDLE__    : CRC handle
 144   * @retval None.
 145   */
 146 #define __HAL_CRC_OUTPUTREVERSAL_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(CRC_CR_REV_OUT))
 147
 148 #if defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) || defined(STM32F070xB) || defined(STM32F030xC)
 149 /**
 150   * @brief  Set CRC non-default polynomial
 151   * @param  __HANDLE__    : CRC handle
 152   * @param  __POLYNOMIAL__: 7, 8, 16 or 32-bit polynomial
 153   * @retval None.
 154   */
 155 #define __HAL_CRC_POLYNOMIAL_CONFIG(__HANDLE__, __POLYNOMIAL__) ((__HANDLE__)->Instance->POL = (__POLYNOMIAL__))
 156 #endif /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) || defined(STM32F070xB) || defined(STM32F030xC) */
 157 /**
 158   * @}
 159   */
 160
 161 /* Exported functions --------------------------------------------------------*/
 162 /** @addtogroup CRCEx_Exported_Functions
 163   * @{
 164   */
 165
 166 /** @addtogroup CRCEx_Exported_Functions_Group1 Extended Initialization/de-initialization functions
 167   * @brief    Extended Initialization and Configuration functions.
 168   * @{
 169   */
 170
 171 /* Initialization and de-initialization functions  ****************************/
 172 HAL_StatusTypeDef HAL_CRCEx_Init(CRC_HandleTypeDef *hcrc);
 173 HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t InputReverseMode);
 174 HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t OutputReverseMode);
 175
 176 #if defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) || defined(STM32F070xB) || defined(STM32F030xC)
 177 HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set(CRC_HandleTypeDef *hcrc, uint32_t Pol, uint32_t PolyLength);
 178 #endif /* defined(STM32F071xB) || defined(STM32F072xB) || defined(STM32F078xx) || defined(STM32F091xC) || defined(STM32F098xx) || defined(STM32F070xB) || defined(STM32F030xC) */
 179 /**
 180   * @}
 181   */
 182 /* Peripheral Control functions ***********************************************/
 183 /* Peripheral State and Error functions ***************************************/
 184 /**
 185   * @}
 186   */
 187
 188 /**
 189   * @}
 190   */
 191
 192 /**
 193   * @}
 194   */
 195
 196 #ifdef __cplusplus
 197 }
 198 #endif
 199
 200 #endif /* __STM32F0xx_HAL_CRC_EX_H */
 201
 202 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/