1 /**
2   ******************************************************************************
3   * @file    stm32h7rsxx_ll_usart.c
4   * @author  MCD Application Team
5   * @brief   USART LL module driver.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2022 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 "stm32h7rsxx_ll_usart.h"
22 #include "stm32h7rsxx_ll_rcc.h"
23 #include "stm32h7rsxx_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 STM32H7RSxx_LL_Driver
31   * @{
32   */
33 
34 #if defined(USART1) || defined(USART2) || defined(USART3) || defined(UART4) || defined(UART5) \
35  || defined(UART7) || defined(UART8)
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 == UART7)
188   {
189     /* Force reset of UART clock */
190     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_UART7);
191 
192     /* Release reset of UART clock */
193     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_UART7);
194   }
195   else if (USARTx == UART8)
196   {
197     /* Force reset of UART clock */
198     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_UART8);
199 
200     /* Release reset of UART clock */
201     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_UART8);
202   }
203   else
204   {
205     status = ERROR;
206   }
207 
208   return (status);
209 }
210 
211 /**
212   * @brief  Initialize USART registers according to the specified
213   *         parameters in USART_InitStruct.
214   * @note   As some bits in USART configuration registers can only be written when
215   *         the USART is disabled (USART_CR1_UE bit =0), USART Peripheral should be in disabled state prior calling
216   *         this function. Otherwise, ERROR result will be returned.
217   * @note   Baud rate value stored in USART_InitStruct BaudRate field, should be valid (different from 0).
218   * @param  USARTx USART Instance
219   * @param  USART_InitStruct pointer to a LL_USART_InitTypeDef structure
220   *         that contains the configuration information for the specified USART peripheral.
221   * @retval An ErrorStatus enumeration value:
222   *          - SUCCESS: USART registers are initialized according to USART_InitStruct content
223   *          - ERROR: Problem occurred during USART Registers initialization
224   */
LL_USART_Init(USART_TypeDef * USARTx,const LL_USART_InitTypeDef * USART_InitStruct)225 ErrorStatus LL_USART_Init(USART_TypeDef *USARTx, const LL_USART_InitTypeDef *USART_InitStruct)
226 {
227   ErrorStatus status = ERROR;
228   uint32_t periphclk = LL_RCC_PERIPH_FREQUENCY_NO;
229 
230   /* Check the parameters */
231   assert_param(IS_UART_INSTANCE(USARTx));
232   assert_param(IS_LL_USART_PRESCALER(USART_InitStruct->PrescalerValue));
233   assert_param(IS_LL_USART_BAUDRATE(USART_InitStruct->BaudRate));
234   assert_param(IS_LL_USART_DATAWIDTH(USART_InitStruct->DataWidth));
235   assert_param(IS_LL_USART_STOPBITS(USART_InitStruct->StopBits));
236   assert_param(IS_LL_USART_PARITY(USART_InitStruct->Parity));
237   assert_param(IS_LL_USART_DIRECTION(USART_InitStruct->TransferDirection));
238   assert_param(IS_LL_USART_HWCONTROL(USART_InitStruct->HardwareFlowControl));
239   assert_param(IS_LL_USART_OVERSAMPLING(USART_InitStruct->OverSampling));
240 
241   /* USART needs to be in disabled state, in order to be able to configure some bits in
242      CRx registers */
243   if (LL_USART_IsEnabled(USARTx) == 0U)
244   {
245     /*---------------------------- USART CR1 Configuration ---------------------
246      * Configure USARTx CR1 (USART Word Length, Parity, Mode and Oversampling bits) with parameters:
247      * - DataWidth:          USART_CR1_M bits according to USART_InitStruct->DataWidth value
248      * - Parity:             USART_CR1_PCE, USART_CR1_PS bits according to USART_InitStruct->Parity value
249      * - TransferDirection:  USART_CR1_TE, USART_CR1_RE bits according to USART_InitStruct->TransferDirection value
250      * - Oversampling:       USART_CR1_OVER8 bit according to USART_InitStruct->OverSampling value.
251      */
252     MODIFY_REG(USARTx->CR1,
253                (USART_CR1_M | USART_CR1_PCE | USART_CR1_PS |
254                 USART_CR1_TE | USART_CR1_RE | USART_CR1_OVER8),
255                (USART_InitStruct->DataWidth | USART_InitStruct->Parity |
256                 USART_InitStruct->TransferDirection | USART_InitStruct->OverSampling));
257 
258     /*---------------------------- USART CR2 Configuration ---------------------
259      * Configure USARTx CR2 (Stop bits) with parameters:
260      * - Stop Bits:          USART_CR2_STOP bits according to USART_InitStruct->StopBits value.
261      * - CLKEN, CPOL, CPHA and LBCL bits are to be configured using LL_USART_ClockInit().
262      */
263     LL_USART_SetStopBitsLength(USARTx, USART_InitStruct->StopBits);
264 
265     /*---------------------------- USART CR3 Configuration ---------------------
266      * Configure USARTx CR3 (Hardware Flow Control) with parameters:
267      * - HardwareFlowControl: USART_CR3_RTSE, USART_CR3_CTSE bits according to
268      *   USART_InitStruct->HardwareFlowControl value.
269      */
270     LL_USART_SetHWFlowCtrl(USARTx, USART_InitStruct->HardwareFlowControl);
271 
272     /*---------------------------- USART BRR Configuration ---------------------
273      * Retrieve Clock frequency used for USART Peripheral
274      */
275     if (USARTx == USART1)
276     {
277       periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART1_CLKSOURCE);
278     }
279     else if (USARTx == USART2)
280     {
281       periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
282     }
283     else if (USARTx == USART3)
284     {
285       periphclk = LL_RCC_GetUSARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
286     }
287     else if (USARTx == UART4)
288     {
289       periphclk = LL_RCC_GetUARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
290     }
291     else if (USARTx == UART5)
292     {
293       periphclk = LL_RCC_GetUARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
294     }
295     else if (USARTx == UART7)
296     {
297       periphclk = LL_RCC_GetUARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
298     }
299     else if (USARTx == UART8)
300     {
301       periphclk = LL_RCC_GetUARTClockFreq(LL_RCC_USART234578_CLKSOURCE);
302     }
303     else
304     {
305       /* Nothing to do, as error code is already assigned to ERROR value */
306     }
307 
308     /* Configure the USART Baud Rate :
309        - prescaler value is required
310        - valid baud rate value (different from 0) is required
311        - Peripheral clock as returned by RCC service, should be valid (different from 0).
312     */
313     if ((periphclk != LL_RCC_PERIPH_FREQUENCY_NO)
314         && (USART_InitStruct->BaudRate != 0U))
315     {
316       status = SUCCESS;
317       LL_USART_SetBaudRate(USARTx,
318                            periphclk,
319                            USART_InitStruct->PrescalerValue,
320                            USART_InitStruct->OverSampling,
321                            USART_InitStruct->BaudRate);
322 
323       /* Check BRR is greater than or equal to 16d */
324       assert_param(IS_LL_USART_BRR_MIN(USARTx->BRR));
325     }
326 
327     /*---------------------------- USART PRESC Configuration -----------------------
328      * Configure USARTx PRESC (Prescaler) with parameters:
329      * - PrescalerValue: USART_PRESC_PRESCALER bits according to USART_InitStruct->PrescalerValue value.
330      */
331     LL_USART_SetPrescaler(USARTx, USART_InitStruct->PrescalerValue);
332   }
333   /* Endif (=> USART not in Disabled state => return ERROR) */
334 
335   return (status);
336 }
337 
338 /**
339   * @brief Set each @ref LL_USART_InitTypeDef field to default value.
340   * @param USART_InitStruct pointer to a @ref LL_USART_InitTypeDef structure
341   *                         whose fields will be set to default values.
342   * @retval None
343   */
344 
LL_USART_StructInit(LL_USART_InitTypeDef * USART_InitStruct)345 void LL_USART_StructInit(LL_USART_InitTypeDef *USART_InitStruct)
346 {
347   /* Set USART_InitStruct fields to default values */
348   USART_InitStruct->PrescalerValue      = LL_USART_PRESCALER_DIV1;
349   USART_InitStruct->BaudRate            = USART_DEFAULT_BAUDRATE;
350   USART_InitStruct->DataWidth           = LL_USART_DATAWIDTH_8B;
351   USART_InitStruct->StopBits            = LL_USART_STOPBITS_1;
352   USART_InitStruct->Parity              = LL_USART_PARITY_NONE ;
353   USART_InitStruct->TransferDirection   = LL_USART_DIRECTION_TX_RX;
354   USART_InitStruct->HardwareFlowControl = LL_USART_HWCONTROL_NONE;
355   USART_InitStruct->OverSampling        = LL_USART_OVERSAMPLING_16;
356 }
357 
358 /**
359   * @brief  Initialize USART Clock related settings according to the
360   *         specified parameters in the USART_ClockInitStruct.
361   * @note   As some bits in USART configuration registers can only be written when
362   *         the USART is disabled (USART_CR1_UE bit =0), USART Peripheral should be in disabled state prior calling
363   *         this function. Otherwise, ERROR result will be returned.
364   * @param  USARTx USART Instance
365   * @param  USART_ClockInitStruct pointer to a @ref LL_USART_ClockInitTypeDef structure
366   *         that contains the Clock configuration information for the specified USART peripheral.
367   * @retval An ErrorStatus enumeration value:
368   *          - SUCCESS: USART registers related to Clock settings are initialized according
369   *                     to USART_ClockInitStruct content
370   *          - ERROR: Problem occurred during USART Registers initialization
371   */
LL_USART_ClockInit(USART_TypeDef * USARTx,const LL_USART_ClockInitTypeDef * USART_ClockInitStruct)372 ErrorStatus LL_USART_ClockInit(USART_TypeDef *USARTx, const LL_USART_ClockInitTypeDef *USART_ClockInitStruct)
373 {
374   ErrorStatus status = SUCCESS;
375 
376   /* Check USART Instance and Clock signal output parameters */
377   assert_param(IS_UART_INSTANCE(USARTx));
378   assert_param(IS_LL_USART_CLOCKOUTPUT(USART_ClockInitStruct->ClockOutput));
379 
380   /* USART needs to be in disabled state, in order to be able to configure some bits in
381      CRx registers */
382   if (LL_USART_IsEnabled(USARTx) == 0U)
383   {
384     /* Ensure USART instance is USART capable */
385     assert_param(IS_USART_INSTANCE(USARTx));
386 
387     /* Check clock related parameters */
388     assert_param(IS_LL_USART_CLOCKPOLARITY(USART_ClockInitStruct->ClockPolarity));
389     assert_param(IS_LL_USART_CLOCKPHASE(USART_ClockInitStruct->ClockPhase));
390     assert_param(IS_LL_USART_LASTBITCLKOUTPUT(USART_ClockInitStruct->LastBitClockPulse));
391 
392     /*---------------------------- USART CR2 Configuration -----------------------
393      * Configure USARTx CR2 (Clock signal related bits) with parameters:
394      * - Clock Output:                USART_CR2_CLKEN bit according to USART_ClockInitStruct->ClockOutput value
395      * - Clock Polarity:              USART_CR2_CPOL bit according to USART_ClockInitStruct->ClockPolarity value
396      * - Clock Phase:                 USART_CR2_CPHA bit according to USART_ClockInitStruct->ClockPhase value
397      * - Last Bit Clock Pulse Output: USART_CR2_LBCL bit according to USART_ClockInitStruct->LastBitClockPulse value.
398      */
399     MODIFY_REG(USARTx->CR2,
400                USART_CR2_CLKEN | USART_CR2_CPHA | USART_CR2_CPOL | USART_CR2_LBCL,
401                USART_ClockInitStruct->ClockOutput | USART_ClockInitStruct->ClockPolarity |
402                USART_ClockInitStruct->ClockPhase | USART_ClockInitStruct->LastBitClockPulse);
403   }
404   /* Else (USART not in Disabled state => return ERROR */
405   else
406   {
407     status = ERROR;
408   }
409 
410   return (status);
411 }
412 
413 /**
414   * @brief Set each field of a @ref LL_USART_ClockInitTypeDef type structure to default value.
415   * @param USART_ClockInitStruct pointer to a @ref LL_USART_ClockInitTypeDef structure
416   *                              whose fields will be set to default values.
417   * @retval None
418   */
LL_USART_ClockStructInit(LL_USART_ClockInitTypeDef * USART_ClockInitStruct)419 void LL_USART_ClockStructInit(LL_USART_ClockInitTypeDef *USART_ClockInitStruct)
420 {
421   /* Set LL_USART_ClockInitStruct fields with default values */
422   USART_ClockInitStruct->ClockOutput       = LL_USART_CLOCK_DISABLE;
423   USART_ClockInitStruct->ClockPolarity     = LL_USART_POLARITY_LOW;            /* Not relevant when ClockOutput =
424                                                                                   LL_USART_CLOCK_DISABLE */
425   USART_ClockInitStruct->ClockPhase        = LL_USART_PHASE_1EDGE;             /* Not relevant when ClockOutput =
426                                                                                   LL_USART_CLOCK_DISABLE */
427   USART_ClockInitStruct->LastBitClockPulse = LL_USART_LASTCLKPULSE_NO_OUTPUT;  /* Not relevant when ClockOutput =
428                                                                                   LL_USART_CLOCK_DISABLE */
429 }
430 
431 /**
432   * @}
433   */
434 
435 /**
436   * @}
437   */
438 
439 /**
440   * @}
441   */
442 
443 #endif /* USART1 || USART2 || USART3 || UART4 || UART5 || UART7 || UART8 */
444 
445 /**
446   * @}
447   */
448 
449 #endif /* USE_FULL_LL_DRIVER */
450