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

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