tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_crc_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_crc_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-2014
   7   * @brief   Header file of CRC HAL Extended 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 __STM32F3xx_HAL_CRC_EX_H
  40 #define __STM32F3xx_HAL_CRC_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f3xx_hal_def.h"
  48
  49 /** @addtogroup STM32F3xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup CRCEx
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /* Exported constants --------------------------------------------------------*/
  59 /** @defgroup CRCEx_Exported_Constants CRC Extended Exported Constants
  60   * @{
  61   */
  62
  63 /** @defgroup CRCEx_Input_Data_Inversion CRC Extended Input Data Inversion Modes
  64   * @{
  65   */
  66 #define CRC_INPUTDATA_INVERSION_NONE              ((uint32_t)0x00000000)
  67 #define CRC_INPUTDATA_INVERSION_BYTE              ((uint32_t)CRC_CR_REV_IN_0)
  68 #define CRC_INPUTDATA_INVERSION_HALFWORD          ((uint32_t)CRC_CR_REV_IN_1)
  69 #define CRC_INPUTDATA_INVERSION_WORD              ((uint32_t)CRC_CR_REV_IN)
  70
  71 #define IS_CRC_INPUTDATA_INVERSION_MODE(MODE)     (((MODE) == CRC_INPUTDATA_INVERSION_NONE) || \
  72                                                    ((MODE) == CRC_INPUTDATA_INVERSION_BYTE) || \
  73                                                    ((MODE) == CRC_INPUTDATA_INVERSION_HALFWORD) || \
  74                                                    ((MODE) == CRC_INPUTDATA_INVERSION_WORD))
  75 /**
  76   * @}
  77   */
  78
  79 /** @defgroup CRCEx_Output_Data_Inversion CRC Extended Output Data Inversion Modes
  80   * @{
  81   */
  82 #define CRC_OUTPUTDATA_INVERSION_DISABLED         ((uint32_t)0x00000000)
  83 #define CRC_OUTPUTDATA_INVERSION_ENABLED          ((uint32_t)CRC_CR_REV_OUT)
  84
  85 #define IS_CRC_OUTPUTDATA_INVERSION_MODE(MODE)    (((MODE) == CRC_OUTPUTDATA_INVERSION_DISABLED) || \
  86                                                    ((MODE) == CRC_OUTPUTDATA_INVERSION_ENABLED))
  87 /**
  88   * @}
  89   */
  90
  91 /**
  92   * @}
  93   */
  94
  95 /* Exported macro ------------------------------------------------------------*/
  96
  97 /** @defgroup CRCEx_Exported_Macros CRC Extended Exported Macros
  98   * @{
  99   */
 100
 101 /**
 102   * @brief  Set CRC output reversal
 103   * @param  __HANDLE__    : CRC handle
 104   * @retval None.
 105   */
 106 #define  __HAL_CRC_OUTPUTREVERSAL_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_REV_OUT)
 107
 108 /**
 109   * @brief  Unset CRC output reversal
 110   * @param  __HANDLE__    : CRC handle
 111   * @retval None.
 112   */
 113 #define __HAL_CRC_OUTPUTREVERSAL_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(CRC_CR_REV_OUT))
 114
 115 /**
 116   * @brief  Set CRC non-default polynomial
 117   * @param  __HANDLE__    : CRC handle
 118   * @param  __POLYNOMIAL__: 7, 8, 16 or 32-bit polynomial
 119   * @retval None.
 120   */
 121 #define __HAL_CRC_POLYNOMIAL_CONFIG(__HANDLE__, __POLYNOMIAL__) ((__HANDLE__)->Instance->POL = (__POLYNOMIAL__))
 122
 123 /**
 124   * @}
 125   */
 126
 127 /* Exported functions --------------------------------------------------------*/
 128 /** @addtogroup CRCEx_Exported_Functions CRC Extended Exported Functions
 129   * @{
 130   */
 131
 132 /** @addtogroup CRCEx_Exported_Functions_Group1 Extended Initialization and de-initialization functions
 133   * @brief    Extended Initialization and Configuration functions.
 134   * @{
 135   */
 136 /* Initialization and de-initialization functions  ****************************/
 137 HAL_StatusTypeDef HAL_CRCEx_Polynomial_Set(CRC_HandleTypeDef *hcrc, uint32_t Pol, uint32_t PolyLength);
 138 HAL_StatusTypeDef HAL_CRCEx_Input_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t InputReverseMode);
 139 HAL_StatusTypeDef HAL_CRCEx_Output_Data_Reverse(CRC_HandleTypeDef *hcrc, uint32_t OutputReverseMode);
 140 /**
 141   * @}
 142   */
 143
 144 /* Peripheral Control functions ***********************************************/
 145 /* Peripheral State and Error functions ***************************************/
 146
 147 /**
 148   * @}
 149   */
 150
 151 /**
 152   * @}
 153   */
 154
 155 /**
 156   * @}
 157   */
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif
 162
 163 #endif /* __STM32F3xx_HAL_CRC_EX_H */
 164
 165 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/