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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  77 */\r
  78 \r
  79 /* Standard includes. */\r
  80 #include <stdlib.h>\r
  81 \r
  82 /* Scheduler includes. */\r
  83 #include "FreeRTOS.h"\r
  84 #include "queue.h"\r
  85 \r
  86 /* Demo application includes. */\r
  87 #include "serial.h"\r
  88 \r
  89 /* Library includes. */\r
  90 #include "usart/usart.h"\r
  91 #include "pmc/pmc.h"\r
  92 #include "irq/irq.h"\r
  93 #include "pio/pio.h"\r
  94 \r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 /* Interrupt control macros. */\r
  98 #define serINTERRUPT_LEVEL                              ( 5 )\r
  99 #define vInterruptOn()                                  BOARD_USART_BASE->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
 100 #define vInterruptOff()                                 BOARD_USART_BASE->US_IDR = AT91C_US_TXRDY\r
 101 \r
 102 /* Misc constants. */\r
 103 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
 104 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 105 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
 106 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
 107 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
 108 \r
 109 \r
 110 /* Queues used to hold received characters, and characters waiting to be\r
 111 transmitted. */\r
 112 static xQueueHandle xRxedChars;\r
 113 static xQueueHandle xCharsForTx;\r
 114 \r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 /* The interrupt service routine - called from the assembly entry point. */\r
 118 void vSerialISR( void );\r
 119 \r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 /*\r
 123  * See the serial2.h header file.\r
 124  */\r
 125 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 126 {\r
 127 xComPortHandle xReturn = serHANDLE;\r
 128 extern void ( vUART_ISR )( void );\r
 129 const Pin xUSART_Pins[] = { BOARD_PIN_USART_RXD, BOARD_PIN_USART_TXD };\r
 130 \r
 131 \r
 132         /* Create the queues used to hold Rx and Tx characters. */\r
 133         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 134         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 135 \r
 136         /* If the queues were created correctly then setup the serial port\r
 137         hardware. */\r
 138         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 139         {\r
 140                 portENTER_CRITICAL();\r
 141                 {\r
 142                         /* Enable the peripheral clock in the PMC. */\r
 143                         PMC_EnablePeripheral( BOARD_ID_USART );\r
 144                 \r
 145                         /* Configure the USART. */\r
 146                         USART_Configure( BOARD_USART_BASE, AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE | AT91C_US_NBSTOP_1_BIT, ulWantedBaud, configCPU_CLOCK_HZ );\r
 147                 \r
 148                         /* Configure the interrupt.  Note the pre-emption priority is set\r
 149                         in bits [8:15] of the priority value passed as the parameter. */\r
 150                         IRQ_ConfigureIT( BOARD_ID_USART, ( configMAX_SYSCALL_INTERRUPT_PRIORITY << 8 ), vSerialISR );\r
 151                         IRQ_EnableIT( BOARD_ID_USART );\r
 152                 \r
 153                         /* Enable receiver & transmitter. */\r
 154                         USART_SetTransmitterEnabled( BOARD_USART_BASE, pdTRUE );\r
 155                         USART_SetReceiverEnabled( BOARD_USART_BASE, pdTRUE );\r
 156                         \r
 157                         /* Configure IO for USART use. */\r
 158                         PIO_Configure( xUSART_Pins, PIO_LISTSIZE( xUSART_Pins ) );\r
 159                 }\r
 160                 portEXIT_CRITICAL();\r
 161         }\r
 162         else\r
 163         {\r
 164                 xReturn = ( xComPortHandle ) 0;\r
 165         }\r
 166 \r
 167         /* This demo file only supports a single port but we have to return\r
 168         something to comply with the standard demo header file. */\r
 169         return xReturn;\r
 170 }\r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 174 {\r
 175         /* The port handle is not required as this driver only supports one port. */\r
 176         ( void ) pxPort;\r
 177 \r
 178         /* Get the next character from the buffer.  Return false if no characters\r
 179         are available, or arrive before xBlockTime expires. */\r
 180         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 181         {\r
 182                 return pdTRUE;\r
 183         }\r
 184         else\r
 185         {\r
 186                 return pdFALSE;\r
 187         }\r
 188 }\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 192 {\r
 193 signed char *pxNext;\r
 194 \r
 195         /* A couple of parameters that this port does not use. */\r
 196         ( void ) usStringLength;\r
 197         ( void ) pxPort;\r
 198 \r
 199         /* NOTE: This implementation does not handle the queue being full as no\r
 200         block time is used! */\r
 201 \r
 202         /* The port handle is not required as this driver only supports UART0. */\r
 203         ( void ) pxPort;\r
 204 \r
 205         /* Send each character in the string, one at a time. */\r
 206         pxNext = ( signed char * ) pcString;\r
 207         while( *pxNext )\r
 208         {\r
 209                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 210                 pxNext++;\r
 211         }\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 216 {\r
 217         /* Place the character in the queue of characters to be transmitted. */\r
 218         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 219         {\r
 220                 return pdFAIL;\r
 221         }\r
 222 \r
 223         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 224         queue and send it.   This does not need to be in a critical section as\r
 225         if the interrupt has already removed the character the next interrupt\r
 226         will simply turn off the Tx interrupt again. */\r
 227         vInterruptOn();\r
 228 \r
 229         return pdPASS;\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 void vSerialClose( xComPortHandle xPort )\r
 234 {\r
 235         /* Not supported as not required by the demo application. */\r
 236 }\r
 237 /*-----------------------------------------------------------*/\r
 238 \r
 239 void vSerialISR( void )\r
 240 {\r
 241 unsigned long ulStatus;\r
 242 signed char cChar;\r
 243 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 244 \r
 245         /* What caused the interrupt? */\r
 246         ulStatus = BOARD_USART_BASE->US_CSR &= BOARD_USART_BASE->US_IMR;\r
 247 \r
 248         if( ulStatus & AT91C_US_TXRDY )\r
 249         {\r
 250                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 251                 more characters to transmit? */\r
 252                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 253                 {\r
 254                         /* A character was retrieved from the queue so can be sent to the\r
 255                         THR now. */\r
 256                         BOARD_USART_BASE->US_THR = cChar;\r
 257                 }\r
 258                 else\r
 259                 {\r
 260                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 261                         vInterruptOff();\r
 262                 }               \r
 263         }\r
 264 \r
 265         if( ulStatus & AT91C_US_RXRDY )\r
 266         {\r
 267                 /* The interrupt was caused by a character being received.  Grab the\r
 268                 character from the RHR and place it in the queue or received\r
 269                 characters. */\r
 270                 cChar = BOARD_USART_BASE->US_RHR;\r
 271                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 272         }\r
 273 \r
 274         /* If a task was woken by either a character being received or a character\r
 275         being transmitted then we may need to switch to another task. */\r
 276         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 277 }\r
 278 \r
 279 \r
 280 \r
 281 \r
 282         \r