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

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