git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_ATSAM3S-EK2_Atmel_Studio/src/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 USART1.\r
  77 \r
  78         ***Note*** This example uses queues to send each character into an interrupt\r
  79         service routine and out of an interrupt service routine individually.  This\r
  80         is done to demonstrate queues being used in an interrupt, and to deliberately\r
  81         load the system to test the FreeRTOS port.  It is *NOT* meant to be an\r
  82         example of an efficient implementation.  An efficient implementation should\r
  83         use FIFO's or DMA if available, and only use FreeRTOS API functions when\r
  84         enough has been received to warrant a task being unblocked to process the\r
  85         data.\r
  86 */\r
  87 \r
  88 /* Scheduler includes. */\r
  89 #include "FreeRTOS.h"\r
  90 #include "queue.h"\r
  91 #include "semphr.h"\r
  92 #include "comtest2.h"\r
  93 \r
  94 /* Library includes. */\r
  95 #include "asf.h"\r
  96 \r
  97 /* Demo application includes. */\r
  98 #include "demo_serial.h"\r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 /* Misc defines. */\r
 102 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
 103 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
 104 #define serPMC_USART_ID                                 ( BOARD_ID_USART )\r
 105 \r
 106 /* The USART supported by this file. */\r
 107 #define serUSART_PORT                                   ( USART1 )\r
 108 #define serUSART_IRQ                                    ( USART1_IRQn )\r
 109 \r
 110 /* Every bit in the interrupt mask. */\r
 111 #define serMASK_ALL_INTERRUPTS                  ( 0xffffffffUL )\r
 112 \r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 /* The queue used to hold received characters. */\r
 116 static xQueueHandle xRxedChars;\r
 117 static xQueueHandle xCharsForTx;\r
 118 \r
 119 /*-----------------------------------------------------------*/\r
 120 \r
 121 \r
 122 /*\r
 123  * See the serial.h header file.\r
 124  */\r
 125 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 126 {\r
 127 uint32_t ulChar;\r
 128 xComPortHandle xReturn;\r
 129 const sam_usart_opt_t xUSARTSettings =\r
 130 {\r
 131         ulWantedBaud,\r
 132         US_MR_CHRL_8_BIT,\r
 133         US_MR_PAR_NO,\r
 134         US_MR_NBSTOP_1_BIT,\r
 135         US_MR_CHMODE_NORMAL,\r
 136         0 /* Only used in IrDA mode. */\r
 137 };\r
 138 \r
 139         /* Create the queues used to hold Rx/Tx characters. */\r
 140         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 141         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 142 \r
 143         /* If the queues were created correctly then setup the serial port\r
 144         hardware. */\r
 145         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 146         {\r
 147                 /* Enable the peripheral clock in the PMC. */\r
 148                 pmc_enable_periph_clk( serPMC_USART_ID );\r
 149 \r
 150                 /* Configure USART in serial mode. */\r
 151                 usart_init_rs232( serUSART_PORT, &xUSARTSettings, sysclk_get_cpu_hz() );\r
 152 \r
 153                 /* Disable all the interrupts. */\r
 154                 usart_disable_interrupt( serUSART_PORT, serMASK_ALL_INTERRUPTS );\r
 155 \r
 156                 /* Enable the receiver and transmitter. */\r
 157                 usart_enable_tx( serUSART_PORT );\r
 158                 usart_enable_rx( serUSART_PORT );\r
 159 \r
 160                 /* Clear any characters before enabling interrupt. */\r
 161                 usart_getchar( serUSART_PORT, &ulChar );\r
 162 \r
 163                 /* Enable Rx end interrupt. */\r
 164                 usart_enable_interrupt( serUSART_PORT, US_IER_RXRDY );\r
 165 \r
 166                 /* Configure and enable interrupt of USART. */\r
 167                 NVIC_SetPriority( serUSART_IRQ, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 168                 NVIC_EnableIRQ( serUSART_IRQ );\r
 169         }\r
 170         else\r
 171         {\r
 172                 xReturn = ( xComPortHandle ) 0;\r
 173         }\r
 174 \r
 175         /* This demo file only supports a single port but we have to return\r
 176         something to comply with the standard demo header file. */\r
 177         return xReturn;\r
 178 }\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 182 {\r
 183         /* The port handle is not required as this driver only supports one port. */\r
 184         ( void ) pxPort;\r
 185 \r
 186         /* Get the next character from the buffer.  Return false if no characters\r
 187         are available, or arrive before xBlockTime expires. */\r
 188         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 189         {\r
 190                 return pdTRUE;\r
 191         }\r
 192         else\r
 193         {\r
 194                 return pdFALSE;\r
 195         }\r
 196 }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 200 {\r
 201 signed char *pxNext;\r
 202 \r
 203         /* A couple of parameters that this port does not use. */\r
 204         ( void ) usStringLength;\r
 205         ( void ) pxPort;\r
 206 \r
 207         /* NOTE: This implementation does not handle the queue being full as no\r
 208         block time is used! */\r
 209 \r
 210         /* The port handle is not required as this driver only supports USART1. */\r
 211         ( void ) pxPort;\r
 212 \r
 213         /* Send each character in the string, one at a time. */\r
 214         pxNext = ( signed char * ) pcString;\r
 215         while( *pxNext )\r
 216         {\r
 217                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 218                 pxNext++;\r
 219         }\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 224 {\r
 225 signed portBASE_TYPE xReturn;\r
 226 \r
 227         /* This simple example only supports one port. */\r
 228         ( void ) pxPort;\r
 229 \r
 230         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 231         {\r
 232                 xReturn = pdPASS;\r
 233                 usart_enable_interrupt( serUSART_PORT, US_IER_TXRDY );\r
 234         }\r
 235         else\r
 236         {\r
 237                 xReturn = pdFAIL;\r
 238         }\r
 239 \r
 240         return xReturn;\r
 241 }\r
 242 /*-----------------------------------------------------------*/\r
 243 \r
 244 void vSerialClose( xComPortHandle xPort )\r
 245 {\r
 246         /* Not supported as not required by the demo application. */\r
 247         ( void ) xPort;\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 /*\r
 252  * It should be noted that the com test tasks (which use make use of this file)\r
 253  * are included to demonstrate queues being used to communicate between tasks\r
 254  * and interrupts, and to demonstrate a context switch being performed from\r
 255  * inside an interrupt service routine.  The serial driver used here is *not*\r
 256  * intended to represent an efficient implementation.  Real applications should\r
 257  * make use of the USARTS peripheral DMA channel (PDC).\r
 258  */\r
 259 void USART1_Handler( void )\r
 260 {\r
 261 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 262 uint8_t ucChar;\r
 263 uint32_t ulChar;\r
 264 uint32_t ulUSARTStatus, ulUSARTMask;\r
 265 \r
 266         ulUSARTStatus = usart_get_status( serUSART_PORT );\r
 267         ulUSARTMask = usart_get_interrupt_mask( serUSART_PORT );\r
 268         ulUSARTStatus &= ulUSARTMask;\r
 269 \r
 270         if( ( ulUSARTStatus & US_CSR_TXRDY ) != 0UL )\r
 271         {\r
 272                 /* The interrupt was caused by the TX register becoming empty.  Are\r
 273                 there any more characters to transmit? */\r
 274                 if( xQueueReceiveFromISR( xCharsForTx, &ucChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 275                 {\r
 276                         /* A character was retrieved from the queue so can be sent to the\r
 277                         USART now. */\r
 278                         usart_putchar( serUSART_PORT, ( uint32_t ) ucChar );\r
 279                 }\r
 280                 else\r
 281                 {\r
 282                         usart_disable_interrupt( serUSART_PORT, US_IER_TXRDY );\r
 283                 }\r
 284         }\r
 285 \r
 286         if( ( ulUSARTStatus & US_CSR_RXRDY ) != 0UL )\r
 287         {\r
 288                 /* A character has been received on the USART, send it to the Rx\r
 289                 handler task. */\r
 290                 usart_getchar( serUSART_PORT, &ulChar );\r
 291                 ucChar = ( uint8_t ) ( ulChar & 0xffUL );\r
 292                 xQueueSendFromISR( xRxedChars, &ucChar, &xHigherPriorityTaskWoken );\r
 293         }\r
 294 \r
 295         /* If sending or receiving from a queue has caused a task to unblock, and\r
 296         the unblocked task has a priority equal to or higher than the currently\r
 297         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 298         will have automatically been set to pdTRUE within the queue send or receive\r
 299         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 300         directly to the higher priority unblocked task. */\r
 301         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 302 }\r
 303 \r
 304 \r
 305 \r
 306 \r
 307 \r
 308 \r