tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_crc.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_crc.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    19-June-2014
   7   * @brief   Header file of CRC HAL 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 __STM32F4xx_HAL_CRC_H
  40 #define __STM32F4xx_HAL_CRC_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f4xx_hal_def.h"
  48
  49 /** @addtogroup STM32F4xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup CRC
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58
  59 /**
  60   * @brief  CRC HAL State Structure definition
  61   */
  62 typedef enum
  63 {
  64   HAL_CRC_STATE_RESET     = 0x00,  /*!< CRC not yet initialized or disabled */
  65   HAL_CRC_STATE_READY     = 0x01,  /*!< CRC initialized and ready for use   */
  66   HAL_CRC_STATE_BUSY      = 0x02,  /*!< CRC internal process is ongoing     */
  67   HAL_CRC_STATE_TIMEOUT   = 0x03,  /*!< CRC timeout state                   */
  68   HAL_CRC_STATE_ERROR     = 0x04   /*!< CRC error state                     */
  69
  70 }HAL_CRC_StateTypeDef;
  71
  72 /**
  73   * @brief  CRC handle Structure definition
  74   */
  75 typedef struct
  76 {
  77   CRC_TypeDef                 *Instance;  /*!< Register base address   */
  78
  79   HAL_LockTypeDef             Lock;       /*!< CRC locking object      */
  80
  81   __IO HAL_CRC_StateTypeDef   State;      /*!< CRC communication state */
  82
  83 }CRC_HandleTypeDef;
  84
  85 /* Exported constants --------------------------------------------------------*/
  86 /* Exported macro ------------------------------------------------------------*/
  87
  88 /** @brief Reset CRC handle state
  89   * @param  __HANDLE__: CRC handle
  90   * @retval None
  91   */
  92 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
  93
  94 /**
  95   * @brief  Resets CRC Data Register.
  96   * @param  __HANDLE__: CRC handle
  97   * @retval None
  98   */
  99 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
 100
 101 /**
 102   * @brief Stores a 8-bit data in the Independent Data(ID) register.
 103   * @param __HANDLE__: CRC handle
 104   * @param __VALUE: 8-bit value to be stored in the ID register
 105   * @retval None
 106   */
 107 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (MODIFY_REG((__HANDLE__)->Instance->IDR, CRC_IDR_IDR, (__VALUE__))
 108
 109 /**
 110   * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
 111   * @param __HANDLE__: CRC handle
 112   * @retval 8-bit value of the ID register
 113   */
 114 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
 115
 116 /* Exported functions --------------------------------------------------------*/
 117
 118 /* Initialization/de-initialization functions  **********************************/
 119 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
 120 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
 121 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
 122 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
 123
 124 /* Peripheral Control functions  ************************************************/
 125 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 126 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
 127
 128 /* Peripheral State functions  **************************************************/
 129 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
 130
 131 /**
 132   * @}
 133   */
 134
 135 /**
 136   * @}
 137   */
 138
 139 #ifdef __cplusplus
 140 }
 141 #endif
 142
 143 #endif /* __STM32F4xx_HAL_CRC_H */
 144
 145 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/