git.sur5r.net Git - freertos/blob - Demo/ARM9_AT91SAM9XE_IAR/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 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 /* Atmel library includes. */\r
  64 #include <usart/usart.h>\r
  65 #include <aic/aic.h>\r
  66 #include <pmc/pmc.h>\r
  67 \r
  68 /*-----------------------------------------------------------*/\r
  69 \r
  70 /* Location of the COM0 registers. */\r
  71 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  72 \r
  73 /* Interrupt control macros. */\r
  74 #define serINTERRUPT_LEVEL                              ( 5 )\r
  75 #define vInterruptOn()                                  serCOM0->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  76 #define vInterruptOff()                                 serCOM0->US_IDR = AT91C_US_TXRDY\r
  77 \r
  78 /* Misc constants. */\r
  79 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  80 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  81 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  82 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  83 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  84 \r
  85 \r
  86 /* Queues used to hold received characters, and characters waiting to be\r
  87 transmitted. */\r
  88 static xQueueHandle xRxedChars;\r
  89 static xQueueHandle xCharsForTx;\r
  90 \r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 /* The interrupt service routine. */\r
  94 __arm void vSerialISR( void );\r
  95 \r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 /*\r
  99  * See the serial2.h header file.\r
 100  */\r
 101 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 102 {\r
 103 xComPortHandle xReturn = serHANDLE;\r
 104 \r
 105         /* Create the queues used to hold Rx and Tx characters. */\r
 106         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 107         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 108 \r
 109         /* If the queues were created correctly then setup the serial port\r
 110         hardware. */\r
 111         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 112         {\r
 113                 PMC_EnablePeripheral( AT91C_ID_US0 );   \r
 114                 portENTER_CRITICAL();\r
 115                 {\r
 116                         USART_Configure( serCOM0, ( AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE ), ulWantedBaud, configCPU_CLOCK_HZ );\r
 117 \r
 118                         /* Enable Rx and Tx. */\r
 119                         USART_SetTransmitterEnabled( serCOM0, pdTRUE );\r
 120                         USART_SetReceiverEnabled( serCOM0, pdTRUE );\r
 121 \r
 122                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 123                         until there are characters to be transmitted. */\r
 124                         serCOM0->US_IER = AT91C_US_RXRDY;\r
 125 \r
 126                         /* Enable the interrupts in the AIC. */\r
 127                         AIC_ConfigureIT( AT91C_ID_US0, AT91C_AIC_PRIOR_LOWEST, ( void (*)( void ) ) vSerialISR );\r
 128                         AIC_EnableIT( AT91C_ID_US0 );\r
 129                 }\r
 130                 portEXIT_CRITICAL();\r
 131         }\r
 132         else\r
 133         {\r
 134                 xReturn = ( xComPortHandle ) 0;\r
 135         }\r
 136 \r
 137         /* This demo file only supports a single port but we have to return\r
 138         something to comply with the standard demo header file. */\r
 139         return xReturn;\r
 140 }\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 144 {\r
 145         /* The port handle is not required as this driver only supports one port. */\r
 146         ( void ) pxPort;\r
 147 \r
 148         /* Get the next character from the buffer.  Return false if no characters\r
 149         are available, or arrive before xBlockTime expires. */\r
 150         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 151         {\r
 152                 return pdTRUE;\r
 153         }\r
 154         else\r
 155         {\r
 156                 return pdFALSE;\r
 157         }\r
 158 }\r
 159 /*-----------------------------------------------------------*/\r
 160 \r
 161 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 162 {\r
 163 signed char *pxNext;\r
 164 \r
 165         /* A couple of parameters that this port does not use. */\r
 166         ( void ) usStringLength;\r
 167         ( void ) pxPort;\r
 168 \r
 169         /* NOTE: This implementation does not handle the queue being full as no\r
 170         block time is used! */\r
 171 \r
 172         /* The port handle is not required as this driver only supports UART0. */\r
 173         ( void ) pxPort;\r
 174 \r
 175         /* Send each character in the string, one at a time. */\r
 176         pxNext = ( signed char * ) pcString;\r
 177         while( *pxNext )\r
 178         {\r
 179                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 180                 pxNext++;\r
 181         }\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 186 {\r
 187         /* Just to remove compiler warning. */\r
 188         ( void ) pxPort;\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         ( void ) xPort;\r
 210 }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 214 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 215 within serialISR.s79 which in turn calls this function.  See the port\r
 216 documentation on the FreeRTOS.org website for more information. */\r
 217 __arm void vSerialISR( void )\r
 218 {\r
 219 unsigned long ulStatus;\r
 220 signed char cChar;\r
 221 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 222 \r
 223         /* What caused the interrupt? */\r
 224         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 225 \r
 226         if( ulStatus & AT91C_US_TXRDY )\r
 227         {\r
 228                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 229                 more characters to transmit? */\r
 230                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 231                 {\r
 232                         /* A character was retrieved from the queue so can be sent to the\r
 233                         THR now. */\r
 234                         serCOM0->US_THR = cChar;\r
 235                 }\r
 236                 else\r
 237                 {\r
 238                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 239                         vInterruptOff();\r
 240                 }               \r
 241         }\r
 242 \r
 243         if( ulStatus & AT91C_US_RXRDY )\r
 244         {\r
 245                 /* The interrupt was caused by a character being received.  Grab the\r
 246                 character from the RHR and place it in the queue or received\r
 247                 characters. */\r
 248                 cChar = serCOM0->US_RHR;\r
 249                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 250         }\r
 251 \r
 252         /* If a task was woken by either a character being received or a character\r
 253         being transmitted then we may need to switch to another task. */\r
 254         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 255 \r
 256         /* End the interrupt in the AIC. */\r
 257         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 258 }\r
 259 \r
 260 \r
 261 \r
 262 \r
 263         \r