git.sur5r.net Git - freertos/blob - Demo/ARM7_AT91SAM7S64_IAR/serial/serial.c

   1 /*\r
   2         FreeRTOS.org V4.8.0 - Copyright (C) 2003-2008 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         ***************************************************************************\r
  28         *                                                                                                                                                 *\r
  29         * SAVE TIME AND MONEY!  Why not get us to quote to get FreeRTOS.org               *\r
  30         * running on your hardware - or even write all or part of your application*\r
  31         * for you?  See http://www.OpenRTOS.com for details.                                      *\r
  32         *                                                                                                                                                 *\r
  33         ***************************************************************************\r
  34         ***************************************************************************\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 UART0. \r
  51 */\r
  52 \r
  53 /* Standard includes. */ \r
  54 #include <stdlib.h>\r
  55 \r
  56 /* Scheduler includes. */\r
  57 #include "FreeRTOS.h"\r
  58 #include "queue.h"\r
  59 \r
  60 /* Demo application includes. */\r
  61 #include "serial.h"\r
  62 \r
  63 /*-----------------------------------------------------------*/\r
  64 \r
  65 /* Location of the COM0 registers. */\r
  66 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  67 \r
  68 /* Interrupt control macros. */\r
  69 #define serINTERRUPT_LEVEL                              ( 5 )\r
  70 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  71 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  72 \r
  73 /* Misc constants. */\r
  74 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  75 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  76 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  77 #define serNO_TIMEGUARD                                 ( ( unsigned portLONG ) 0 )\r
  78 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned portLONG ) 0 )\r
  79 \r
  80 \r
  81 /* Queues used to hold received characters, and characters waiting to be\r
  82 transmitted. */\r
  83 static xQueueHandle xRxedChars; \r
  84 static xQueueHandle xCharsForTx; \r
  85 \r
  86 /*-----------------------------------------------------------*/\r
  87 \r
  88 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
  89 extern void vSerialISREntry( void );\r
  90 \r
  91 /* The interrupt service routine - called from the assembly entry point. */\r
  92 __arm void vSerialISR( void );\r
  93 \r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 /*\r
  97  * See the serial2.h header file.\r
  98  */\r
  99 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 100 {\r
 101 xComPortHandle xReturn = serHANDLE;\r
 102 extern void ( vUART_ISR )( void );\r
 103 \r
 104         /* Create the queues used to hold Rx and Tx characters. */\r
 105         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 106         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 107 \r
 108         /* If the queues were created correctly then setup the serial port \r
 109         hardware. */\r
 110         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 111         {\r
 112                 portENTER_CRITICAL();\r
 113                 {\r
 114                         /* Enable the USART clock. */\r
 115                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
 116 \r
 117                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned portLONG ) AT91C_PA5_RXD0 ) | ( ( unsigned portLONG ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
 118 \r
 119                         /* Set the required protocol. */\r
 120                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 121 \r
 122                         /* Enable Rx and Tx. */\r
 123                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\r
 124 \r
 125                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 126                         until there are characters to be transmitted. */\r
 127                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 128 \r
 129                         /* Enable the interrupts in the AIC. */\r
 130                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 131                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, AT91C_ID_US0 );\r
 132                 }\r
 133                 portEXIT_CRITICAL();\r
 134         }\r
 135         else\r
 136         {\r
 137                 xReturn = ( xComPortHandle ) 0;\r
 138         }\r
 139 \r
 140         /* This demo file only supports a single port but we have to return \r
 141         something to comply with the standard demo header file. */\r
 142         return xReturn;\r
 143 }\r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 147 {\r
 148         /* The port handle is not required as this driver only supports one port. */\r
 149         ( void ) pxPort;\r
 150 \r
 151         /* Get the next character from the buffer.  Return false if no characters\r
 152         are available, or arrive before xBlockTime expires. */\r
 153         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 154         {\r
 155                 return pdTRUE;\r
 156         }\r
 157         else\r
 158         {\r
 159                 return pdFALSE;\r
 160         }\r
 161 }\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 165 {\r
 166 signed portCHAR *pxNext;\r
 167 \r
 168         /* A couple of parameters that this port does not use. */\r
 169         ( void ) usStringLength;\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* NOTE: This implementation does not handle the queue being full as no\r
 173         block time is used! */\r
 174 \r
 175         /* The port handle is not required as this driver only supports UART0. */\r
 176         ( void ) pxPort;\r
 177 \r
 178         /* Send each character in the string, one at a time. */\r
 179         pxNext = ( signed portCHAR * ) pcString;\r
 180         while( *pxNext )\r
 181         {\r
 182                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 183                 pxNext++;\r
 184         }\r
 185 }\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 189 {\r
 190         /* Place the character in the queue of characters to be transmitted. */\r
 191         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 192         {\r
 193                 return pdFAIL;\r
 194         }\r
 195 \r
 196         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 197         queue and send it.   This does not need to be in a critical section as\r
 198         if the interrupt has already removed the character the next interrupt\r
 199         will simply turn off the Tx interrupt again. */\r
 200         vInterruptOn();\r
 201 \r
 202         return pdPASS;\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 void vSerialClose( xComPortHandle xPort )\r
 207 {\r
 208         /* Not supported as not required by the demo application. */\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 213 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 214 within serialISR.s79 which in turn calls this function.  See the port\r
 215 documentation on the FreeRTOS.org website for more information. */\r
 216 __arm void vSerialISR( void )\r
 217 {\r
 218 unsigned portLONG ulStatus;\r
 219 signed portCHAR cChar;\r
 220 portBASE_TYPE xTaskWokenByTx = pdFALSE, xTaskWokenByPost = pdFALSE;\r
 221 \r
 222         /* What caused the interrupt? */\r
 223         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 224 \r
 225         if( ulStatus & AT91C_US_TXRDY )\r
 226         {\r
 227                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 228                 more characters to transmit? */\r
 229                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWokenByTx ) == pdTRUE )\r
 230                 {\r
 231                         /* A character was retrieved from the queue so can be sent to the\r
 232                         THR now. */\r
 233                         serCOM0->US_THR = cChar;\r
 234                 }\r
 235                 else\r
 236                 {\r
 237                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 238                         vInterruptOff();\r
 239                 }               \r
 240         }\r
 241 \r
 242         if( ulStatus & AT91C_US_RXRDY )\r
 243         {\r
 244                 /* The interrupt was caused by a character being received.  Grab the\r
 245                 character from the RHR and place it in the queue or received \r
 246                 characters. */\r
 247                 cChar = serCOM0->US_RHR;\r
 248                 xTaskWokenByPost = xQueueSendFromISR( xRxedChars, &cChar, xTaskWokenByPost );\r
 249         }\r
 250 \r
 251         /* If a task was woken by either a character being received or a character \r
 252         being transmitted then we may need to switch to another task. */\r
 253         portEND_SWITCHING_ISR( ( xTaskWokenByPost || xTaskWokenByTx ) );\r
 254 \r
 255         /* End the interrupt in the AIC. */\r
 256         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 257 }\r
 258 \r
 259 \r
 260 \r
 261 \r
 262         \r