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

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