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

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