begriffs open source - freertos/blob - 20100923-V6.1.0-RC2/Demo/ARM7_AT91SAM7S64_IAR/serial/serial.c

   1 /*\r
   2     FreeRTOS V6.1.0 - 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 books - available as PDF or paperback  *\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 /*-----------------------------------------------------------*/\r
  69 \r
  70 /* Location of the COM0 registers. */\r
  71 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  72 \r
  73 /* Interrupt control macros. */\r
  74 #define serINTERRUPT_LEVEL                              ( 5 )\r
  75 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  76 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  77 \r
  78 /* Misc constants. */\r
  79 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  80 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  81 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  82 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  83 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  84 \r
  85 \r
  86 /* Queues used to hold received characters, and characters waiting to be\r
  87 transmitted. */\r
  88 static xQueueHandle xRxedChars; \r
  89 static xQueueHandle xCharsForTx; \r
  90 \r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
  94 extern void vSerialISREntry( void );\r
  95 \r
  96 /* The interrupt service routine - called from the assembly entry point. */\r
  97 __arm void vSerialISR( void );\r
  98 \r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 /*\r
 102  * See the serial2.h header file.\r
 103  */\r
 104 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 105 {\r
 106 xComPortHandle xReturn = serHANDLE;\r
 107 extern void ( vUART_ISR )( void );\r
 108 \r
 109         /* Create the queues used to hold Rx and Tx characters. */\r
 110         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 111         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 112 \r
 113         /* If the queues were created correctly then setup the serial port \r
 114         hardware. */\r
 115         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 116         {\r
 117                 portENTER_CRITICAL();\r
 118                 {\r
 119                         /* Enable the USART clock. */\r
 120                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
 121 \r
 122                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned long ) AT91C_PA5_RXD0 ) | ( ( unsigned long ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
 123 \r
 124                         /* Set the required protocol. */\r
 125                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 126 \r
 127                         /* Enable Rx and Tx. */\r
 128                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\r
 129 \r
 130                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 131                         until there are characters to be transmitted. */\r
 132                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 133 \r
 134                         /* Enable the interrupts in the AIC. */\r
 135                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 136                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, AT91C_ID_US0 );\r
 137                 }\r
 138                 portEXIT_CRITICAL();\r
 139         }\r
 140         else\r
 141         {\r
 142                 xReturn = ( xComPortHandle ) 0;\r
 143         }\r
 144 \r
 145         /* This demo file only supports a single port but we have to return \r
 146         something to comply with the standard demo header file. */\r
 147         return xReturn;\r
 148 }\r
 149 /*-----------------------------------------------------------*/\r
 150 \r
 151 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 152 {\r
 153         /* The port handle is not required as this driver only supports one port. */\r
 154         ( void ) pxPort;\r
 155 \r
 156         /* Get the next character from the buffer.  Return false if no characters\r
 157         are available, or arrive before xBlockTime expires. */\r
 158         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 159         {\r
 160                 return pdTRUE;\r
 161         }\r
 162         else\r
 163         {\r
 164                 return pdFALSE;\r
 165         }\r
 166 }\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 170 {\r
 171 signed char *pxNext;\r
 172 \r
 173         /* A couple of parameters that this port does not use. */\r
 174         ( void ) usStringLength;\r
 175         ( void ) pxPort;\r
 176 \r
 177         /* NOTE: This implementation does not handle the queue being full as no\r
 178         block time is used! */\r
 179 \r
 180         /* The port handle is not required as this driver only supports UART0. */\r
 181         ( void ) pxPort;\r
 182 \r
 183         /* Send each character in the string, one at a time. */\r
 184         pxNext = ( signed char * ) pcString;\r
 185         while( *pxNext )\r
 186         {\r
 187                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 188                 pxNext++;\r
 189         }\r
 190 }\r
 191 /*-----------------------------------------------------------*/\r
 192 \r
 193 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\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 }\r
 215 /*-----------------------------------------------------------*/\r
 216 \r
 217 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 218 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 219 within serialISR.s79 which in turn calls this function.  See the port\r
 220 documentation on the FreeRTOS.org website for more information. */\r
 221 __arm void vSerialISR( void )\r
 222 {\r
 223 unsigned long ulStatus;\r
 224 signed char cChar;\r
 225 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 226 \r
 227         /* What caused the interrupt? */\r
 228         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 229 \r
 230         if( ulStatus & AT91C_US_TXRDY )\r
 231         {\r
 232                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 233                 more characters to transmit? */\r
 234                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 235                 {\r
 236                         /* A character was retrieved from the queue so can be sent to the\r
 237                         THR now. */\r
 238                         serCOM0->US_THR = cChar;\r
 239                 }\r
 240                 else\r
 241                 {\r
 242                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 243                         vInterruptOff();\r
 244                 }               \r
 245         }\r
 246 \r
 247         if( ulStatus & AT91C_US_RXRDY )\r
 248         {\r
 249                 /* The interrupt was caused by a character being received.  Grab the\r
 250                 character from the RHR and place it in the queue or received \r
 251                 characters. */\r
 252                 cChar = serCOM0->US_RHR;\r
 253                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 254         }\r
 255 \r
 256         /* If a task was woken by either a character being received or a character \r
 257         being transmitted then we may need to switch to another task. */\r
 258         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 259 \r
 260         /* End the interrupt in the AIC. */\r
 261         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 262 }\r
 263 \r
 264 \r
 265 \r
 266 \r
 267         \r