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

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