Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_MTS_MDOT_F405RG/stm32f4xx_hal_crc.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
92:4fc01daae5a5
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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