]> git.sur5r.net Git - freertos/blob - Demo/ARM7_AT91FR40008_GCC/serial/serial.c
Remove unnecessary use of portLONG, portCHAR and portSHORT.
[freertos] / Demo / ARM7_AT91FR40008_GCC / serial / serial.c
1 /*\r
2     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.\r
3 \r
4     This file is part of the FreeRTOS distribution.\r
5 \r
6     FreeRTOS is free software; you can redistribute it and/or modify it    under\r
7     the terms of the GNU General Public License (version 2) as published by the\r
8     Free Software Foundation and modified by the FreeRTOS exception.\r
9     **NOTE** The exception to the GPL is included to allow you to distribute a\r
10     combined work that includes FreeRTOS without being obliged to provide the\r
11     source code for proprietary components outside of the FreeRTOS kernel.\r
12     Alternative commercial license and support terms are also available upon\r
13     request.  See the licensing section of http://www.FreeRTOS.org for full\r
14     license details.\r
15 \r
16     FreeRTOS is distributed in the hope that it will be useful,    but WITHOUT\r
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
19     more details.\r
20 \r
21     You should have received a copy of the GNU General Public License along\r
22     with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
23     Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
24 \r
25 \r
26     ***************************************************************************\r
27     *                                                                         *\r
28     * The FreeRTOS eBook and reference manual are available to purchase for a *\r
29     * small fee. Help yourself get started quickly while also helping the     *\r
30     * FreeRTOS project! See http://www.FreeRTOS.org/Documentation for details *\r
31     *                                                                         *\r
32     ***************************************************************************\r
33 \r
34     1 tab == 4 spaces!\r
35 \r
36     Please ensure to read the configuration and relevant port sections of the\r
37     online documentation.\r
38 \r
39     http://www.FreeRTOS.org - Documentation, latest information, license and\r
40     contact details.\r
41 \r
42     http://www.SafeRTOS.com - A version that is certified for use in safety\r
43     critical systems.\r
44 \r
45     http://www.OpenRTOS.com - Commercial support, development, porting,\r
46     licensing and training services.\r
47 */\r
48 \r
49 /* \r
50         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR USART0. \r
51 \r
52         This file contains all the serial port components that can be compiled to\r
53         either ARM or THUMB mode.  Components that must be compiled to ARM mode are\r
54         contained in serialISR.c.\r
55 */\r
56 \r
57 /* Standard includes. */\r
58 #include <stdlib.h>\r
59 \r
60 /* Scheduler includes. */\r
61 #include "FreeRTOS.h"\r
62 #include "queue.h"\r
63 #include "task.h"\r
64 \r
65 /* Demo application includes. */\r
66 #include "serial.h"\r
67 #include "AT91R40008.h"\r
68 #include "usart.h"\r
69 #include "pio.h"\r
70 #include "aic.h"\r
71 \r
72 /*-----------------------------------------------------------*/\r
73 \r
74 /* Constants to setup and access the UART. */\r
75 #define portUSART0_AIC_CHANNEL  ( ( unsigned long ) 2 )\r
76 \r
77 #define serINVALID_QUEUE                ( ( xQueueHandle ) 0 )\r
78 #define serHANDLE                               ( ( xComPortHandle ) 1 )\r
79 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
80 \r
81 /*-----------------------------------------------------------*/\r
82 \r
83 /* Queues used to hold received characters, and characters waiting to be\r
84 transmitted. */\r
85 static xQueueHandle xRxedChars; \r
86 static xQueueHandle xCharsForTx; \r
87 \r
88 /*-----------------------------------------------------------*/\r
89 \r
90 /* \r
91  * The queues are created in serialISR.c as they are used from the ISR.\r
92  * Obtain references to the queues and THRE Empty flag. \r
93  */\r
94 extern void vSerialISRCreateQueues(  unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxRxedChars, xQueueHandle *pxCharsForTx );\r
95 \r
96 /*-----------------------------------------------------------*/\r
97 \r
98 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
99 {\r
100 unsigned long ulSpeed;\r
101 unsigned long ulCD;\r
102 xComPortHandle xReturn = serHANDLE;\r
103 extern void ( vUART_ISR_Wrapper )( void );\r
104 \r
105         /* The queues are used in the serial ISR routine, so are created from\r
106         serialISR.c (which is always compiled to ARM mode. */\r
107         vSerialISRCreateQueues( uxQueueLength, &xRxedChars, &xCharsForTx );\r
108 \r
109         if( \r
110                 ( xRxedChars != serINVALID_QUEUE ) && \r
111                 ( xCharsForTx != serINVALID_QUEUE ) && \r
112                 ( ulWantedBaud != ( unsigned long ) 0 ) \r
113           )\r
114         {\r
115                 portENTER_CRITICAL();\r
116                 {\r
117                         /* Enable clock to USART0... */\r
118                         AT91C_BASE_PS->PS_PCER = AT91C_PS_US0;\r
119 \r
120                         /* Disable all USART0 interrupt sources to begin... */\r
121                         AT91C_BASE_US0->US_IDR = 0xFFFFFFFF;\r
122 \r
123                         /* Reset various status bits (just in case)... */\r
124                         AT91C_BASE_US0->US_CR = US_RSTSTA;\r
125 \r
126                         AT91C_BASE_PIO->PIO_PDR = TXD0 | RXD0;  /* Enable RXD and TXD pins */\r
127                         AT91C_BASE_US0->US_CR = US_RSTRX | US_RSTTX | US_RXDIS | US_TXDIS;\r
128 \r
129                         /* Clear Transmit and Receive Counters */\r
130                         AT91C_BASE_US0->US_RCR = 0;\r
131                         AT91C_BASE_US0->US_TCR = 0;\r
132 \r
133                         /* Input clock to baud rate generator is MCK */\r
134                         ulSpeed = configCPU_CLOCK_HZ * 10;  \r
135                         ulSpeed = ulSpeed / 16;\r
136                         ulSpeed = ulSpeed / ulWantedBaud;\r
137                         \r
138                         /* compute the error */\r
139                         ulCD  = ulSpeed / 10;\r
140                         if ((ulSpeed - (ulCD * 10)) >= 5)\r
141                         ulCD++;\r
142 \r
143                         /* Define the baud rate divisor register */\r
144                         AT91C_BASE_US0->US_BRGR = ulCD;\r
145 \r
146                         /* Define the USART mode */\r
147                         AT91C_BASE_US0->US_MR = US_CLKS_MCK | US_CHRL_8 | US_PAR_NO | US_NBSTOP_1 | US_CHMODE_NORMAL;\r
148 \r
149                         /* Write the Timeguard Register */\r
150                         AT91C_BASE_US0->US_TTGR = 0;\r
151 \r
152                         /* Setup the interrupt for USART0.\r
153 \r
154                         Store interrupt handler function address in USART0 vector register... */\r
155                         AT91C_BASE_AIC->AIC_SVR[ portUSART0_AIC_CHANNEL ] = (unsigned long)vUART_ISR_Wrapper;\r
156                         \r
157                         /* USART0 interrupt level-sensitive, priority 1... */\r
158                         AT91C_BASE_AIC->AIC_SMR[ portUSART0_AIC_CHANNEL ] = AIC_SRCTYPE_INT_LEVEL_SENSITIVE | 1;\r
159                         \r
160                         /* Clear some pending USART0 interrupts (just in case)... */\r
161                         AT91C_BASE_US0->US_CR = US_RSTSTA;\r
162 \r
163                         /* Enable USART0 interrupt sources (but not Tx for now)... */\r
164                         AT91C_BASE_US0->US_IER = US_RXRDY;\r
165 \r
166                         /* Enable USART0 interrupts in the AIC... */\r
167                         AT91C_BASE_AIC->AIC_IECR = ( 1 << portUSART0_AIC_CHANNEL );\r
168 \r
169                         /* Enable receiver and transmitter... */\r
170                         AT91C_BASE_US0->US_CR = US_RXEN | US_TXEN;\r
171                 }\r
172                 portEXIT_CRITICAL();\r
173         }\r
174         else\r
175         {\r
176                 xReturn = ( xComPortHandle ) 0;\r
177         }\r
178 \r
179         return xReturn;\r
180 }\r
181 /*-----------------------------------------------------------*/\r
182 \r
183 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
184 {\r
185         /* The port handle is not required as this driver only supports UART0. */\r
186         ( void ) pxPort;\r
187 \r
188         /* Get the next character from the buffer.  Return false if no characters\r
189         are available, or arrive before xBlockTime expires. */\r
190         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
191         {\r
192                 return pdTRUE;\r
193         }\r
194         else\r
195         {\r
196                 return pdFALSE;\r
197         }\r
198 }\r
199 /*-----------------------------------------------------------*/\r
200 \r
201 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
202 {\r
203 signed char *pxNext;\r
204 \r
205         /* NOTE: This implementation does not handle the queue being full as no\r
206         block time is used! */\r
207 \r
208         /* The port handle is not required as this driver only supports UART0. */\r
209         ( void ) pxPort;\r
210         ( void ) usStringLength;\r
211 \r
212         /* Send each character in the string, one at a time. */\r
213         pxNext = ( signed char * ) pcString;\r
214         while( *pxNext )\r
215         {\r
216                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
217                 pxNext++;\r
218         }\r
219 }\r
220 /*-----------------------------------------------------------*/\r
221 \r
222 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
223 {\r
224         ( void ) pxPort;\r
225 \r
226         /* Place the character in the queue of characters to be transmitted. */\r
227         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
228         {\r
229                 return pdFAIL;\r
230         }\r
231 \r
232         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
233         queue and send it.   This does not need to be in a critical section as\r
234         if the interrupt has already removed the character the next interrupt\r
235         will simply turn off the Tx interrupt again. */\r
236         AT91C_BASE_US0->US_IER = US_TXRDY;\r
237 \r
238         return pdPASS;\r
239 }\r
240 /*-----------------------------------------------------------*/\r
241 \r
242 void vSerialClose( xComPortHandle xPort )\r
243 {\r
244         /* Not supported as not required by the demo application. */\r
245         ( void ) xPort;\r
246 }\r
247 /*-----------------------------------------------------------*/\r
248 \r