Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F411RE/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:
86:04dd9b1680ae
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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