UART_HyperTerminal_IT
Select one of the symbols to view example projects that use it.
 
Outline
Includes
#include "main.h"
Private variables
UartHandle
ubTxComplete
ubRxComplete
aTxStartMessage
uwTxIndex
ubSizeToSend
aTxEndMessage
aRxBuffer
uwRxIndex
Private function prototypes
main()
SystemClock_Config()
Error_Handler()
UART_CharReception_Callback()
UART_TXEmpty_Callback()
UART_CharTransmitComplete_Callback()
UART_Error_Callback()
Files
loading (3/4)...
SourceVuSTM32 Libraries and SamplesUART_HyperTerminal_ITSrc/main.c
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/** ****************************************************************************** * @file UART/UART_HyperTerminal_IT/Src/main.c * @author MCD Application Team * @brief This sample code shows how to use UART HAL and LL APIs to transmit * and receive a data buffer with a communication process based on IT; * The communication is done with the Hyperterminal PC application; * HAL driver is used to perform UART configuration, * then TX/RX transfers procedures are based on LL APIs use ****************************************************************************** * @attention * * Copyright (c) 2017 STMicroelectronics. * All rights reserved. * * This software is licensed under terms that can be found in the LICENSE file * in the root directory of this software component. * If no LICENSE file comes with this software, it is provided AS-IS. * ****************************************************************************** *//* ... */ /* Includes ------------------------------------------------------------------*/ #include "main.h" /** @addtogroup STM32F4xx_HAL_LL_MIX_Examples * @{ *//* ... */ /** @addtogroup UART_Hyperterminal_IT * @{ *//* ... */ Includes /* Private typedef -----------------------------------------------------------*/ /* Private define ------------------------------------------------------------*/ /* Private macro -------------------------------------------------------------*/ /* Private variables ---------------------------------------------------------*/ /* UART handler declaration */ UART_HandleTypeDef UartHandle; __IO uint8_t ubTxComplete = 0; __IO uint8_t ubRxComplete = 0; /* Buffer used for transmission */ uint8_t aTxStartMessage[] = "\n\r ****UART-Hyperterminal communication based on IT (Mixed HAL/LL usage) ****\n\r Enter 10 characters using keyboard :\n\r"; __IO uint32_t uwTxIndex = 0; uint8_t ubSizeToSend = sizeof(aTxStartMessage); uint8_t aTxEndMessage[] = "\n\r Example Finished\n\r"; /* Buffer used for reception */ uint8_t aRxBuffer[RXBUFFERSIZE]; __IO uint32_t uwRxIndex = 0; Private variables /* Private function prototypes -----------------------------------------------*/ static void SystemClock_Config(void); static void Error_Handler(void); Private function prototypes /* Private functions ---------------------------------------------------------*/ /** * @brief Main program * @retval None *//* ... */ int main(void) { /* STM32F4xx HAL library initialization: - Configure the Flash prefetch - Systick timer is configured by default as source of time base, but user can eventually implement his proper time base source (a general purpose timer for example or other time source), keeping in mind that Time base duration should be kept 1ms since PPP_TIMEOUT_VALUEs are defined and handled in milliseconds basis. - Set NVIC Group Priority to 4 - Low Level Initialization *//* ... */ HAL_Init(); /* Configure the system clock to 100 MHz */ SystemClock_Config(); /* Configure leds */ BSP_LED_Init(LED2); /*##-1- Configure the UART peripheral using HAL services ###################*/ /* Put the USART peripheral in the Asynchronous mode (UART Mode) */ /* UART configured as follows: - Word Length = 8 Bits (7 data bit + 1 parity bit) : BE CAREFUL : Program 7 data bits + 1 parity bit in PC HyperTerminal - Stop Bit = One Stop bit - Parity = ODD parity - BaudRate = 9600 baud - Hardware flow control disabled (RTS and CTS signals) *//* ... */ UartHandle.Instance = USARTx; UartHandle.Init.BaudRate = 9600; UartHandle.Init.WordLength = UART_WORDLENGTH_8B; UartHandle.Init.StopBits = UART_STOPBITS_1; UartHandle.Init.Parity = UART_PARITY_ODD; UartHandle.Init.HwFlowCtl = UART_HWCONTROL_NONE; UartHandle.Init.Mode = UART_MODE_TX_RX; UartHandle.Init.OverSampling = UART_OVERSAMPLING_16; if(HAL_UART_Init(&UartHandle) != HAL_OK) { /* Initialization Error */ Error_Handler(); }if (HAL_UART_Init(&UartHandle) != HAL_OK) { ... } /*##-2- Configure UART peripheral for reception process (using LL) ##########*/ /* Any data received will be stored "aRxBuffer" buffer : the number max of data received is RXBUFFERSIZE *//* ... */ /* Enable RXNE and Error interrupts */ LL_USART_EnableIT_RXNE(USARTx); LL_USART_EnableIT_ERROR(USARTx); /*##-3- Start the transmission process (using LL) *##########################*/ /* While the UART in reception process, user can transmit data from "aTxStartMessage" buffer *//* ... */ /* Start USART transmission : Will initiate TXE interrupt after DR register is empty */ LL_USART_TransmitData8(USARTx, aTxStartMessage[uwTxIndex++]); /* Enable TXE interrupt */ LL_USART_EnableIT_TXE(USARTx); /*##-4- Wait for the end of the transfer ###################################*/ /* USART IRQ handler is not anymore routed to HAL_UART_IRQHandler() function and is now based on LL API functions use. Therefore, use of HAL IT based services is no more possible. *//* ... */ /* Once TX transfer is completed, LED2 will toggle. Then, when RX transfer is completed, LED2 will turn On. *//* ... */ while (ubTxComplete == 0) { }while (ubTxComplete == 0) { ... } while (ubRxComplete == 0) { BSP_LED_Toggle(LED2); HAL_Delay(250); }while (ubRxComplete == 0) { ... } BSP_LED_On(LED2); /* stop blink and keeps ON */ /*##-5- Send the received Buffer ###########################################*/ /* Even if use of HAL IT based services is no more possible, use of HAL Polling based services (as Transmit in polling mode) is still possible. *//* ... */ if(HAL_UART_Transmit(&UartHandle, (uint8_t*)aRxBuffer, RXBUFFERSIZE, 1000)!= HAL_OK) { /* Transfer error in transmission process */ Error_Handler(); }if (HAL_UART_Transmit(&UartHandle, (uint8_t*)aRxBuffer, RXBUFFERSIZE, 1000)!= HAL_OK) { ... } /*##-6- Send the End Message ###############################################*/ if(HAL_UART_Transmit(&UartHandle, (uint8_t*)aTxEndMessage, TXENDMESSAGESIZE, 1000)!= HAL_OK) { /* Transfer error in transmission process */ Error_Handler(); }if (HAL_UART_Transmit(&UartHandle, (uint8_t*)aTxEndMessage, TXENDMESSAGESIZE, 1000)!= HAL_OK) { ... } /* Infinite loop */ while (1) { }while (1) { ... } }{ ... } /** * @brief System Clock Configuration * The system Clock is configured as follow : * System Clock source = PLL (HSE) * SYSCLK(Hz) = 100000000 * HCLK(Hz) = 100000000 * AHB Prescaler = 1 * APB1 Prescaler = 2 * APB2 Prescaler = 1 * HSI Frequency(Hz) = 8000000 * PLL_M = 8 * PLL_N = 400 * PLL_P = 4 * PLL_Q = 7 * VDD(V) = 3.3 * Main regulator output voltage = Scale1 mode * Flash Latency(WS) = 3 * @param None * @retval None *//* ... */ static void SystemClock_Config(void) { RCC_ClkInitTypeDef RCC_ClkInitStruct; RCC_OscInitTypeDef RCC_OscInitStruct; /* Enable Power Control clock */ __HAL_RCC_PWR_CLK_ENABLE(); /* The voltage scaling allows optimizing the power consumption when the device is clocked below the maximum system frequency, to update the voltage scaling value regarding system frequency refer to product datasheet. *//* ... */ __HAL_PWR_VOLTAGESCALING_CONFIG(PWR_REGULATOR_VOLTAGE_SCALE1); /* Enable HSI Oscillator and activate PLL with HSI as source */ RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE; RCC_OscInitStruct.HSEState = RCC_HSE_ON; RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON; RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE; RCC_OscInitStruct.PLL.PLLM = 8; RCC_OscInitStruct.PLL.PLLN = 400; RCC_OscInitStruct.PLL.PLLP = RCC_PLLP_DIV4; RCC_OscInitStruct.PLL.PLLQ = 7; if(HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) { Error_Handler(); }if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK) { ... } /* Select PLL as system clock source and configure the HCLK, PCLK1 and PCLK2 clocks dividers *//* ... */ RCC_ClkInitStruct.ClockType = (RCC_CLOCKTYPE_SYSCLK | RCC_CLOCKTYPE_HCLK | RCC_CLOCKTYPE_PCLK1 | RCC_CLOCKTYPE_PCLK2); RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK; RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1; RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV2; RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1; if(HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_3) != HAL_OK) { Error_Handler(); }if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_3) != HAL_OK) { ... } }{ ... } /** * @brief This function is executed in case of error occurrence. * @retval None *//* ... */ static void Error_Handler(void) { /* Turn LED2 to off for error */ BSP_LED_Off(LED2); while(1) { }while (1) { ... } }{ ... } /** * @brief Rx Transfer completed callback * @note This example shows a simple way to report end of IT Rx transfer, and * you can add your own implementation. * @retval None *//* ... */ void UART_CharReception_Callback(void) { /* Read Received character. RXNE flag is cleared by reading of DR register */ aRxBuffer[uwRxIndex++] = LL_USART_ReceiveData8(USARTx); /* Check if reception is completed (expected nb of bytes has been received) */ if (uwRxIndex == RXBUFFERSIZE) { /* Set Reception complete boolean to 1 */ ubRxComplete = 1; }if (uwRxIndex == RXBUFFERSIZE) { ... } }{ ... } /** * @brief Function called for achieving next TX Byte sending * @retval None *//* ... */ void UART_TXEmpty_Callback(void) { if(uwTxIndex == (ubSizeToSend - 1)) { /* Disable TXE interrupt */ LL_USART_DisableIT_TXE(USARTx); /* Enable TC interrupt */ LL_USART_EnableIT_TC(USARTx); }if (uwTxIndex == (ubSizeToSend - 1)) { ... } /* Fill DR with a new char */ LL_USART_TransmitData8(USARTx, aTxStartMessage[uwTxIndex++]); }{ ... } /** * @brief Function called at completion of last byte transmission * @retval None *//* ... */ void UART_CharTransmitComplete_Callback(void) { if(uwTxIndex == sizeof(aTxStartMessage)) { uwTxIndex = 0; /* Disable TC interrupt */ LL_USART_DisableIT_TC(USARTx); /* Set Tx complete boolean to 1 */ ubTxComplete = 1; }if (uwTxIndex == sizeof(aTxStartMessage)) { ... } }{ ... } /** * @brief UART error callbacks * @note This example shows a simple way to report transfer error, and you can * add your own implementation. * @retval None *//* ... */ void UART_Error_Callback(void) { __IO uint32_t sr_reg; /* Disable USARTx_IRQn */ NVIC_DisableIRQ(USARTx_IRQn); /* Error handling example : - Read USART SR register to identify flag that leads to IT raising - Perform corresponding error handling treatment according to flag *//* ... */ sr_reg = LL_USART_ReadReg(USARTx, SR); if (sr_reg & LL_USART_SR_NE) { /* Turn LED2 off: Transfer error in reception/transmission process */ BSP_LED_Off(LED2); }if (sr_reg & LL_USART_SR_NE) { ... } else { /* Turn LED2 off: Transfer error in reception/transmission process */ BSP_LED_Off(LED2); }else { ... } }{ ... } #ifdef USE_FULL_ASSERT /** * @brief Reports the name of the source file and the source line number * where the assert_param error has occurred. * @param file: pointer to the source file name * @param line: assert_param error line source number * @retval None *//* ... */ void assert_failed(uint8_t* file, uint32_t line) { /* User can add his own implementation to report the file name and line number, ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) *//* ... */ /* Infinite loop */ while (1) { }while (1) { ... } }assert_failed (uint8_t* file, uint32_t line) { ... } /* ... */#endif /** * @} *//* ... */ /** * @} *//* ... */
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.