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

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /* \r
  68         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  69 */\r
  70 \r
  71 /* Standard includes. */ \r
  72 #include <stdlib.h>\r
  73 \r
  74 /* Scheduler includes. */\r
  75 #include "FreeRTOS.h"\r
  76 #include "queue.h"\r
  77 \r
  78 /* Demo application includes. */\r
  79 #include "serial.h"\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /* Location of the COM0 registers. */\r
  84 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  85 \r
  86 /* Interrupt control macros. */\r
  87 #define serINTERRUPT_LEVEL                              ( 5 )\r
  88 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  89 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  90 \r
  91 /* Misc constants. */\r
  92 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  93 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  94 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  95 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  96 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  97 \r
  98 \r
  99 /* Queues used to hold received characters, and characters waiting to be\r
 100 transmitted. */\r
 101 static xQueueHandle xRxedChars; \r
 102 static xQueueHandle xCharsForTx; \r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
 107 extern void vSerialISREntry( void );\r
 108 \r
 109 /* The interrupt service routine - called from the assembly entry point. */\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 extern void ( vUART_ISR )( void );\r
 121 \r
 122         /* Create the queues used to hold Rx and Tx characters. */\r
 123         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 124         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 125 \r
 126         /* If the queues were created correctly then setup the serial port \r
 127         hardware. */\r
 128         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 129         {\r
 130                 portENTER_CRITICAL();\r
 131                 {\r
 132                         /* Enable the USART clock. */\r
 133                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
 134 \r
 135                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned long ) AT91C_PA5_RXD0 ) | ( ( unsigned long ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
 136 \r
 137                         /* Set the required protocol. */\r
 138                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 139 \r
 140                         /* Enable Rx and Tx. */\r
 141                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\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                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 146 \r
 147                         /* Enable the interrupts in the AIC. */\r
 148                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 149                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, 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, portTickType 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, portTickType xBlockTime )\r
 207 {\r
 208         /* Place the character in the queue of characters to be transmitted. */\r
 209         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 210         {\r
 211                 return pdFAIL;\r
 212         }\r
 213 \r
 214         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 215         queue and send it.   This does not need to be in a critical section as\r
 216         if the interrupt has already removed the character the next interrupt\r
 217         will simply turn off the Tx interrupt again. */\r
 218         vInterruptOn();\r
 219 \r
 220         return pdPASS;\r
 221 }\r
 222 /*-----------------------------------------------------------*/\r
 223 \r
 224 void vSerialClose( xComPortHandle xPort )\r
 225 {\r
 226         /* Not supported as not required by the demo application. */\r
 227 }\r
 228 /*-----------------------------------------------------------*/\r
 229 \r
 230 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 231 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 232 within serialISR.s79 which in turn calls this function.  See the port\r
 233 documentation on the FreeRTOS.org website for more information. */\r
 234 __arm void vSerialISR( void )\r
 235 {\r
 236 unsigned long ulStatus;\r
 237 signed char cChar;\r
 238 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 239 \r
 240         /* What caused the interrupt? */\r
 241         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 242 \r
 243         if( ulStatus & AT91C_US_TXRDY )\r
 244         {\r
 245                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 246                 more characters to transmit? */\r
 247                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 248                 {\r
 249                         /* A character was retrieved from the queue so can be sent to the\r
 250                         THR now. */\r
 251                         serCOM0->US_THR = cChar;\r
 252                 }\r
 253                 else\r
 254                 {\r
 255                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 256                         vInterruptOff();\r
 257                 }               \r
 258         }\r
 259 \r
 260         if( ulStatus & AT91C_US_RXRDY )\r
 261         {\r
 262                 /* The interrupt was caused by a character being received.  Grab the\r
 263                 character from the RHR and place it in the queue or received \r
 264                 characters. */\r
 265                 cChar = serCOM0->US_RHR;\r
 266                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 267         }\r
 268 \r
 269         /* If a task was woken by either a character being received or a character \r
 270         being transmitted then we may need to switch to another task. */\r
 271         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 272 \r
 273         /* End the interrupt in the AIC. */\r
 274         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 275 }\r
 276 \r
 277 \r
 278 \r
 279 \r
 280         \r