Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

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

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
90:cb3d968589d8 
dgdgr

Who changed what in which revision?

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