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

   1 /*\r
   2     FreeRTOS V6.0.1 - Copyright (C) 2009 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 /* Library includes. */\r
  69 #include "usart/usart.h"\r
  70 #include "pmc/pmc.h"\r
  71 #include "irq/irq.h"\r
  72 #include "pio/pio.h"\r
  73 \r
  74 /*-----------------------------------------------------------*/\r
  75 \r
  76 /* Interrupt control macros. */\r
  77 #define serINTERRUPT_LEVEL                              ( 5 )\r
  78 #define vInterruptOn()                                  BOARD_USART_BASE->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  79 #define vInterruptOff()                                 BOARD_USART_BASE->US_IDR = AT91C_US_TXRDY\r
  80 \r
  81 /* Misc constants. */\r
  82 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  83 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  84 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  85 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  86 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
  87 \r
  88 \r
  89 /* Queues used to hold received characters, and characters waiting to be\r
  90 transmitted. */\r
  91 static xQueueHandle xRxedChars;\r
  92 static xQueueHandle xCharsForTx;\r
  93 \r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 /* The interrupt service routine - called from the assembly entry point. */\r
  97 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 const Pin xUSART_Pins[] = { BOARD_PIN_USART_RXD, BOARD_PIN_USART_TXD };\r
 109 \r
 110 \r
 111         /* Create the queues used to hold Rx and Tx characters. */\r
 112         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 113         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 114 \r
 115         /* If the queues were created correctly then setup the serial port\r
 116         hardware. */\r
 117         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 118         {\r
 119                 portENTER_CRITICAL();\r
 120                 {\r
 121                         /* Enable the peripheral clock in the PMC. */\r
 122                         PMC_EnablePeripheral( BOARD_ID_USART );\r
 123                 \r
 124                         /* Configure the USART. */\r
 125                         USART_Configure( BOARD_USART_BASE, AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE | AT91C_US_NBSTOP_1_BIT, ulWantedBaud, configCPU_CLOCK_HZ );\r
 126                 \r
 127                         /* Configure the interrupt.  Note the pre-emption priority is set\r
 128                         in bits [8:15] of the priority value passed as the parameter. */\r
 129                         IRQ_ConfigureIT( BOARD_ID_USART, ( configMAX_SYSCALL_INTERRUPT_PRIORITY << 8 ), vSerialISR );\r
 130                         IRQ_EnableIT( BOARD_ID_USART );\r
 131                 \r
 132                         /* Enable receiver & transmitter. */\r
 133                         USART_SetTransmitterEnabled( BOARD_USART_BASE, pdTRUE );\r
 134                         USART_SetReceiverEnabled( BOARD_USART_BASE, pdTRUE );\r
 135                         \r
 136                         /* Configure IO for USART use. */\r
 137                         PIO_Configure( xUSART_Pins, PIO_LISTSIZE( xUSART_Pins ) );\r
 138                 }\r
 139                 portEXIT_CRITICAL();\r
 140         }\r
 141         else\r
 142         {\r
 143                 xReturn = ( xComPortHandle ) 0;\r
 144         }\r
 145 \r
 146         /* This demo file only supports a single port but we have to return\r
 147         something to comply with the standard demo header file. */\r
 148         return xReturn;\r
 149 }\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 153 {\r
 154         /* The port handle is not required as this driver only supports one port. */\r
 155         ( void ) pxPort;\r
 156 \r
 157         /* Get the next character from the buffer.  Return false if no characters\r
 158         are available, or arrive before xBlockTime expires. */\r
 159         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 160         {\r
 161                 return pdTRUE;\r
 162         }\r
 163         else\r
 164         {\r
 165                 return pdFALSE;\r
 166         }\r
 167 }\r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 171 {\r
 172 signed char *pxNext;\r
 173 \r
 174         /* A couple of parameters that this port does not use. */\r
 175         ( void ) usStringLength;\r
 176         ( void ) pxPort;\r
 177 \r
 178         /* NOTE: This implementation does not handle the queue being full as no\r
 179         block time is used! */\r
 180 \r
 181         /* The port handle is not required as this driver only supports UART0. */\r
 182         ( void ) pxPort;\r
 183 \r
 184         /* Send each character in the string, one at a time. */\r
 185         pxNext = ( signed char * ) pcString;\r
 186         while( *pxNext )\r
 187         {\r
 188                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 189                 pxNext++;\r
 190         }\r
 191 }\r
 192 /*-----------------------------------------------------------*/\r
 193 \r
 194 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 195 {\r
 196         /* Place the character in the queue of characters to be transmitted. */\r
 197         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 198         {\r
 199                 return pdFAIL;\r
 200         }\r
 201 \r
 202         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 203         queue and send it.   This does not need to be in a critical section as\r
 204         if the interrupt has already removed the character the next interrupt\r
 205         will simply turn off the Tx interrupt again. */\r
 206         vInterruptOn();\r
 207 \r
 208         return pdPASS;\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 void vSerialClose( xComPortHandle xPort )\r
 213 {\r
 214         /* Not supported as not required by the demo application. */\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 void vSerialISR( void )\r
 219 {\r
 220 unsigned long ulStatus;\r
 221 signed char cChar;\r
 222 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 223 \r
 224         /* What caused the interrupt? */\r
 225         ulStatus = BOARD_USART_BASE->US_CSR &= BOARD_USART_BASE->US_IMR;\r
 226 \r
 227         if( ulStatus & AT91C_US_TXRDY )\r
 228         {\r
 229                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 230                 more characters to transmit? */\r
 231                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 232                 {\r
 233                         /* A character was retrieved from the queue so can be sent to the\r
 234                         THR now. */\r
 235                         BOARD_USART_BASE->US_THR = cChar;\r
 236                 }\r
 237                 else\r
 238                 {\r
 239                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 240                         vInterruptOff();\r
 241                 }               \r
 242         }\r
 243 \r
 244         if( ulStatus & AT91C_US_RXRDY )\r
 245         {\r
 246                 /* The interrupt was caused by a character being received.  Grab the\r
 247                 character from the RHR and place it in the queue or received\r
 248                 characters. */\r
 249                 cChar = BOARD_USART_BASE->US_RHR;\r
 250                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 251         }\r
 252 \r
 253         /* If a task was woken by either a character being received or a character\r
 254         being transmitted then we may need to switch to another task. */\r
 255         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 256 }\r
 257 \r
 258 \r
 259 \r
 260 \r
 261         \r