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

   1 /*\r
   2         FreeRTOS V5.4.2 - 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         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 /*\r
  49         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  50 */\r
  51 \r
  52 /* Standard includes. */\r
  53 #include <stdlib.h>\r
  54 \r
  55 /* Scheduler includes. */\r
  56 #include "FreeRTOS.h"\r
  57 #include "queue.h"\r
  58 \r
  59 /* Demo application includes. */\r
  60 #include "serial.h"\r
  61 \r
  62 /* Atmel library includes. */\r
  63 #include <usart/usart.h>\r
  64 #include <aic/aic.h>\r
  65 #include <pmc/pmc.h>\r
  66 \r
  67 /*-----------------------------------------------------------*/\r
  68 \r
  69 /* Location of the COM0 registers. */\r
  70 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  71 \r
  72 /* Interrupt control macros. */\r
  73 #define serINTERRUPT_LEVEL                              ( 5 )\r
  74 #define vInterruptOn()                                  serCOM0->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  75 #define vInterruptOff()                                 serCOM0->US_IDR = AT91C_US_TXRDY\r
  76 \r
  77 /* Misc constants. */\r
  78 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  79 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  80 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  81 #define serNO_TIMEGUARD                                 ( ( unsigned portLONG ) 0 )\r
  82 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned portLONG ) 0 )\r
  83 \r
  84 \r
  85 /* Queues used to hold received characters, and characters waiting to be\r
  86 transmitted. */\r
  87 static xQueueHandle xRxedChars;\r
  88 static xQueueHandle xCharsForTx;\r
  89 \r
  90 /*-----------------------------------------------------------*/\r
  91 \r
  92 /* The interrupt service routine. */\r
  93 __arm void vSerialISR( void );\r
  94 \r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 /*\r
  98  * See the serial2.h header file.\r
  99  */\r
 100 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 101 {\r
 102 xComPortHandle xReturn = serHANDLE;\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                 PMC_EnablePeripheral( AT91C_ID_US0 );   \r
 113                 portENTER_CRITICAL();\r
 114                 {\r
 115                         USART_Configure( serCOM0, ( AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE ), ulWantedBaud, configCPU_CLOCK_HZ );\r
 116 \r
 117                         /* Enable Rx and Tx. */\r
 118                         USART_SetTransmitterEnabled( serCOM0, pdTRUE );\r
 119                         USART_SetReceiverEnabled( serCOM0, pdTRUE );\r
 120 \r
 121                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 122                         until there are characters to be transmitted. */\r
 123                         serCOM0->US_IER = AT91C_US_RXRDY;\r
 124 \r
 125                         /* Enable the interrupts in the AIC. */\r
 126                         AIC_ConfigureIT( AT91C_ID_US0, AT91C_AIC_PRIOR_LOWEST, ( void (*)( void ) ) vSerialISR );\r
 127                         AIC_EnableIT( AT91C_ID_US0 );\r
 128                 }\r
 129                 portEXIT_CRITICAL();\r
 130         }\r
 131         else\r
 132         {\r
 133                 xReturn = ( xComPortHandle ) 0;\r
 134         }\r
 135 \r
 136         /* This demo file only supports a single port but we have to return\r
 137         something to comply with the standard demo header file. */\r
 138         return xReturn;\r
 139 }\r
 140 /*-----------------------------------------------------------*/\r
 141 \r
 142 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 143 {\r
 144         /* The port handle is not required as this driver only supports one port. */\r
 145         ( void ) pxPort;\r
 146 \r
 147         /* Get the next character from the buffer.  Return false if no characters\r
 148         are available, or arrive before xBlockTime expires. */\r
 149         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 150         {\r
 151                 return pdTRUE;\r
 152         }\r
 153         else\r
 154         {\r
 155                 return pdFALSE;\r
 156         }\r
 157 }\r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 161 {\r
 162 signed portCHAR *pxNext;\r
 163 \r
 164         /* A couple of parameters that this port does not use. */\r
 165         ( void ) usStringLength;\r
 166         ( void ) pxPort;\r
 167 \r
 168         /* NOTE: This implementation does not handle the queue being full as no\r
 169         block time is used! */\r
 170 \r
 171         /* The port handle is not required as this driver only supports UART0. */\r
 172         ( void ) pxPort;\r
 173 \r
 174         /* Send each character in the string, one at a time. */\r
 175         pxNext = ( signed portCHAR * ) pcString;\r
 176         while( *pxNext )\r
 177         {\r
 178                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 179                 pxNext++;\r
 180         }\r
 181 }\r
 182 /*-----------------------------------------------------------*/\r
 183 \r
 184 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 185 {\r
 186         /* Just to remove compiler warning. */\r
 187         ( void ) pxPort;\r
 188         \r
 189         /* Place the character in the queue of characters to be transmitted. */\r
 190         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 191         {\r
 192                 return pdFAIL;\r
 193         }\r
 194 \r
 195         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 196         queue and send it.   This does not need to be in a critical section as\r
 197         if the interrupt has already removed the character the next interrupt\r
 198         will simply turn off the Tx interrupt again. */\r
 199         vInterruptOn();\r
 200 \r
 201         return pdPASS;\r
 202 }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 void vSerialClose( xComPortHandle xPort )\r
 206 {\r
 207         /* Not supported as not required by the demo application. */\r
 208         ( void ) xPort;\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 xHigherPriorityTaskWoken = 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, &xHigherPriorityTaskWoken ) == 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                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\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( xHigherPriorityTaskWoken );\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