lib/main/STM32F1/Drivers/STM32F1xx_HAL_Driver/Inc/stm32f1xx_hal_crc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_hal_crc.h
   4   * @author  MCD Application Team
   5   * @version V1.1.1
   6   * @date    12-May-2017
   7   * @brief   Header file of CRC HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F1xx_HAL_CRC_H
  40 #define __STM32F1xx_HAL_CRC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f1xx_hal_def.h"
  48
  49 /** @addtogroup STM32F1xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup CRC
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58
  59 /** @defgroup CRC_Exported_Types CRC Exported Types
  60   * @{
  61   */
  62
  63 /**
  64   * @brief  CRC HAL State Structure definition
  65   */
  66 typedef enum
  67 {
  68   HAL_CRC_STATE_RESET     = 0x00U,  /*!< CRC not yet initialized or disabled */
  69   HAL_CRC_STATE_READY     = 0x01U,  /*!< CRC initialized and ready for use   */
  70   HAL_CRC_STATE_BUSY      = 0x02U,  /*!< CRC internal process is ongoing     */
  71   HAL_CRC_STATE_TIMEOUT   = 0x03U,  /*!< CRC timeout state                   */
  72   HAL_CRC_STATE_ERROR     = 0x04U   /*!< CRC error state                     */
  73
  74 }HAL_CRC_StateTypeDef;
  75
  76 /**
  77   * @brief  CRC handle Structure definition
  78   */
  79 typedef struct
  80 {
  81   CRC_TypeDef                 *Instance;  /*!< Register base address   */
  82
  83   HAL_LockTypeDef             Lock;       /*!< CRC locking object      */
  84
  85   __IO HAL_CRC_StateTypeDef   State;      /*!< CRC communication state */
  86
  87 }CRC_HandleTypeDef;
  88
  89 /**
  90   * @}
  91   */
  92
  93 /* Exported constants --------------------------------------------------------*/
  94 /* Exported macro ------------------------------------------------------------*/
  95
  96 /** @defgroup CRC_Exported_Macros CRC Exported Macros
  97   * @{
  98   */
  99
 100 /** @brief Reset CRC handle state
 101   * @param  __HANDLE__: CRC handle
 102   * @retval None
 103   */
 104 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__)  ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
 105
 106 /**
 107   * @brief  Resets CRC Data Register.
 108   * @param  __HANDLE__: CRC handle
 109   * @retval None
 110   */
 111 #define __HAL_CRC_DR_RESET(__HANDLE__)            (SET_BIT((__HANDLE__)->Instance->CR,CRC_CR_RESET))
 112
 113 /**
 114   * @brief Stores a 8-bit data in the Independent Data(ID) register.
 115   * @param __HANDLE__: CRC handle
 116   * @param __VALUE__: 8-bit value to be stored in the ID register
 117   * @retval None
 118   */
 119 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__)))
 120
 121 /**
 122   * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
 123   * @param __HANDLE__: CRC handle
 124   * @retval 8-bit value of the ID register
 125   */
 126 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
 127
 128 /**
 129   * @}
 130   */
 131
 132 /* Exported functions --------------------------------------------------------*/
 133
 134 /** @addtogroup CRC_Exported_Functions
 135   * @{
 136   */
 137
 138 /** @addtogroup CRC_Exported_Functions_Group1
 139   * @{
 140   */
 141
 142 /* Initialization/de-initialization functions  **********************************/
 143 HAL_StatusTypeDef     HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
 144 HAL_StatusTypeDef     HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
 145 void                  HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
 146 void                  HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
 147
 148 /**
 149   * @}
 150   */
 151
 152 /** @addtogroup CRC_Exported_Functions_Group2
 153   * @{
 154   */
 155
 156 /* Peripheral Control functions  ************************************************/
 157 uint32_t              HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 158 uint32_t              HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 159
 160
 161 /**
 162   * @}
 163   */
 164
 165 /** @addtogroup CRC_Exported_Functions_Group3
 166   ** @{
 167   */
 168
 169 /* Peripheral State functions  **************************************************/
 170 HAL_CRC_StateTypeDef  HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
 171
 172 /**
 173   * @}
 174   */
 175
 176
 177 /**
 178   * @}
 179   */
 180
 181 /**
 182   * @}
 183   */
 184
 185 /**
 186   * @}
 187   */
 188
 189 #ifdef __cplusplus
 190 }
 191 #endif
 192
 193 #endif /* __STM32F1xx_HAL_CRC_H */
 194
 195 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/