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

   1 /*\r
   2     FreeRTOS V8.0.0:rc1 - 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /* \r
  67         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  68 */\r
  69 \r
  70 /* Standard includes. */ \r
  71 #include <stdlib.h>\r
  72 \r
  73 /* Scheduler includes. */\r
  74 #include "FreeRTOS.h"\r
  75 #include "queue.h"\r
  76 \r
  77 /* Demo application includes. */\r
  78 #include "serial.h"\r
  79 \r
  80 /*-----------------------------------------------------------*/\r
  81 \r
  82 /* Location of the COM0 registers. */\r
  83 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  84 \r
  85 /* Interrupt control macros. */\r
  86 #define serINTERRUPT_LEVEL                              ( 5 )\r
  87 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  88 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  89 \r
  90 /* Misc constants. */\r
  91 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  92 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  93 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  94 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  95 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  96 \r
  97 \r
  98 /* Queues used to hold received characters, and characters waiting to be\r
  99 transmitted. */\r
 100 static QueueHandle_t xRxedChars; \r
 101 static QueueHandle_t xCharsForTx; \r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
 106 extern void vSerialISREntry( void );\r
 107 \r
 108 /* The interrupt service routine - called from the assembly entry point. */\r
 109 __arm void vSerialISR( void );\r
 110 \r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 /*\r
 114  * See the serial2.h header file.\r
 115  */\r
 116 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 117 {\r
 118 xComPortHandle xReturn = serHANDLE;\r
 119 extern void ( vUART_ISR )( void );\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                 portENTER_CRITICAL();\r
 130                 {\r
 131                         /* Enable the USART clock. */\r
 132                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
 133 \r
 134                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned long ) AT91C_PA5_RXD0 ) | ( ( unsigned long ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
 135 \r
 136                         /* Set the required protocol. */\r
 137                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 138 \r
 139                         /* Enable Rx and Tx. */\r
 140                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\r
 141 \r
 142                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 143                         until there are characters to be transmitted. */\r
 144                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 145 \r
 146                         /* Enable the interrupts in the AIC. */\r
 147                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 148                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, AT91C_ID_US0 );\r
 149                 }\r
 150                 portEXIT_CRITICAL();\r
 151         }\r
 152         else\r
 153         {\r
 154                 xReturn = ( xComPortHandle ) 0;\r
 155         }\r
 156 \r
 157         /* This demo file only supports a single port but we have to return \r
 158         something to comply with the standard demo header file. */\r
 159         return xReturn;\r
 160 }\r
 161 /*-----------------------------------------------------------*/\r
 162 \r
 163 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 164 {\r
 165         /* The port handle is not required as this driver only supports one port. */\r
 166         ( void ) pxPort;\r
 167 \r
 168         /* Get the next character from the buffer.  Return false if no characters\r
 169         are available, or arrive before xBlockTime expires. */\r
 170         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 171         {\r
 172                 return pdTRUE;\r
 173         }\r
 174         else\r
 175         {\r
 176                 return pdFALSE;\r
 177         }\r
 178 }\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 182 {\r
 183 signed char *pxNext;\r
 184 \r
 185         /* A couple of parameters that this port does not use. */\r
 186         ( void ) usStringLength;\r
 187         ( void ) pxPort;\r
 188 \r
 189         /* NOTE: This implementation does not handle the queue being full as no\r
 190         block time is used! */\r
 191 \r
 192         /* The port handle is not required as this driver only supports UART0. */\r
 193         ( void ) pxPort;\r
 194 \r
 195         /* Send each character in the string, one at a time. */\r
 196         pxNext = ( signed char * ) pcString;\r
 197         while( *pxNext )\r
 198         {\r
 199                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 200                 pxNext++;\r
 201         }\r
 202 }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 206 {\r
 207         /* Place the character in the queue of characters to be transmitted. */\r
 208         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 209         {\r
 210                 return pdFAIL;\r
 211         }\r
 212 \r
 213         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 214         queue and send it.   This does not need to be in a critical section as\r
 215         if the interrupt has already removed the character the next interrupt\r
 216         will simply turn off the Tx interrupt again. */\r
 217         vInterruptOn();\r
 218 \r
 219         return pdPASS;\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 void vSerialClose( xComPortHandle xPort )\r
 224 {\r
 225         /* Not supported as not required by the demo application. */\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