1 /**
2 ******************************************************************************
3 * @file stm32h7xx_ll_usart.c
4 * @author MCD Application Team
5 * @brief USART LL module driver.
6 ******************************************************************************
7 * @attention
8 *
9 * Copyright (c) 2017 STMicroelectronics.
10 * All rights reserved.
11 *
12 * This software is licensed under terms that can be found in the LICENSE file
13 * in the root directory of this software component.
14 * If no LICENSE file comes with this software, it is provided AS-IS.
15 *
16 ******************************************************************************
17 */
18 #if defined(USE_FULL_LL_DRIVER)
19
20 /* Includes ------------------------------------------------------------------*/
21 #include "stm32h7xx_ll_usart.h"
22 #include "stm32h7xx_ll_rcc.h"
23 #include "stm32h7xx_ll_bus.h"
24 #ifdef USE_FULL_ASSERT
25 #include "stm32_assert.h"
26 #else
27 #define assert_param(expr) ((void)0U)
28 #endif /* USE_FULL_ASSERT */
29
30 /** @addtogroup STM32H7xx_LL_Driver
31 * @{
32 */
33
34 #if defined(USART1) || defined(USART2) || defined(USART3) || defined(USART6) \
35 || defined(UART4) || defined(UART5) || defined(UART7) || defined(UART8) || defined(UART9) || defined(USART10)
36
37 /** @addtogroup USART_LL
38 * @{
39 */
40
41 /* Private types -------------------------------------------------------------*/
42 /* Private variables ---------------------------------------------------------*/
43 /* Private constants ---------------------------------------------------------*/
44 /** @addtogroup USART_LL_Private_Constants
45 * @{
46 */
47
48 /* Definition of default baudrate value used for USART initialisation */
49 #define USART_DEFAULT_BAUDRATE (9600U)
50
51 /**
52 * @}
53 */
54
55 /* Private macros ------------------------------------------------------------*/
56 /** @addtogroup USART_LL_Private_Macros
57 * @{
58 */
59
60 #define IS_LL_USART_PRESCALER(__VALUE__) (((__VALUE__) == LL_USART_PRESCALER_DIV1) \
61 || ((__VALUE__) == LL_USART_PRESCALER_DIV2) \
62 || ((__VALUE__) == LL_USART_PRESCALER_DIV4) \
63 || ((__VALUE__) == LL_USART_PRESCALER_DIV6) \
64 || ((__VALUE__) == LL_USART_PRESCALER_DIV8) \
65 || ((__VALUE__) == LL_USART_PRESCALER_DIV10) \
66 || ((__VALUE__) == LL_USART_PRESCALER_DIV12) \
67 || ((__VALUE__) == LL_USART_PRESCALER_DIV16) \
68 || ((__VALUE__) == LL_USART_PRESCALER_DIV32) \
69 || ((__VALUE__) == LL_USART_PRESCALER_DIV64) \
70 || ((__VALUE__) == LL_USART_PRESCALER_DIV128) \
71 || ((__VALUE__) == LL_USART_PRESCALER_DIV256))
72
73 /* __BAUDRATE__ The maximum Baud Rate is derived from the maximum clock available
74 * divided by the smallest oversampling used on the USART (i.e. 8) */
75 #define IS_LL_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) <= 12500000U)
76
77 /* __VALUE__ In case of oversampling by 16 and 8, BRR content must be greater than or equal to 16d. */
78 #define IS_LL_USART_BRR_MIN(__VALUE__) ((__VALUE__) >= 16U)
79
80 #define IS_LL_USART_DIRECTION(__VALUE__) (((__VALUE__) == LL_USART_DIRECTION_NONE) \
81 || ((__VALUE__) == LL_USART_DIRECTION_RX) \
82 || ((__VALUE__) == LL_USART_DIRECTION_TX) \
83 || ((__VALUE__) == LL_USART_DIRECTION_TX_RX))
84
85 #define IS_LL_USART_PARITY(__VALUE__) (((__VALUE__) == LL_USART_PARITY_NONE) \
86 || ((__VALUE__) == LL_USART_PARITY_EVEN) \
87 || ((__VALUE__) == LL_USART_PARITY_ODD))
88
89 #define IS_LL_USART_DATAWIDTH(__VALUE__) (((__VALUE__) == LL_USART_DATAWIDTH_7B) \
90 || ((__VALUE__) == LL_USART_DATAWIDTH_8B) \
91 || ((__VALUE__) == LL_USART_DATAWIDTH_9B))
92
93 #define IS_LL_USART_OVERSAMPLING(__VALUE__) (((__VALUE__) == LL_USART_OVERSAMPLING_16) \
94 || ((__VALUE__) == LL_USART_OVERSAMPLING_8))
95
96 #define IS_LL_USART_LASTBITCLKOUTPUT(__VALUE__) (((__VALUE__) == LL_USART_LASTCLKPULSE_NO_OUTPUT) \
97 || ((__VALUE__) == LL_USART_LASTCLKPULSE_OUTPUT))
98
99 #define IS_LL_USART_CLOCKPHASE(__VALUE__) (((__VALUE__) == LL_USART_PHASE_1EDGE) \
100 || ((__VALUE__) == LL_USART_PHASE_2EDGE))
101
102 #define IS_LL_USART_CLOCKPOLARITY(__VALUE__) (((__VALUE__) == LL_USART_POLARITY_LOW) \
103 || ((__VALUE__) == LL_USART_POLARITY_HIGH))
104
105 #define IS_LL_USART_CLOCKOUTPUT(__VALUE__) (((__VALUE__) == LL_USART_CLOCK_DISABLE) \
106 || ((__VALUE__) == LL_USART_CLOCK_ENABLE))
107
108 #define IS_LL_USART_STOPBITS(__VALUE__) (((__VALUE__) == LL_USART_STOPBITS_0_5) \
109 || ((__VALUE__) == LL_USART_STOPBITS_1) \
110 || ((__VALUE__) == LL_USART_STOPBITS_1_5) \
111 || ((__VALUE__) == LL_USART_STOPBITS_2))
112
113 #define IS_LL_USART_HWCONTROL(__VALUE__) (((__VALUE__) == LL_USART_HWCONTROL_NONE) \
114 || ((__VALUE__) == LL_USART_HWCONTROL_RTS) \
115 || ((__VALUE__) == LL_USART_HWCONTROL_CTS) \
116 || ((__VALUE__) == LL_USART_HWCONTROL_RTS_CTS))
117
118 /**
119 * @}
120 */
121
122 /* Private function prototypes -----------------------------------------------*/
123
124 /* Exported functions --------------------------------------------------------*/
125 /** @addtogroup USART_LL_Exported_Functions
126 * @{
127 */
128
129 /** @addtogroup USART_LL_EF_Init
130 * @{
131 */
132
133 /**
134 * @brief De-initialize USART registers (Registers restored to their default values).
135 * @param USARTx USART Instance
136 * @retval An ErrorStatus enumeration value:
137 * - SUCCESS: USART registers are de-initialized
138 * - ERROR: USART registers are not de-initialized
139 */
LL_USART_DeInit(const USART_TypeDef * USARTx)140 ErrorStatus LL_USART_DeInit(const USART_TypeDef *USARTx)
141 {
142 ErrorStatus status = SUCCESS;
143
144 /* Check the parameters */
145 assert_param(IS_UART_INSTANCE(USARTx));
146
147 if (USARTx == USART1)
148 {
149 /* Force reset of USART clock */
150 LL_APB2_GRP1_ForceReset(LL_APB2_GRP1_PERIPH_USART1);
151
152 /* Release reset of USART clock */
153 LL_APB2_GRP1_ReleaseReset(LL_APB2_GRP1_PERIPH_USART1);
154 }
155 else if (USARTx == USART2)
156 {
157 /* Force reset of USART clock */
158 LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_USART2);
159
160 /* Release reset of USART clock */
161 LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_USART2);
162 }
163 else if (USARTx == USART3)
164 {
165 /* Force reset of USART clock */
166 LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_USART3);
167
168 /* Release reset of USART clock */
169 LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_USART3);
170 }
171 else if (USARTx == UART4)
172 {
173 /* Force reset of UART clock */
174 LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_UART4);
175
176 /* Release reset of UART clock */
177 LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_UART4);
178 }
179 else if (USARTx == UART5)
180 {
181 /* Force reset of UART clock */
182 LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_UART5);
183
184 /* Release reset of UART clock */
185 LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_UART5);
186 }
187 else if (USARTx == USART6)
188 {
189 /* Force reset of USART clock */
190 LL_APB2_GRP1_ForceReset(LL_APB2_GRP1_PERIPH_USART6);
191
192 /* Release reset of USART clock */
193 LL_APB2_GRP1_ReleaseReset(LL_APB2_GRP1_PERIPH_USART6);
194 }
195 else if (USARTx == UART7)
196 {
197 /* Force reset of UART clock */
198 LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_UART7);
199
200 /* Release reset of UART clock */
201 LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_UART7);
202 }
203 else if (USARTx == UART8)
204 {
205 /* Force reset of UART clock */
206 LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_UART8);
207
208 /* Release reset of UART clock */
209 LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_UART8);
210 }
211 #if defined(UART9)
212 else if (USARTx == UART9)
213 {
214 /* Force reset of UART clock */
215 LL_APB2_GRP1_ForceReset(LL_APB2_GRP1_PERIPH_UART9);
216
217 /* Release reset of UART clock */
218 LL_APB2_GRP1_ReleaseReset(LL_APB2_GRP1_PERIPH_UART9);
219 }
220 #endif /* UART9 */
221 #if defined(USART10)
222 else if (USARTx == USART10)
223 {
224 /* Force reset of USART clock */
225 LL_APB2_GRP1_ForceReset(LL_APB2_GRP1_PERIPH_USART10);
226
227 /* Release reset of USART clock */
228 LL_APB2_GRP1_ReleaseReset(LL_APB2_GRP1_PERIPH_USART10);
229 }
230 #endif /* USART10 */
231 else
232 {
233 status = ERROR;
234 }
235
236 return (status);
237 }
238
239 /**
240 * @brief Initialize USART registers according to the specified
241 * parameters in USART_InitStruct.
242 * @note As some bits in USART configuration registers can only be written when
243 * the USART is disabled (USART_CR1_UE bit =0), USART Peripheral should be in disabled state prior calling
244 * this function. Otherwise, ERROR result will be returned.
245 * @note Baud rate value stored in USART_InitStruct BaudRate field, should be valid (different from 0).
246 * @param USARTx USART Instance
247 * @param USART_InitStruct pointer to a LL_USART_InitTypeDef structure
248 * that contains the configuration information for the specified USART peripheral.
249 * @retval An ErrorStatus enumeration value:
250 * - SUCCESS: USART registers are initialized according to USART_InitStruct content
251 * - ERROR: Problem occurred during USART Registers initialization
252 */
LL_USART_Init(USART_TypeDef * USARTx,const LL_USART_InitTypeDef * USART_InitStruct)253 ErrorStatus LL_USART_Init(USART_TypeDef *USARTx, const LL_USART_InitTypeDef *USART_InitStruct)
254 {
255 ErrorStatus status = ERROR;
256 uint32_t periphclk = LL_RCC_PERIPH_FREQUENCY_NO;
257
258 /* Check the parameters */
259 assert_param(IS_UART_INSTANCE(USARTx));
260 assert_param(IS_LL_USART_PRESCALER(USART_InitStruct->PrescalerValue));
261 assert_param(IS_LL_USART_BAUDRATE(USART_InitStruct->BaudRate));
262 assert_param(IS_LL_USART_DATAWIDTH(USART_InitStruct->DataWidth));
263 assert_param(IS_LL_USART_STOPBITS(USART_InitStruct->StopBits));
264 assert_param(IS_LL_USART_PARITY(USART_InitStruct->Parity));
265 assert_param(IS_LL_USART_DIRECTION(USART_InitStruct->TransferDirection));
266 assert_param(IS_LL_USART_HWCONTROL(USART_InitStruct->HardwareFlowControl));
267 assert_param(IS_LL_USART_OVERSAMPLING(USART_InitStruct->OverSampling));
268
269 /* USART needs to be in disabled state, in order to be able to configure some bits in
270 CRx registers */
271 if (LL_USART_IsEnabled(USARTx) == 0U)
272 {
273 /*---------------------------- USART CR1 Configuration ---------------------
274 * Configure USARTx CR1 (USART Word Length, Parity, Mode and Oversampling bits) with parameters:
275 * - DataWidth: USART_CR1_M bits according to USART_InitStruct->DataWidth value
276 * - Parity: USART_CR1_PCE, USART_CR1_PS bits according to USART_InitStruct->Parity value
277 * - TransferDirection: USART_CR1_TE, USART_CR1_RE bits according to USART_InitStruct->TransferDirection value
278 * - Oversampling: USART_CR1_OVER8 bit according to USART_InitStruct->OverSampling value.
279 */
280 MODIFY_REG(USARTx->CR1,
281 (USART_CR1_M | USART_CR1_PCE | USART_CR1_PS |
282 USART_CR1_TE | USART_CR1_RE | USART_CR1_OVER8),
283 (USART_InitStruct->DataWidth | USART_InitStruct->Parity |
284 USART_InitStruct->TransferDirection | USART_InitStruct->OverSampling));
285
286 /*---------------------------- USART CR2 Configuration ---------------------
287 * Configure USARTx CR2 (Stop bits) with parameters:
288 * - Stop Bits: USART_CR2_STOP bits according to USART_InitStruct->StopBits value.
289 * - CLKEN, CPOL, CPHA and LBCL bits are to be configured using LL_USART_ClockInit().
290 */
291 LL_USART_SetStopBitsLength(USARTx, USART_InitStruct->StopBits);
292
293 /*---------------------------- USART CR3 Configuration ---------------------
294 * Configure USARTx CR3 (Hardware Flow Control) with parameters:
295 * - HardwareFlowControl: USART_CR3_RTSE, USART_CR3_CTSE bits according to
296 * USART_InitStruct->HardwareFlowControl value.
297 */
298 LL_USART_SetHWFlowCtrl(USARTx, USART_InitStruct->HardwareFlowControl);
299
300 /*---------------------------- USART BRR Configuration ---------------------
301 * Retrieve Clock frequency used for USART Peripheral
302 */
303 if (USARTx == USART1)
304 {
305 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART16_CLKSOURCE);
306 }
307 else if (USARTx == USART2)
308 {
309 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
310 }
311 else if (USARTx == USART3)
312 {
313 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
314 }
315 else if (USARTx == UART4)
316 {
317 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
318 }
319 else if (USARTx == UART5)
320 {
321 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
322 }
323 else if (USARTx == USART6)
324 {
325 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART16_CLKSOURCE);
326 }
327 else if (USARTx == UART7)
328 {
329 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
330 }
331 else if (USARTx == UART8)
332 {
333 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
334 }
335 #if defined(UART9)
336 else if (USARTx == UART9)
337 {
338 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART16_CLKSOURCE);
339 }
340 #endif /* UART9 */
341 #if defined(USART10)
342 else if (USARTx == USART10)
343 {
344 periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART16_CLKSOURCE);
345 }
346 #endif /* USART10 */
347 else
348 {
349 /* Nothing to do, as error code is already assigned to ERROR value */
350 }
351
352 /* Configure the USART Baud Rate :
353 - prescaler value is required
354 - valid baud rate value (different from 0) is required
355 - Peripheral clock as returned by RCC service, should be valid (different from 0).
356 */
357 if ((periphclk != LL_RCC_PERIPH_FREQUENCY_NO)
358 && (USART_InitStruct->BaudRate != 0U))
359 {
360 status = SUCCESS;
361 LL_USART_SetBaudRate(USARTx,
362 periphclk,
363 USART_InitStruct->PrescalerValue,
364 USART_InitStruct->OverSampling,
365 USART_InitStruct->BaudRate);
366
367 /* Check BRR is greater than or equal to 16d */
368 assert_param(IS_LL_USART_BRR_MIN(USARTx->BRR));
369 }
370
371 /*---------------------------- USART PRESC Configuration -----------------------
372 * Configure USARTx PRESC (Prescaler) with parameters:
373 * - PrescalerValue: USART_PRESC_PRESCALER bits according to USART_InitStruct->PrescalerValue value.
374 */
375 LL_USART_SetPrescaler(USARTx, USART_InitStruct->PrescalerValue);
376 }
377 /* Endif (=> USART not in Disabled state => return ERROR) */
378
379 return (status);
380 }
381
382 /**
383 * @brief Set each @ref LL_USART_InitTypeDef field to default value.
384 * @param USART_InitStruct pointer to a @ref LL_USART_InitTypeDef structure
385 * whose fields will be set to default values.
386 * @retval None
387 */
388
LL_USART_StructInit(LL_USART_InitTypeDef * USART_InitStruct)389 void LL_USART_StructInit(LL_USART_InitTypeDef *USART_InitStruct)
390 {
391 /* Set USART_InitStruct fields to default values */
392 USART_InitStruct->PrescalerValue = LL_USART_PRESCALER_DIV1;
393 USART_InitStruct->BaudRate = USART_DEFAULT_BAUDRATE;
394 USART_InitStruct->DataWidth = LL_USART_DATAWIDTH_8B;
395 USART_InitStruct->StopBits = LL_USART_STOPBITS_1;
396 USART_InitStruct->Parity = LL_USART_PARITY_NONE ;
397 USART_InitStruct->TransferDirection = LL_USART_DIRECTION_TX_RX;
398 USART_InitStruct->HardwareFlowControl = LL_USART_HWCONTROL_NONE;
399 USART_InitStruct->OverSampling = LL_USART_OVERSAMPLING_16;
400 }
401
402 /**
403 * @brief Initialize USART Clock related settings according to the
404 * specified parameters in the USART_ClockInitStruct.
405 * @note As some bits in USART configuration registers can only be written when
406 * the USART is disabled (USART_CR1_UE bit =0), USART Peripheral should be in disabled state prior calling
407 * this function. Otherwise, ERROR result will be returned.
408 * @param USARTx USART Instance
409 * @param USART_ClockInitStruct pointer to a @ref LL_USART_ClockInitTypeDef structure
410 * that contains the Clock configuration information for the specified USART peripheral.
411 * @retval An ErrorStatus enumeration value:
412 * - SUCCESS: USART registers related to Clock settings are initialized according
413 * to USART_ClockInitStruct content
414 * - ERROR: Problem occurred during USART Registers initialization
415 */
LL_USART_ClockInit(USART_TypeDef * USARTx,const LL_USART_ClockInitTypeDef * USART_ClockInitStruct)416 ErrorStatus LL_USART_ClockInit(USART_TypeDef *USARTx, const LL_USART_ClockInitTypeDef *USART_ClockInitStruct)
417 {
418 ErrorStatus status = SUCCESS;
419
420 /* Check USART Instance and Clock signal output parameters */
421 assert_param(IS_UART_INSTANCE(USARTx));
422 assert_param(IS_LL_USART_CLOCKOUTPUT(USART_ClockInitStruct->ClockOutput));
423
424 /* USART needs to be in disabled state, in order to be able to configure some bits in
425 CRx registers */
426 if (LL_USART_IsEnabled(USARTx) == 0U)
427 {
428 /* Ensure USART instance is USART capable */
429 assert_param(IS_USART_INSTANCE(USARTx));
430
431 /* Check clock related parameters */
432 assert_param(IS_LL_USART_CLOCKPOLARITY(USART_ClockInitStruct->ClockPolarity));
433 assert_param(IS_LL_USART_CLOCKPHASE(USART_ClockInitStruct->ClockPhase));
434 assert_param(IS_LL_USART_LASTBITCLKOUTPUT(USART_ClockInitStruct->LastBitClockPulse));
435
436 /*---------------------------- USART CR2 Configuration -----------------------
437 * Configure USARTx CR2 (Clock signal related bits) with parameters:
438 * - Clock Output: USART_CR2_CLKEN bit according to USART_ClockInitStruct->ClockOutput value
439 * - Clock Polarity: USART_CR2_CPOL bit according to USART_ClockInitStruct->ClockPolarity value
440 * - Clock Phase: USART_CR2_CPHA bit according to USART_ClockInitStruct->ClockPhase value
441 * - Last Bit Clock Pulse Output: USART_CR2_LBCL bit according to USART_ClockInitStruct->LastBitClockPulse value.
442 */
443 MODIFY_REG(USARTx->CR2,
444 USART_CR2_CLKEN | USART_CR2_CPHA | USART_CR2_CPOL | USART_CR2_LBCL,
445 USART_ClockInitStruct->ClockOutput | USART_ClockInitStruct->ClockPolarity |
446 USART_ClockInitStruct->ClockPhase | USART_ClockInitStruct->LastBitClockPulse);
447 }
448 /* Else (USART not in Disabled state => return ERROR */
449 else
450 {
451 status = ERROR;
452 }
453
454 return (status);
455 }
456
457 /**
458 * @brief Set each field of a @ref LL_USART_ClockInitTypeDef type structure to default value.
459 * @param USART_ClockInitStruct pointer to a @ref LL_USART_ClockInitTypeDef structure
460 * whose fields will be set to default values.
461 * @retval None
462 */
LL_USART_ClockStructInit(LL_USART_ClockInitTypeDef * USART_ClockInitStruct)463 void LL_USART_ClockStructInit(LL_USART_ClockInitTypeDef *USART_ClockInitStruct)
464 {
465 /* Set LL_USART_ClockInitStruct fields with default values */
466 USART_ClockInitStruct->ClockOutput = LL_USART_CLOCK_DISABLE;
467 USART_ClockInitStruct->ClockPolarity = LL_USART_POLARITY_LOW; /* Not relevant when ClockOutput =
468 LL_USART_CLOCK_DISABLE */
469 USART_ClockInitStruct->ClockPhase = LL_USART_PHASE_1EDGE; /* Not relevant when ClockOutput =
470 LL_USART_CLOCK_DISABLE */
471 USART_ClockInitStruct->LastBitClockPulse = LL_USART_LASTCLKPULSE_NO_OUTPUT; /* Not relevant when ClockOutput =
472 LL_USART_CLOCK_DISABLE */
473 }
474
475 /**
476 * @}
477 */
478
479 /**
480 * @}
481 */
482
483 /**
484 * @}
485 */
486
487 #endif /* USART1 || USART2 || USART3 || USART6 || UART4 || UART5 || UART7 || UART8 || UART9 || USART10 */
488
489 /**
490 * @}
491 */
492
493 #endif /* USE_FULL_LL_DRIVER */
494
495
496
