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

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