]> begriffs open source - freertos/blob - Demo/msp430_CrossWorks/serial/serial.c
Changes between V4.5.0 and V4.6.0 released October 28 2007
[freertos] / Demo / msp430_CrossWorks / serial / serial.c
1 /*\r
2         FreeRTOS.org V4.6.0 - Copyright (C) 2003-2007 Richard Barry.\r
3 \r
4         This file is part of the FreeRTOS.org distribution.\r
5 \r
6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
7         it under the terms of the GNU General Public License as published by\r
8         the Free Software Foundation; either version 2 of the License, or\r
9         (at your option) any later version.\r
10 \r
11         FreeRTOS.org is distributed in the hope that it will be useful,\r
12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14         GNU General Public License for more details.\r
15 \r
16         You should have received a copy of the GNU General Public License\r
17         along with FreeRTOS.org; if not, write to the Free Software\r
18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
19 \r
20         A special exception to the GPL can be applied should you wish to distribute\r
21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
22         the source code for any proprietary components.  See the licensing section \r
23         of http://www.FreeRTOS.org for full details of how and when the exception\r
24         can be applied.\r
25 \r
26         ***************************************************************************\r
27         See http://www.FreeRTOS.org for documentation, latest information, license \r
28         and contact details.  Please ensure to read the configuration and relevant \r
29         port sections of the online documentation.\r
30 \r
31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
32         with commercial development and support options.\r
33         ***************************************************************************\r
34 */\r
35 \r
36 \r
37 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.   \r
38  * \r
39  * This file only supports UART 1\r
40  */\r
41 \r
42 /* Standard includes. */\r
43 #include <stdlib.h>\r
44 \r
45 /* Scheduler includes. */\r
46 #include "FreeRTOS.h"\r
47 #include "queue.h"\r
48 #include "task.h"\r
49 \r
50 /* Demo application includes. */\r
51 #include "serial.h"\r
52 \r
53 /* Constants required to setup the hardware. */\r
54 #define serTX_AND_RX                    ( ( unsigned portCHAR ) 0x03 )\r
55 \r
56 /* Misc. constants. */\r
57 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
58 \r
59 /* Enable the UART Tx interrupt. */\r
60 #define vInterruptOn() IFG2 |= UTXIFG1\r
61 \r
62 /* The queue used to hold received characters. */\r
63 static xQueueHandle xRxedChars; \r
64 \r
65 /* The queue used to hold characters waiting transmission. */\r
66 static xQueueHandle xCharsForTx; \r
67 \r
68 static volatile portSHORT sTHREEmpty;\r
69 \r
70 /*-----------------------------------------------------------*/\r
71 \r
72 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
73 {\r
74 unsigned portLONG ulBaudRateCount;\r
75 \r
76         /* Initialise the hardware. */\r
77 \r
78         /* Generate the baud rate constants for the wanted baud rate. */\r
79         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
80 \r
81         portENTER_CRITICAL();\r
82         {\r
83                 /* Create the queues used by the com test task. */\r
84                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
85                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
86 \r
87                 /* Reset UART. */\r
88                 UCTL1 |= SWRST;\r
89 \r
90                 /* Set pin function. */\r
91                 P4SEL |= serTX_AND_RX;\r
92 \r
93                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation. \r
94                 LOOPBACK MODE!*/\r
95                 U1CTL |= CHAR + LISTEN;\r
96                 U1TCTL |= SSEL1;\r
97 \r
98                 /* Setup baud rate low byte. */\r
99                 U1BR0 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
100 \r
101                 /* Setup baud rate high byte. */\r
102                 ulBaudRateCount >>= 8UL;\r
103                 U1BR1 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
104 \r
105                 /* Enable ports. */\r
106                 ME2 |= UTXE1 + URXE1;\r
107 \r
108                 /* Set. */\r
109                 UCTL1 &= ~SWRST;\r
110 \r
111                 /* Nothing in the buffer yet. */\r
112                 sTHREEmpty = pdTRUE;\r
113 \r
114                 /* Enable interrupts. */\r
115                 IE2 |= URXIE1 + UTXIE1;\r
116         }\r
117         portEXIT_CRITICAL();\r
118         \r
119         /* Unlike other ports, this serial code does not allow for more than one\r
120         com port.  We therefore don't return a pointer to a port structure and can\r
121         instead just return NULL. */\r
122         return NULL;\r
123 }\r
124 /*-----------------------------------------------------------*/\r
125 \r
126 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
127 {\r
128         /* Get the next character from the buffer.  Return false if no characters\r
129         are available, or arrive before xBlockTime expires. */\r
130         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
131         {\r
132                 return pdTRUE;\r
133         }\r
134         else\r
135         {\r
136                 return pdFALSE;\r
137         }\r
138 }\r
139 /*-----------------------------------------------------------*/\r
140 \r
141 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
142 {\r
143 signed portBASE_TYPE xReturn;\r
144 \r
145         /* Transmit a character. */\r
146 \r
147         portENTER_CRITICAL();\r
148         {\r
149                 if( sTHREEmpty == pdTRUE )\r
150                 {\r
151                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that \r
152                         there are no characters queued to be transmitted - so we can\r
153                         write the character directly to the shift Tx register. */\r
154                         sTHREEmpty = pdFALSE;\r
155                         U1TXBUF = cOutChar;\r
156                         xReturn = pdPASS;\r
157                 }\r
158                 else\r
159                 {\r
160                         /* sTHREEmpty is false, so there are still characters waiting to be\r
161                         transmitted.  We have to queue this character so it gets \r
162                         transmitted     in turn. */\r
163 \r
164                         /* Return false if after the block time there is no room on the Tx \r
165                         queue.  It is ok to block inside a critical section as each task\r
166                         maintains it's own critical section status. */\r
167                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
168 \r
169                         /* Depending on queue sizing and task prioritisation:  While we \r
170                         were blocked waiting to post on the queue interrupts were not \r
171                         disabled.  It is possible that the serial ISR has emptied the \r
172                         Tx queue, in which case we need to start the Tx off again\r
173                         writing directly to the Tx register. */\r
174                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
175                         {\r
176                                 /* Get back the character we just posted. */\r
177                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
178                                 sTHREEmpty = pdFALSE;\r
179                                 U1TXBUF = cOutChar;\r
180                         }\r
181                 }\r
182         }\r
183         portEXIT_CRITICAL();\r
184 \r
185         return pdPASS;\r
186 }\r
187 /*-----------------------------------------------------------*/\r
188 \r
189 #ifdef MSP_ROWLEY_RB_PORT\r
190 \r
191 /* Serial interrupt service routines for the RB port. */\r
192 \r
193         /*\r
194          * UART RX interrupt service routine.\r
195          */\r
196         void vRxISR( void ) __interrupt[ UART1RX_VECTOR ]\r
197         {\r
198         signed portCHAR cChar;\r
199         \r
200                 /* Get the character from the UART and post it on the queue of Rxed \r
201                 characters. */\r
202                 cChar = U1RXBUF;\r
203         \r
204                 if( xQueueSendFromISR( xRxedChars, &cChar, pdFALSE ) )\r
205                 {\r
206                         /*If the post causes a task to wake force a context switch \r
207                         as the woken task may have a higher priority than the task we have \r
208                         interrupted. */\r
209                         taskYIELD();\r
210                 }\r
211         }\r
212         /*-----------------------------------------------------------*/\r
213         \r
214         /*\r
215          * UART Tx interrupt service routine.\r
216          */\r
217         void vTxISR( void ) __interrupt[ UART1TX_VECTOR ]\r
218         {\r
219         signed portCHAR cChar;\r
220         portBASE_TYPE xTaskWoken;\r
221         \r
222                 /* The previous character has been transmitted.  See if there are any\r
223                 further characters waiting transmission. */\r
224         \r
225                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
226                 {\r
227                         /* There was another character queued - transmit it now. */\r
228                         U1TXBUF = cChar;\r
229                 }\r
230                 else\r
231                 {\r
232                         /* There were no other characters to transmit. */\r
233                         sTHREEmpty = pdTRUE;\r
234                 }\r
235         }\r
236 \r
237 #endif\r
238 /*-----------------------------------------------------------*/\r
239 \r
240 #ifdef MSP_ROWLEY_MP_PORT\r
241 \r
242 /* Serial port interrupts for the alternative port code. */\r
243 \r
244         void ISRCom1Rx( void )\r
245         {\r
246         signed portCHAR cChar;\r
247         \r
248                 /* Get the character from the UART and post it on the queue of Rxed \r
249                 characters. */\r
250                 cChar = U1RXBUF;\r
251         \r
252                 if( xQueueSendFromISR( xRxedChars, &cChar, pdFALSE ) )\r
253                 {\r
254                         /*If the post causes a task to wake force a context switch \r
255                         as the woken task may have a higher priority than the task we have \r
256                         interrupted. */\r
257                         portEXIT_SWITCHING_ISR( pdTRUE );\r
258                 }\r
259         }\r
260         /*-----------------------------------------------------------*/\r
261         \r
262         void ISRCom1Tx( void )\r
263         {\r
264         signed portCHAR cChar;\r
265         portBASE_TYPE xTaskWoken;\r
266         \r
267                 /* The previous character has been transmitted.  See if there are any\r
268                 further characters waiting transmission. */\r
269         \r
270                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
271                 {\r
272                         /* There was another character queued - transmit it now. */\r
273                         U1TXBUF = cChar;\r
274                 }\r
275                 else\r
276                 {\r
277                         /* There were no other characters to transmit. */\r
278                         sTHREEmpty = pdTRUE;\r
279                 }\r
280         }\r
281 \r
282 #endif\r
283 /*-----------------------------------------------------------*/\r