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

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