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

   1 /*\r
   2         FreeRTOS.org V4.8.0 - 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     *                                                                         *\r
  29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
  30     * and even write all or part of your application on your behalf.          *\r
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
  32     * expedite your project.                                                  *\r
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 /* \r
  51         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  52 */\r
  53 \r
  54 /* Standard includes. */ \r
  55 #include <stdlib.h>\r
  56 \r
  57 /* Scheduler includes. */\r
  58 #include "FreeRTOS.h"\r
  59 #include "queue.h"\r
  60 \r
  61 /* Demo application includes. */\r
  62 #include "serial.h"\r
  63 \r
  64 /*-----------------------------------------------------------*/\r
  65 \r
  66 /* Location of the COM0 registers. */\r
  67 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  68 \r
  69 /* Interrupt control macros. */\r
  70 #define serINTERRUPT_LEVEL                              ( 5 )\r
  71 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  72 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  73 \r
  74 /* Misc constants. */\r
  75 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  76 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  77 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  78 #define serNO_TIMEGUARD                                 ( ( unsigned portLONG ) 0 )\r
  79 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned portLONG ) 0 )\r
  80 \r
  81 \r
  82 /* Queues used to hold received characters, and characters waiting to be\r
  83 transmitted. */\r
  84 static xQueueHandle xRxedChars; \r
  85 static xQueueHandle xCharsForTx; \r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
  90 extern void vSerialISREntry( void );\r
  91 \r
  92 /* The interrupt service routine - called from the assembly entry point. */\r
  93 __arm void vSerialISR( void );\r
  94 \r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 /*\r
  98  * See the serial2.h header file.\r
  99  */\r
 100 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 101 {\r
 102 xComPortHandle xReturn = serHANDLE;\r
 103 extern void ( vUART_ISR )( void );\r
 104 \r
 105         /* Create the queues used to hold Rx and Tx characters. */\r
 106         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 107         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\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                 portENTER_CRITICAL();\r
 114                 {\r
 115                         /* Enable the USART clock. */\r
 116                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
 117 \r
 118                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned portLONG ) AT91C_PA5_RXD0 ) | ( ( unsigned portLONG ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
 119 \r
 120                         /* Set the required protocol. */\r
 121                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 122 \r
 123                         /* Enable Rx and Tx. */\r
 124                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\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                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 129 \r
 130                         /* Enable the interrupts in the AIC. */\r
 131                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 132                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, 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         /* Place the character in the queue of characters to be transmitted. */\r
 192         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 193         {\r
 194                 return pdFAIL;\r
 195         }\r
 196 \r
 197         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 198         queue and send it.   This does not need to be in a critical section as\r
 199         if the interrupt has already removed the character the next interrupt\r
 200         will simply turn off the Tx interrupt again. */\r
 201         vInterruptOn();\r
 202 \r
 203         return pdPASS;\r
 204 }\r
 205 /*-----------------------------------------------------------*/\r
 206 \r
 207 void vSerialClose( xComPortHandle xPort )\r
 208 {\r
 209         /* Not supported as not required by the demo application. */\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 portLONG ulStatus;\r
 220 signed portCHAR 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