1 | /**
|
---|
2 | ******************************************************************************
|
---|
3 | * @file stm32f4xx_hal_crc.h
|
---|
4 | * @author MCD Application Team
|
---|
5 | * @version V1.4.1
|
---|
6 | * @date 09-October-2015
|
---|
7 | * @brief Header file of CRC HAL module.
|
---|
8 | ******************************************************************************
|
---|
9 | * @attention
|
---|
10 | *
|
---|
11 | * <h2><center>© COPYRIGHT(c) 2015 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 | /** @defgroup CRC CRC
|
---|
54 | * @brief CRC HAL module driver
|
---|
55 | * @{
|
---|
56 | */
|
---|
57 |
|
---|
58 | /* Exported types ------------------------------------------------------------*/
|
---|
59 | /** @defgroup CRC_Exported_Types CRC Exported Types
|
---|
60 | * @{
|
---|
61 | */
|
---|
62 |
|
---|
63 | /** @defgroup CRC_Exported_Types_Group1 CRC State Structure definition
|
---|
64 | * @{
|
---|
65 | */
|
---|
66 | typedef enum
|
---|
67 | {
|
---|
68 | HAL_CRC_STATE_RESET = 0x00, /*!< CRC not yet initialized or disabled */
|
---|
69 | HAL_CRC_STATE_READY = 0x01, /*!< CRC initialized and ready for use */
|
---|
70 | HAL_CRC_STATE_BUSY = 0x02, /*!< CRC internal process is ongoing */
|
---|
71 | HAL_CRC_STATE_TIMEOUT = 0x03, /*!< CRC timeout state */
|
---|
72 | HAL_CRC_STATE_ERROR = 0x04 /*!< CRC error state */
|
---|
73 |
|
---|
74 | }HAL_CRC_StateTypeDef;
|
---|
75 | /**
|
---|
76 | * @}
|
---|
77 | */
|
---|
78 |
|
---|
79 | /** @defgroup CRC_Exported_Types_Group2 CRC Handle Structure definition
|
---|
80 | * @{
|
---|
81 | */
|
---|
82 | typedef struct
|
---|
83 | {
|
---|
84 | CRC_TypeDef *Instance; /*!< Register base address */
|
---|
85 |
|
---|
86 | HAL_LockTypeDef Lock; /*!< CRC locking object */
|
---|
87 |
|
---|
88 | __IO HAL_CRC_StateTypeDef State; /*!< CRC communication state */
|
---|
89 |
|
---|
90 | }CRC_HandleTypeDef;
|
---|
91 | /**
|
---|
92 | * @}
|
---|
93 | */
|
---|
94 |
|
---|
95 | /**
|
---|
96 | * @}
|
---|
97 | */
|
---|
98 |
|
---|
99 | /* Exported constants --------------------------------------------------------*/
|
---|
100 | /* Exported macro ------------------------------------------------------------*/
|
---|
101 | /** @defgroup CRC_Exported_Macros CRC Exported Macros
|
---|
102 | * @{
|
---|
103 | */
|
---|
104 |
|
---|
105 | /** @brief Resets CRC handle state
|
---|
106 | * @param __HANDLE__: CRC handle
|
---|
107 | * @retval None
|
---|
108 | */
|
---|
109 | #define __HAL_CRC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_CRC_STATE_RESET)
|
---|
110 |
|
---|
111 | /**
|
---|
112 | * @brief Resets CRC Data Register.
|
---|
113 | * @param __HANDLE__: CRC handle
|
---|
114 | * @retval None
|
---|
115 | */
|
---|
116 | #define __HAL_CRC_DR_RESET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CRC_CR_RESET)
|
---|
117 |
|
---|
118 | /**
|
---|
119 | * @brief Stores a 8-bit data in the Independent Data(ID) register.
|
---|
120 | * @param __HANDLE__: CRC handle
|
---|
121 | * @param __VALUE__: 8-bit value to be stored in the ID register
|
---|
122 | * @retval None
|
---|
123 | */
|
---|
124 | #define __HAL_CRC_SET_IDR(__HANDLE__, __VALUE__) (WRITE_REG((__HANDLE__)->Instance->IDR, (__VALUE__)))
|
---|
125 |
|
---|
126 | /**
|
---|
127 | * @brief Returns the 8-bit data stored in the Independent Data(ID) register.
|
---|
128 | * @param __HANDLE__: CRC handle
|
---|
129 | * @retval 8-bit value of the ID register
|
---|
130 | */
|
---|
131 | #define __HAL_CRC_GET_IDR(__HANDLE__) (((__HANDLE__)->Instance->IDR) & CRC_IDR_IDR)
|
---|
132 | /**
|
---|
133 | * @}
|
---|
134 | */
|
---|
135 |
|
---|
136 | /* Exported functions --------------------------------------------------------*/
|
---|
137 | /** @defgroup CRC_Exported_Functions CRC Exported Functions
|
---|
138 | * @{
|
---|
139 | */
|
---|
140 |
|
---|
141 | /** @defgroup CRC_Exported_Functions_Group1 Initialization and de-initialization functions
|
---|
142 | * @{
|
---|
143 | */
|
---|
144 | HAL_StatusTypeDef HAL_CRC_Init(CRC_HandleTypeDef *hcrc);
|
---|
145 | HAL_StatusTypeDef HAL_CRC_DeInit (CRC_HandleTypeDef *hcrc);
|
---|
146 | void HAL_CRC_MspInit(CRC_HandleTypeDef *hcrc);
|
---|
147 | void HAL_CRC_MspDeInit(CRC_HandleTypeDef *hcrc);
|
---|
148 | /**
|
---|
149 | * @}
|
---|
150 | */
|
---|
151 |
|
---|
152 | /** @defgroup CRC_Exported_Functions_Group2 Peripheral Control functions
|
---|
153 | * @{
|
---|
154 | */
|
---|
155 | uint32_t HAL_CRC_Accumulate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
|
---|
156 | uint32_t HAL_CRC_Calculate(CRC_HandleTypeDef *hcrc, uint32_t pBuffer[], uint32_t BufferLength);
|
---|
157 | /**
|
---|
158 | * @}
|
---|
159 | */
|
---|
160 |
|
---|
161 | /** @defgroup CRC_Exported_Functions_Group3 Peripheral State functions
|
---|
162 | * @{
|
---|
163 | */
|
---|
164 | HAL_CRC_StateTypeDef HAL_CRC_GetState(CRC_HandleTypeDef *hcrc);
|
---|
165 | /**
|
---|
166 | * @}
|
---|
167 | */
|
---|
168 |
|
---|
169 | /**
|
---|
170 | * @}
|
---|
171 | */
|
---|
172 | /* Private types -------------------------------------------------------------*/
|
---|
173 | /** @defgroup CRC_Private_Types CRC Private Types
|
---|
174 | * @{
|
---|
175 | */
|
---|
176 |
|
---|
177 | /**
|
---|
178 | * @}
|
---|
179 | */
|
---|
180 |
|
---|
181 | /* Private defines -----------------------------------------------------------*/
|
---|
182 | /** @defgroup CRC_Private_Defines CRC Private Defines
|
---|
183 | * @{
|
---|
184 | */
|
---|
185 |
|
---|
186 | /**
|
---|
187 | * @}
|
---|
188 | */
|
---|
189 |
|
---|
190 | /* Private variables ---------------------------------------------------------*/
|
---|
191 | /** @defgroup CRC_Private_Variables CRC Private Variables
|
---|
192 | * @{
|
---|
193 | */
|
---|
194 |
|
---|
195 | /**
|
---|
196 | * @}
|
---|
197 | */
|
---|
198 |
|
---|
199 | /* Private constants ---------------------------------------------------------*/
|
---|
200 | /** @defgroup CRC_Private_Constants CRC Private Constants
|
---|
201 | * @{
|
---|
202 | */
|
---|
203 |
|
---|
204 | /**
|
---|
205 | * @}
|
---|
206 | */
|
---|
207 |
|
---|
208 | /* Private macros ------------------------------------------------------------*/
|
---|
209 | /** @defgroup CRC_Private_Macros CRC Private Macros
|
---|
210 | * @{
|
---|
211 | */
|
---|
212 |
|
---|
213 | /**
|
---|
214 | * @}
|
---|
215 | */
|
---|
216 |
|
---|
217 | /* Private functions prototypes ----------------------------------------------*/
|
---|
218 | /** @defgroup CRC_Private_Functions_Prototypes CRC Private Functions Prototypes
|
---|
219 | * @{
|
---|
220 | */
|
---|
221 |
|
---|
222 | /**
|
---|
223 | * @}
|
---|
224 | */
|
---|
225 |
|
---|
226 | /* Private functions ---------------------------------------------------------*/
|
---|
227 | /** @defgroup CRC_Private_Functions CRC Private Functions
|
---|
228 | * @{
|
---|
229 | */
|
---|
230 |
|
---|
231 | /**
|
---|
232 | * @}
|
---|
233 | */
|
---|
234 |
|
---|
235 | /**
|
---|
236 | * @}
|
---|
237 | */
|
---|
238 |
|
---|
239 | /**
|
---|
240 | * @}
|
---|
241 | */
|
---|
242 |
|
---|
243 | #ifdef __cplusplus
|
---|
244 | }
|
---|
245 | #endif
|
---|
246 |
|
---|
247 | #endif /* __STM32F4xx_HAL_CRC_H */
|
---|
248 |
|
---|
249 | /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
---|