雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

TARGET_MTS_MDOT_F411RE/stm32f4xx_hal_crc.h@98:01a414ca7d6d, 2015-04-08 (annotated)

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
93:e188a91d3eaa 
remove SerialHalfDuplex.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 93:e188a91d3eaa 1 /**
Kojto 93:e188a91d3eaa 2 ******************************************************************************
Kojto 93:e188a91d3eaa 3 * @file stm32f4xx_hal_crc.h
Kojto 93:e188a91d3eaa 4 * @author MCD Application Team
Kojto 93:e188a91d3eaa 5 * @version V1.1.0
Kojto 93:e188a91d3eaa 6 * @date 19-June-2014
Kojto 93:e188a91d3eaa 7 * @brief Header file of CRC HAL module.
Kojto 93:e188a91d3eaa 8 ******************************************************************************
Kojto 93:e188a91d3eaa 9 * @attention
Kojto 93:e188a91d3eaa 10 *
Kojto 93:e188a91d3eaa 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
Kojto 93:e188a91d3eaa 12 *
Kojto 93:e188a91d3eaa 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 93:e188a91d3eaa 14 * are permitted provided that the following conditions are met:
Kojto 93:e188a91d3eaa 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 93:e188a91d3eaa 16 * this list of conditions and the following disclaimer.
Kojto 93:e188a91d3eaa 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 93:e188a91d3eaa 18 * this list of conditions and the following disclaimer in the documentation
Kojto 93:e188a91d3eaa 19 * and/or other materials provided with the distribution.
Kojto 93:e188a91d3eaa 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 93:e188a91d3eaa 21 * may be used to endorse or promote products derived from this software
Kojto 93:e188a91d3eaa 22 * without specific prior written permission.
Kojto 93:e188a91d3eaa 23 *
Kojto 93:e188a91d3eaa 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 93:e188a91d3eaa 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 93:e188a91d3eaa 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 93:e188a91d3eaa 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 93:e188a91d3eaa 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 93:e188a91d3eaa 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 93:e188a91d3eaa 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 93:e188a91d3eaa 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 93:e188a91d3eaa 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 93:e188a91d3eaa 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 93:e188a91d3eaa 34 *
Kojto 93:e188a91d3eaa 35 ******************************************************************************
Kojto 93:e188a91d3eaa 36 */
Kojto 93:e188a91d3eaa 37
Kojto 93:e188a91d3eaa 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 93:e188a91d3eaa 39 #ifndef __STM32F4xx_HAL_CRC_H
Kojto 93:e188a91d3eaa 40 #define __STM32F4xx_HAL_CRC_H
Kojto 93:e188a91d3eaa 41
Kojto 93:e188a91d3eaa 42 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 43 extern "C" {
Kojto 93:e188a91d3eaa 44 #endif
Kojto 93:e188a91d3eaa 45
Kojto 93:e188a91d3eaa 46 /* Includes ------------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 47 #include "stm32f4xx_hal_def.h"
Kojto 93:e188a91d3eaa 48
Kojto 93:e188a91d3eaa 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 93:e188a91d3eaa 50 * @{
Kojto 93:e188a91d3eaa 51 */
Kojto 93:e188a91d3eaa 52
Kojto 93:e188a91d3eaa 53 /** @addtogroup CRC
Kojto 93:e188a91d3eaa 54 * @{
Kojto 93:e188a91d3eaa 55 */
Kojto 93:e188a91d3eaa 56
Kojto 93:e188a91d3eaa 57 /* Exported types ------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 58
Kojto 93:e188a91d3eaa 59 /**
Kojto 93:e188a91d3eaa 60 * @brief CRC HAL State Structure definition
Kojto 93:e188a91d3eaa 61 */
Kojto 93:e188a91d3eaa 62 typedef enum
Kojto 93:e188a91d3eaa 63 {
Kojto 93:e188a91d3eaa 64 HAL_CRC_STATE_RESET = 0x00, /*!< CRC not yet initialized or disabled */
Kojto 93:e188a91d3eaa 65 HAL_CRC_STATE_READY = 0x01, /*!< CRC initialized and ready for use */
Kojto 93:e188a91d3eaa 66 HAL_CRC_STATE_BUSY = 0x02, /*!< CRC internal process is ongoing */
Kojto 93:e188a91d3eaa 67 HAL_CRC_STATE_TIMEOUT = 0x03, /*!< CRC timeout state */
Kojto 93:e188a91d3eaa 68 HAL_CRC_STATE_ERROR = 0x04 /*!< CRC error state */
Kojto 93:e188a91d3eaa 69
Kojto 93:e188a91d3eaa 70 }HAL_CRC_StateTypeDef;
Kojto 93:e188a91d3eaa 71
Kojto 93:e188a91d3eaa 72 /**
Kojto 93:e188a91d3eaa 73 * @brief CRC handle Structure definition
Kojto 93:e188a91d3eaa 74 */
Kojto 93:e188a91d3eaa 75 typedef struct
Kojto 93:e188a91d3eaa 76 {
Kojto 93:e188a91d3eaa 77 CRC_TypeDef *Instance; /*!< Register base address */
Kojto 93:e188a91d3eaa 78
Kojto 93:e188a91d3eaa 79 HAL_LockTypeDef Lock; /*!< CRC locking object */
Kojto 93:e188a91d3eaa 80
Kojto 93:e188a91d3eaa 81 __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */
Kojto 93:e188a91d3eaa 82
Kojto 93:e188a91d3eaa 83 }CRC_HandleTypeDef;
Kojto 93:e188a91d3eaa 84
Kojto 93:e188a91d3eaa 85 /* Exported constants --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 86 /* Exported macro ------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 87
Kojto 93:e188a91d3eaa 88 /** @brief Reset CRC handle state
Kojto 93:e188a91d3eaa 89 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 90 * @retval None
Kojto 93:e188a91d3eaa 91 */
Kojto 93:e188a91d3eaa 92 #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
Kojto 93:e188a91d3eaa 93
Kojto 93:e188a91d3eaa 94 /**
Kojto 93:e188a91d3eaa 95 * @brief Resets CRC Data Register.
Kojto 93:e188a91d3eaa 96 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 97 * @retval None
Kojto 93:e188a91d3eaa 98 */
Kojto 93:e188a91d3eaa 99 #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
Kojto 93:e188a91d3eaa 100
Kojto 93:e188a91d3eaa 101 /**
Kojto 93:e188a91d3eaa 102 * @brief Stores a 8-bit data in the Independent Data(ID) register.
Kojto 93:e188a91d3eaa 103 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 104 * @param __VALUE: 8-bit value to be stored in the ID register
Kojto 93:e188a91d3eaa 105 * @retval None
Kojto 93:e188a91d3eaa 106 */
Kojto 93:e188a91d3eaa 107 #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (MODIFY_REG((__HANDLE__)->Instance->IDR, CRC_IDR_IDR, (__VALUE__))
Kojto 93:e188a91d3eaa 108
Kojto 93:e188a91d3eaa 109 /**
Kojto 93:e188a91d3eaa 110 * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
Kojto 93:e188a91d3eaa 111 * @param __HANDLE__: CRC handle
Kojto 93:e188a91d3eaa 112 * @retval 8-bit value of the ID register
Kojto 93:e188a91d3eaa 113 */
Kojto 93:e188a91d3eaa 114 #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
Kojto 93:e188a91d3eaa 115
Kojto 93:e188a91d3eaa 116 /* Exported functions --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 117
Kojto 93:e188a91d3eaa 118 /* Initialization/de-initialization functions **********************************/
Kojto 93:e188a91d3eaa 119 HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 120 HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 121 void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 122 void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 123
Kojto 93:e188a91d3eaa 124 /* Peripheral Control functions ************************************************/
Kojto 93:e188a91d3eaa 125 uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
Kojto 93:e188a91d3eaa 126 uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
Kojto 93:e188a91d3eaa 127
Kojto 93:e188a91d3eaa 128 /* Peripheral State functions **************************************************/
Kojto 93:e188a91d3eaa 129 HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
Kojto 93:e188a91d3eaa 130
Kojto 93:e188a91d3eaa 131 /**
Kojto 93:e188a91d3eaa 132 * @}
Kojto 93:e188a91d3eaa 133 */
Kojto 93:e188a91d3eaa 134
Kojto 93:e188a91d3eaa 135 /**
Kojto 93:e188a91d3eaa 136 * @}
Kojto 93:e188a91d3eaa 137 */
Kojto 93:e188a91d3eaa 138
Kojto 93:e188a91d3eaa 139 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 140 }
Kojto 93:e188a91d3eaa 141 #endif
Kojto 93:e188a91d3eaa 142
Kojto 93:e188a91d3eaa 143 #endif /* __STM32F4xx_HAL_CRC_H */
Kojto 93:e188a91d3eaa 144
Kojto 93:e188a91d3eaa 145 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/