begriffs open source - freertos/blob - Demo/ARM9_AT91SAM9XE_IAR/serial/serial.c

   1 /*\r
   2     FreeRTOS V6.0.4 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 /*\r
  55         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  56 */\r
  57 \r
  58 /* Standard includes. */\r
  59 #include <stdlib.h>\r
  60 \r
  61 /* Scheduler includes. */\r
  62 #include "FreeRTOS.h"\r
  63 #include "queue.h"\r
  64 \r
  65 /* Demo application includes. */\r
  66 #include "serial.h"\r
  67 \r
  68 /* Atmel library includes. */\r
  69 #include <usart/usart.h>\r
  70 #include <aic/aic.h>\r
  71 #include <pmc/pmc.h>\r
  72 \r
  73 /*-----------------------------------------------------------*/\r
  74 \r
  75 /* Location of the COM0 registers. */\r
  76 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  77 \r
  78 /* Interrupt control macros. */\r
  79 #define serINTERRUPT_LEVEL                              ( 5 )\r
  80 #define vInterruptOn()                                  serCOM0->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  81 #define vInterruptOff()                                 serCOM0->US_IDR = AT91C_US_TXRDY\r
  82 \r
  83 /* Misc constants. */\r
  84 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  85 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  86 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  87 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  88 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  89 \r
  90 \r
  91 /* Queues used to hold received characters, and characters waiting to be\r
  92 transmitted. */\r
  93 static xQueueHandle xRxedChars;\r
  94 static xQueueHandle xCharsForTx;\r
  95 \r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 /* The interrupt service routine. */\r
  99 __arm void vSerialISR( void );\r
 100 \r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 /*\r
 104  * See the serial2.h header file.\r
 105  */\r
 106 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 107 {\r
 108 xComPortHandle xReturn = serHANDLE;\r
 109 \r
 110         /* Create the queues used to hold Rx and Tx characters. */\r
 111         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 112         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 113 \r
 114         /* If the queues were created correctly then setup the serial port\r
 115         hardware. */\r
 116         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 117         {\r
 118                 PMC_EnablePeripheral( AT91C_ID_US0 );   \r
 119                 portENTER_CRITICAL();\r
 120                 {\r
 121                         USART_Configure( serCOM0, ( AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE ), ulWantedBaud, configCPU_CLOCK_HZ );\r
 122 \r
 123                         /* Enable Rx and Tx. */\r
 124                         USART_SetTransmitterEnabled( serCOM0, pdTRUE );\r
 125                         USART_SetReceiverEnabled( serCOM0, pdTRUE );\r
 126 \r
 127                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 128                         until there are characters to be transmitted. */\r
 129                         serCOM0->US_IER = AT91C_US_RXRDY;\r
 130 \r
 131                         /* Enable the interrupts in the AIC. */\r
 132                         AIC_ConfigureIT( AT91C_ID_US0, AT91C_AIC_PRIOR_LOWEST, ( void (*)( void ) ) vSerialISR );\r
 133                         AIC_EnableIT( AT91C_ID_US0 );\r
 134                 }\r
 135                 portEXIT_CRITICAL();\r
 136         }\r
 137         else\r
 138         {\r
 139                 xReturn = ( xComPortHandle ) 0;\r
 140         }\r
 141 \r
 142         /* This demo file only supports a single port but we have to return\r
 143         something to comply with the standard demo header file. */\r
 144         return xReturn;\r
 145 }\r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 149 {\r
 150         /* The port handle is not required as this driver only supports one port. */\r
 151         ( void ) pxPort;\r
 152 \r
 153         /* Get the next character from the buffer.  Return false if no characters\r
 154         are available, or arrive before xBlockTime expires. */\r
 155         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 156         {\r
 157                 return pdTRUE;\r
 158         }\r
 159         else\r
 160         {\r
 161                 return pdFALSE;\r
 162         }\r
 163 }\r
 164 /*-----------------------------------------------------------*/\r
 165 \r
 166 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 167 {\r
 168 signed char *pxNext;\r
 169 \r
 170         /* A couple of parameters that this port does not use. */\r
 171         ( void ) usStringLength;\r
 172         ( void ) pxPort;\r
 173 \r
 174         /* NOTE: This implementation does not handle the queue being full as no\r
 175         block time is used! */\r
 176 \r
 177         /* The port handle is not required as this driver only supports UART0. */\r
 178         ( void ) pxPort;\r
 179 \r
 180         /* Send each character in the string, one at a time. */\r
 181         pxNext = ( signed char * ) pcString;\r
 182         while( *pxNext )\r
 183         {\r
 184                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 185                 pxNext++;\r
 186         }\r
 187 }\r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 191 {\r
 192         /* Just to remove compiler warning. */\r
 193         ( void ) pxPort;\r
 194         \r
 195         /* Place the character in the queue of characters to be transmitted. */\r
 196         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 197         {\r
 198                 return pdFAIL;\r
 199         }\r
 200 \r
 201         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 202         queue and send it.   This does not need to be in a critical section as\r
 203         if the interrupt has already removed the character the next interrupt\r
 204         will simply turn off the Tx interrupt again. */\r
 205         vInterruptOn();\r
 206 \r
 207         return pdPASS;\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 void vSerialClose( xComPortHandle xPort )\r
 212 {\r
 213         /* Not supported as not required by the demo application. */\r
 214         ( void ) xPort;\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 219 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 220 within serialISR.s79 which in turn calls this function.  See the port\r
 221 documentation on the FreeRTOS.org website for more information. */\r
 222 __arm void vSerialISR( void )\r
 223 {\r
 224 unsigned long ulStatus;\r
 225 signed char cChar;\r
 226 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 227 \r
 228         /* What caused the interrupt? */\r
 229         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 230 \r
 231         if( ulStatus & AT91C_US_TXRDY )\r
 232         {\r
 233                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 234                 more characters to transmit? */\r
 235                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 236                 {\r
 237                         /* A character was retrieved from the queue so can be sent to the\r
 238                         THR now. */\r
 239                         serCOM0->US_THR = cChar;\r
 240                 }\r
 241                 else\r
 242                 {\r
 243                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 244                         vInterruptOff();\r
 245                 }               \r
 246         }\r
 247 \r
 248         if( ulStatus & AT91C_US_RXRDY )\r
 249         {\r
 250                 /* The interrupt was caused by a character being received.  Grab the\r
 251                 character from the RHR and place it in the queue or received\r
 252                 characters. */\r
 253                 cChar = serCOM0->US_RHR;\r
 254                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 255         }\r
 256 \r
 257         /* If a task was woken by either a character being received or a character\r
 258         being transmitted then we may need to switch to another task. */\r
 259         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 260 \r
 261         /* End the interrupt in the AIC. */\r
 262         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 263 }\r
 264 \r
 265 \r
 266 \r
 267 \r
 268         \r