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

   1 /*\r
   2     FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  77 */\r
  78 \r
  79 /* Standard includes. */\r
  80 #include <stdlib.h>\r
  81 \r
  82 /* Scheduler includes. */\r
  83 #include "FreeRTOS.h"\r
  84 #include "queue.h"\r
  85 \r
  86 /* Demo application includes. */\r
  87 #include "serial.h"\r
  88 \r
  89 /* Atmel library includes. */\r
  90 #include <usart/usart.h>\r
  91 #include <aic/aic.h>\r
  92 #include <pmc/pmc.h>\r
  93 \r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 /* Location of the COM0 registers. */\r
  97 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  98 \r
  99 /* Interrupt control macros. */\r
 100 #define serINTERRUPT_LEVEL                              ( 5 )\r
 101 #define vInterruptOn()                                  serCOM0->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
 102 #define vInterruptOff()                                 serCOM0->US_IDR = AT91C_US_TXRDY\r
 103 \r
 104 /* Misc constants. */\r
 105 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
 106 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 107 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
 108 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
 109 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
 110 \r
 111 \r
 112 /* Queues used to hold received characters, and characters waiting to be\r
 113 transmitted. */\r
 114 static xQueueHandle xRxedChars;\r
 115 static xQueueHandle xCharsForTx;\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 /* The interrupt service routine. */\r
 120 __arm void vSerialISR( void );\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 /*\r
 125  * See the serial2.h header file.\r
 126  */\r
 127 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 128 {\r
 129 xComPortHandle xReturn = serHANDLE;\r
 130 \r
 131         /* Create the queues used to hold Rx and Tx characters. */\r
 132         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 133         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 134 \r
 135         /* If the queues were created correctly then setup the serial port\r
 136         hardware. */\r
 137         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 138         {\r
 139                 PMC_EnablePeripheral( AT91C_ID_US0 );   \r
 140                 portENTER_CRITICAL();\r
 141                 {\r
 142                         USART_Configure( serCOM0, ( AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE ), ulWantedBaud, configCPU_CLOCK_HZ );\r
 143 \r
 144                         /* Enable Rx and Tx. */\r
 145                         USART_SetTransmitterEnabled( serCOM0, pdTRUE );\r
 146                         USART_SetReceiverEnabled( serCOM0, pdTRUE );\r
 147 \r
 148                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 149                         until there are characters to be transmitted. */\r
 150                         serCOM0->US_IER = AT91C_US_RXRDY;\r
 151 \r
 152                         /* Enable the interrupts in the AIC. */\r
 153                         AIC_ConfigureIT( AT91C_ID_US0, AT91C_AIC_PRIOR_LOWEST, ( void (*)( void ) ) vSerialISR );\r
 154                         AIC_EnableIT( AT91C_ID_US0 );\r
 155                 }\r
 156                 portEXIT_CRITICAL();\r
 157         }\r
 158         else\r
 159         {\r
 160                 xReturn = ( xComPortHandle ) 0;\r
 161         }\r
 162 \r
 163         /* This demo file only supports a single port but we have to return\r
 164         something to comply with the standard demo header file. */\r
 165         return xReturn;\r
 166 }\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 170 {\r
 171         /* The port handle is not required as this driver only supports one port. */\r
 172         ( void ) pxPort;\r
 173 \r
 174         /* Get the next character from the buffer.  Return false if no characters\r
 175         are available, or arrive before xBlockTime expires. */\r
 176         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 177         {\r
 178                 return pdTRUE;\r
 179         }\r
 180         else\r
 181         {\r
 182                 return pdFALSE;\r
 183         }\r
 184 }\r
 185 /*-----------------------------------------------------------*/\r
 186 \r
 187 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 188 {\r
 189 signed char *pxNext;\r
 190 \r
 191         /* A couple of parameters that this port does not use. */\r
 192         ( void ) usStringLength;\r
 193         ( void ) pxPort;\r
 194 \r
 195         /* NOTE: This implementation does not handle the queue being full as no\r
 196         block time is used! */\r
 197 \r
 198         /* The port handle is not required as this driver only supports UART0. */\r
 199         ( void ) pxPort;\r
 200 \r
 201         /* Send each character in the string, one at a time. */\r
 202         pxNext = ( signed char * ) pcString;\r
 203         while( *pxNext )\r
 204         {\r
 205                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 206                 pxNext++;\r
 207         }\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 212 {\r
 213         /* Just to remove compiler warning. */\r
 214         ( void ) pxPort;\r
 215         \r
 216         /* Place the character in the queue of characters to be transmitted. */\r
 217         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 218         {\r
 219                 return pdFAIL;\r
 220         }\r
 221 \r
 222         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 223         queue and send it.   This does not need to be in a critical section as\r
 224         if the interrupt has already removed the character the next interrupt\r
 225         will simply turn off the Tx interrupt again. */\r
 226         vInterruptOn();\r
 227 \r
 228         return pdPASS;\r
 229 }\r
 230 /*-----------------------------------------------------------*/\r
 231 \r
 232 void vSerialClose( xComPortHandle xPort )\r
 233 {\r
 234         /* Not supported as not required by the demo application. */\r
 235         ( void ) xPort;\r
 236 }\r
 237 /*-----------------------------------------------------------*/\r
 238 \r
 239 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 240 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 241 within serialISR.s79 which in turn calls this function.  See the port\r
 242 documentation on the FreeRTOS.org website for more information. */\r
 243 __arm void vSerialISR( void )\r
 244 {\r
 245 unsigned long ulStatus;\r
 246 signed char cChar;\r
 247 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 248 \r
 249         /* What caused the interrupt? */\r
 250         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 251 \r
 252         if( ulStatus & AT91C_US_TXRDY )\r
 253         {\r
 254                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 255                 more characters to transmit? */\r
 256                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 257                 {\r
 258                         /* A character was retrieved from the queue so can be sent to the\r
 259                         THR now. */\r
 260                         serCOM0->US_THR = cChar;\r
 261                 }\r
 262                 else\r
 263                 {\r
 264                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 265                         vInterruptOff();\r
 266                 }               \r
 267         }\r
 268 \r
 269         if( ulStatus & AT91C_US_RXRDY )\r
 270         {\r
 271                 /* The interrupt was caused by a character being received.  Grab the\r
 272                 character from the RHR and place it in the queue or received\r
 273                 characters. */\r
 274                 cChar = serCOM0->US_RHR;\r
 275                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 276         }\r
 277 \r
 278         /* If a task was woken by either a character being received or a character\r
 279         being transmitted then we may need to switch to another task. */\r
 280         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 281 \r
 282         /* End the interrupt in the AIC. */\r
 283         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 284 }\r
 285 \r
 286 \r
 287 \r
 288 \r
 289         \r