]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_STM32F103_GCC_Rowley/Drivers/STM32_USART.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS / Demo / CORTEX_STM32F103_GCC_Rowley / Drivers / STM32_USART.c
1 /*\r
2  * FreeRTOS Kernel V10.3.0\r
3  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
6  * this software and associated documentation files (the "Software"), to deal in\r
7  * the Software without restriction, including without limitation the rights to\r
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
10  * subject to the following conditions:\r
11  *\r
12  * The above copyright notice and this permission notice shall be included in all\r
13  * copies or substantial portions of the Software.\r
14  *\r
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
21  *\r
22  * http://www.FreeRTOS.org\r
23  * http://aws.amazon.com/freertos\r
24  *\r
25  * 1 tab == 4 spaces!\r
26  */\r
27 \r
28 /*\r
29         INTERRUPT DRIVEN SERIAL PORT DRIVER.\r
30 */\r
31 \r
32 \r
33 /******************************************************************************\r
34 *** NOTE:  COM0 == USART1, COM1 == USART2\r
35 ******************************************************************************/\r
36 \r
37 \r
38 /* Scheduler includes. */\r
39 #include "FreeRTOS.h"\r
40 #include "task.h"\r
41 #include "queue.h"\r
42 #include "semphr.h"\r
43 \r
44 /* Library includes. */\r
45 #include "stm32f10x_lib.h"\r
46 \r
47 /* Driver includes. */\r
48 #include "STM32_USART.h"\r
49 /*-----------------------------------------------------------*/\r
50 \r
51 /* The number of COM ports that can be controlled at the same time. */\r
52 #define serNUM_COM_PORTS                                ( 2 )\r
53 \r
54 /* Queues are used to hold characters that are waiting to be transmitted.  This\r
55 constant sets the maximum number of characters that can be contained in such a\r
56 queue at any one time. */\r
57 #define serTX_QUEUE_LEN                                 ( 100 )\r
58 \r
59 /* Queues are used to hold characters that have been received but not yet \r
60 processed.  This constant sets the maximum number of characters that can be \r
61 contained in such a queue. */\r
62 #define serRX_QUEUE_LEN                                 ( 100 )\r
63 \r
64 /* The maximum amount of time that calls to lSerialPutString() should wait for\r
65 there to be space to post each character to the queue of characters waiting\r
66 transmission.  NOTE!  This is the time to wait per character - not the time to\r
67 wait for the entire string. */\r
68 #define serPUT_STRING_CHAR_DELAY                ( 5 / portTICK_PERIOD_MS )\r
69 \r
70 /*-----------------------------------------------------------*/\r
71 \r
72 /* References to the USART peripheral addresses themselves. */\r
73 static USART_TypeDef * const xUARTS[ serNUM_COM_PORTS ] = { ( ( USART_TypeDef * ) USART1_BASE ), ( ( USART_TypeDef * ) USART2_BASE ) };\r
74 \r
75 /* Queues used to hold characters waiting to be transmitted - one queue per port. */\r
76 static QueueHandle_t xCharsForTx[ serNUM_COM_PORTS ] = { 0 };\r
77 \r
78 /* Queues holding received characters - one queue per port. */\r
79 static QueueHandle_t xRxedChars[ serNUM_COM_PORTS ] = { 0 };\r
80 \r
81 /*-----------------------------------------------------------*/\r
82 \r
83 /* UART interrupt handlers, as named in the vector table. */\r
84 void USART1_IRQHandler( void );\r
85 void USART2_IRQHandler( void );\r
86 \r
87 /*-----------------------------------------------------------*/\r
88 \r
89 /*\r
90  * See header file for parameter descriptions.\r
91  */\r
92 long lCOMPortInit( unsigned long ulPort, unsigned long ulWantedBaud )\r
93 {\r
94 long lReturn = pdFAIL;\r
95 USART_InitTypeDef USART_InitStructure;\r
96 NVIC_InitTypeDef NVIC_InitStructure;\r
97 GPIO_InitTypeDef GPIO_InitStructure;\r
98 \r
99         if( ulPort < serNUM_COM_PORTS )\r
100         {\r
101                 /* The common (not port dependent) part of the initialisation. */\r
102                 USART_InitStructure.USART_BaudRate = ulWantedBaud;\r
103                 USART_InitStructure.USART_WordLength = USART_WordLength_8b;\r
104                 USART_InitStructure.USART_StopBits = USART_StopBits_1;\r
105                 USART_InitStructure.USART_Parity = USART_Parity_No;\r
106                 USART_InitStructure.USART_HardwareFlowControl = USART_HardwareFlowControl_None;\r
107                 USART_InitStructure.USART_Mode = USART_Mode_Rx | USART_Mode_Tx;\r
108                 NVIC_InitStructure.NVIC_IRQChannelPreemptionPriority = configLIBRARY_KERNEL_INTERRUPT_PRIORITY;\r
109                 NVIC_InitStructure.NVIC_IRQChannelSubPriority = 0;\r
110                 NVIC_InitStructure.NVIC_IRQChannelCmd = ENABLE;\r
111 \r
112 \r
113                 /* Init the buffer structures with the buffer for the COM port being\r
114                 initialised, and perform any non-common initialisation necessary.  This\r
115                 does not check to see if the COM port has already been initialised. */\r
116                 if( ulPort == 0 )\r
117                 {\r
118                         /* Create the queue of chars that are waiting to be sent to COM0. */\r
119                         xCharsForTx[ 0 ] = xQueueCreate( serTX_QUEUE_LEN, sizeof( char ) );\r
120 \r
121                         /* Create the queue used to hold characters received from COM0. */\r
122                         xRxedChars[ 0 ] = xQueueCreate( serRX_QUEUE_LEN, sizeof( char ) );\r
123 \r
124                         /* Enable COM0 clock - the ST libraries start numbering from UART1. */\r
125                         RCC_APB2PeriphClockCmd( RCC_APB2Periph_USART1 | RCC_APB2Periph_GPIOA, ENABLE ); \r
126 \r
127                         /* Configure USART1 Rx (PA10) as input floating */\r
128                         GPIO_InitStructure.GPIO_Pin = GPIO_Pin_10;\r
129                         GPIO_InitStructure.GPIO_Mode = GPIO_Mode_IN_FLOATING;\r
130                         GPIO_Init( GPIOA, &GPIO_InitStructure );\r
131                         \r
132                         /* Configure USART1 Tx (PA9) as alternate function push-pull */\r
133                         GPIO_InitStructure.GPIO_Pin = GPIO_Pin_9;\r
134                         GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;\r
135                         GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF_PP;\r
136                         GPIO_Init( GPIOA, &GPIO_InitStructure );\r
137 \r
138                         USART_Init( USART1, &USART_InitStructure );             \r
139                         USART_ITConfig( USART1, USART_IT_RXNE, ENABLE );\r
140                         \r
141                         NVIC_InitStructure.NVIC_IRQChannel = USART1_IRQChannel;\r
142                         NVIC_Init( &NVIC_InitStructure );\r
143                         \r
144             USART_DMACmd( USART1, ( USART_DMAReq_Tx | USART_DMAReq_Rx ), ENABLE );\r
145                         USART_Cmd( USART1, ENABLE );    \r
146 \r
147                         /* Everything is ok. */\r
148                         lReturn = pdPASS;\r
149                 }\r
150                 else if( ulPort == 1 )\r
151                 {\r
152                         /* Create the queue of chars that are waiting to be sent to COM1. */\r
153                         xCharsForTx[ 1 ] = xQueueCreate( serTX_QUEUE_LEN, sizeof( char ) );\r
154 \r
155                         /* Create the queue used to hold characters received from COM0. */\r
156                         xRxedChars[ 1 ] = xQueueCreate( serRX_QUEUE_LEN, sizeof( char ) );\r
157 \r
158                         /* Enable COM0 clock - the ST libraries start numbering from 1. */\r
159                         RCC_APB2PeriphClockCmd( RCC_APB1Periph_USART2 | RCC_APB2Periph_GPIOA, ENABLE ); \r
160 \r
161                         /* Configure USART2 Rx (PA3) as input floating */\r
162                         GPIO_InitStructure.GPIO_Pin = GPIO_Pin_3;\r
163                         GPIO_InitStructure.GPIO_Mode = GPIO_Mode_IN_FLOATING;\r
164                         GPIO_Init( GPIOA, &GPIO_InitStructure );\r
165                         \r
166                         /* Configure USART2 Tx (PA2) as alternate function push-pull */\r
167                         GPIO_InitStructure.GPIO_Pin = GPIO_Pin_2;\r
168                         GPIO_InitStructure.GPIO_Speed = GPIO_Speed_50MHz;\r
169                         GPIO_InitStructure.GPIO_Mode = GPIO_Mode_AF_PP;\r
170                         GPIO_Init( GPIOA, &GPIO_InitStructure );\r
171 \r
172                         USART_Init( USART2, &USART_InitStructure );             \r
173                         USART_ITConfig( USART2, USART_IT_RXNE, ENABLE );\r
174                         \r
175                         NVIC_InitStructure.NVIC_IRQChannel = USART2_IRQChannel;\r
176                         NVIC_Init( &NVIC_InitStructure );\r
177                         \r
178             USART_DMACmd( USART2, ( USART_DMAReq_Tx | USART_DMAReq_Rx ), ENABLE );\r
179                         USART_Cmd( USART2, ENABLE );    \r
180 \r
181                         /* Everything is ok. */\r
182                         lReturn = pdPASS;\r
183                 }       \r
184                 else\r
185                 {\r
186                         /* Nothing to do unless more than two ports are supported. */\r
187                 }\r
188         }\r
189         \r
190         return lReturn;\r
191 }\r
192 /*-----------------------------------------------------------*/\r
193 \r
194 signed long xSerialGetChar( long lPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
195 {\r
196 long lReturn = pdFAIL;\r
197 \r
198         if( lPort < serNUM_COM_PORTS ) \r
199         {\r
200                 if( xQueueReceive( xRxedChars[ lPort ], pcRxedChar, xBlockTime ) == pdPASS )\r
201                 {\r
202                         lReturn = pdPASS;\r
203                 }\r
204         }\r
205 \r
206         return lReturn;\r
207 }\r
208 /*-----------------------------------------------------------*/\r
209 \r
210 long lSerialPutString( long lPort, const char * const pcString, unsigned long ulStringLength )\r
211 {\r
212 long lReturn;\r
213 unsigned long ul;\r
214 \r
215         if( lPort < serNUM_COM_PORTS )\r
216         {\r
217                 lReturn = pdPASS;\r
218 \r
219                 for( ul = 0; ul < ulStringLength; ul++ )\r
220                 {\r
221                         if( xQueueSend( xCharsForTx[ lPort ], &( pcString[ ul ] ), serPUT_STRING_CHAR_DELAY ) != pdPASS )\r
222                         {\r
223                                 /* Cannot fit any more in the queue.  Try turning the Tx on to \r
224                                 clear some space. */\r
225                                 USART_ITConfig( xUARTS[ lPort ], USART_IT_TXE, ENABLE );\r
226                                 vTaskDelay( serPUT_STRING_CHAR_DELAY );\r
227 \r
228                                 /* Go back and try again. */\r
229                                 continue;\r
230                         }\r
231                 }\r
232 \r
233         USART_ITConfig( xUARTS[ lPort ], USART_IT_TXE, ENABLE );\r
234         }\r
235         else\r
236         {\r
237                 lReturn = pdFAIL;\r
238         }\r
239 \r
240         return lReturn;\r
241 }\r
242 /*-----------------------------------------------------------*/\r
243 \r
244 signed long xSerialPutChar( long lPort, signed char cOutChar, TickType_t xBlockTime )\r
245 {\r
246 long lReturn;\r
247 \r
248         if( xQueueSend( xCharsForTx[ lPort ], &cOutChar, xBlockTime ) == pdPASS )\r
249         {\r
250                 lReturn = pdPASS;\r
251                 USART_ITConfig( xUARTS[ lPort ], USART_IT_TXE, ENABLE );\r
252         }\r
253         else\r
254         {\r
255                 lReturn = pdFAIL;\r
256         }\r
257 \r
258         return lReturn;\r
259 }\r
260 /*-----------------------------------------------------------*/\r
261 \r
262 void USART1_IRQHandler( void )\r
263 {\r
264 long xHigherPriorityTaskWoken = pdFALSE;\r
265 char cChar;\r
266 \r
267         if( USART_GetITStatus( USART1, USART_IT_TXE ) == SET )\r
268         {\r
269                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
270                 more characters to transmit? */\r
271                 if( xQueueReceiveFromISR( xCharsForTx[ 0 ], &cChar, &xHigherPriorityTaskWoken ) )\r
272                 {\r
273                         /* A character was retrieved from the buffer so can be sent to the\r
274                         THR now. */\r
275                         USART_SendData( USART1, cChar );\r
276                 }\r
277                 else\r
278                 {\r
279                         USART_ITConfig( USART1, USART_IT_TXE, DISABLE );                \r
280                 }               \r
281         }\r
282         \r
283         if( USART_GetITStatus( USART1, USART_IT_RXNE ) == SET )\r
284         {\r
285                 cChar = USART_ReceiveData( USART1 );\r
286                 xQueueSendFromISR( xRxedChars[ 0 ], &cChar, &xHigherPriorityTaskWoken );\r
287         }       \r
288         \r
289         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
290 }\r
291 /*-----------------------------------------------------------*/\r
292 \r
293 void USART2_IRQHandler( void )\r
294 {\r
295 }\r
296 \r
297 \r
298 \r
299 \r
300         \r