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

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