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

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