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