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

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 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     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 /*\r
  54         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\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 \r
  64 /* Demo application includes. */\r
  65 #include "serial.h"\r
  66 \r
  67 /* Atmel library includes. */\r
  68 #include <usart/usart.h>\r
  69 #include <aic/aic.h>\r
  70 #include <pmc/pmc.h>\r
  71 \r
  72 /*-----------------------------------------------------------*/\r
  73 \r
  74 /* Location of the COM0 registers. */\r
  75 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  76 \r
  77 /* Interrupt control macros. */\r
  78 #define serINTERRUPT_LEVEL                              ( 5 )\r
  79 #define vInterruptOn()                                  serCOM0->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  80 #define vInterruptOff()                                 serCOM0->US_IDR = AT91C_US_TXRDY\r
  81 \r
  82 /* Misc constants. */\r
  83 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  84 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  85 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  86 #define serNO_TIMEGUARD                                 ( ( unsigned portLONG ) 0 )\r
  87 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned portLONG ) 0 )\r
  88 \r
  89 \r
  90 /* Queues used to hold received characters, and characters waiting to be\r
  91 transmitted. */\r
  92 static xQueueHandle xRxedChars;\r
  93 static xQueueHandle xCharsForTx;\r
  94 \r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 /* The interrupt service routine. */\r
  98 __arm void vSerialISR( void );\r
  99 \r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /*\r
 103  * See the serial2.h header file.\r
 104  */\r
 105 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 106 {\r
 107 xComPortHandle xReturn = serHANDLE;\r
 108 \r
 109         /* Create the queues used to hold Rx and Tx characters. */\r
 110         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 111         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 112 \r
 113         /* If the queues were created correctly then setup the serial port\r
 114         hardware. */\r
 115         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 116         {\r
 117                 PMC_EnablePeripheral( AT91C_ID_US0 );   \r
 118                 portENTER_CRITICAL();\r
 119                 {\r
 120                         USART_Configure( serCOM0, ( AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE ), ulWantedBaud, configCPU_CLOCK_HZ );\r
 121 \r
 122                         /* Enable Rx and Tx. */\r
 123                         USART_SetTransmitterEnabled( serCOM0, pdTRUE );\r
 124                         USART_SetReceiverEnabled( serCOM0, pdTRUE );\r
 125 \r
 126                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 127                         until there are characters to be transmitted. */\r
 128                         serCOM0->US_IER = AT91C_US_RXRDY;\r
 129 \r
 130                         /* Enable the interrupts in the AIC. */\r
 131                         AIC_ConfigureIT( AT91C_ID_US0, AT91C_AIC_PRIOR_LOWEST, ( void (*)( void ) ) vSerialISR );\r
 132                         AIC_EnableIT( AT91C_ID_US0 );\r
 133                 }\r
 134                 portEXIT_CRITICAL();\r
 135         }\r
 136         else\r
 137         {\r
 138                 xReturn = ( xComPortHandle ) 0;\r
 139         }\r
 140 \r
 141         /* This demo file only supports a single port but we have to return\r
 142         something to comply with the standard demo header file. */\r
 143         return xReturn;\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 148 {\r
 149         /* The port handle is not required as this driver only supports one port. */\r
 150         ( void ) pxPort;\r
 151 \r
 152         /* Get the next character from the buffer.  Return false if no characters\r
 153         are available, or arrive before xBlockTime expires. */\r
 154         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 155         {\r
 156                 return pdTRUE;\r
 157         }\r
 158         else\r
 159         {\r
 160                 return pdFALSE;\r
 161         }\r
 162 }\r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 166 {\r
 167 signed portCHAR *pxNext;\r
 168 \r
 169         /* A couple of parameters that this port does not use. */\r
 170         ( void ) usStringLength;\r
 171         ( void ) pxPort;\r
 172 \r
 173         /* NOTE: This implementation does not handle the queue being full as no\r
 174         block time is used! */\r
 175 \r
 176         /* The port handle is not required as this driver only supports UART0. */\r
 177         ( void ) pxPort;\r
 178 \r
 179         /* Send each character in the string, one at a time. */\r
 180         pxNext = ( signed portCHAR * ) pcString;\r
 181         while( *pxNext )\r
 182         {\r
 183                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 184                 pxNext++;\r
 185         }\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 190 {\r
 191         /* Just to remove compiler warning. */\r
 192         ( void ) pxPort;\r
 193         \r
 194         /* Place the character in the queue of characters to be transmitted. */\r
 195         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 196         {\r
 197                 return pdFAIL;\r
 198         }\r
 199 \r
 200         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 201         queue and send it.   This does not need to be in a critical section as\r
 202         if the interrupt has already removed the character the next interrupt\r
 203         will simply turn off the Tx interrupt again. */\r
 204         vInterruptOn();\r
 205 \r
 206         return pdPASS;\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 void vSerialClose( xComPortHandle xPort )\r
 211 {\r
 212         /* Not supported as not required by the demo application. */\r
 213         ( void ) xPort;\r
 214 }\r
 215 /*-----------------------------------------------------------*/\r
 216 \r
 217 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 218 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 219 within serialISR.s79 which in turn calls this function.  See the port\r
 220 documentation on the FreeRTOS.org website for more information. */\r
 221 __arm void vSerialISR( void )\r
 222 {\r
 223 unsigned portLONG ulStatus;\r
 224 signed portCHAR cChar;\r
 225 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 226 \r
 227         /* What caused the interrupt? */\r
 228         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 229 \r
 230         if( ulStatus & AT91C_US_TXRDY )\r
 231         {\r
 232                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 233                 more characters to transmit? */\r
 234                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 235                 {\r
 236                         /* A character was retrieved from the queue so can be sent to the\r
 237                         THR now. */\r
 238                         serCOM0->US_THR = cChar;\r
 239                 }\r
 240                 else\r
 241                 {\r
 242                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 243                         vInterruptOff();\r
 244                 }               \r
 245         }\r
 246 \r
 247         if( ulStatus & AT91C_US_RXRDY )\r
 248         {\r
 249                 /* The interrupt was caused by a character being received.  Grab the\r
 250                 character from the RHR and place it in the queue or received\r
 251                 characters. */\r
 252                 cChar = serCOM0->US_RHR;\r
 253                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 254         }\r
 255 \r
 256         /* If a task was woken by either a character being received or a character\r
 257         being transmitted then we may need to switch to another task. */\r
 258         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 259 \r
 260         /* End the interrupt in the AIC. */\r
 261         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 262 }\r
 263 \r
 264 \r
 265 \r
 266 \r
 267         \r