git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_ATSAM3S-EK2_Atmel_Studio/src/serial.c

   1 /*\r
   2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd. \r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /*\r
  67         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR USART1.\r
  68 \r
  69         ***Note*** This example uses queues to send each character into an interrupt\r
  70         service routine and out of an interrupt service routine individually.  This\r
  71         is done to demonstrate queues being used in an interrupt, and to deliberately\r
  72         load the system to test the FreeRTOS port.  It is *NOT* meant to be an\r
  73         example of an efficient implementation.  An efficient implementation should\r
  74         use FIFO's or DMA if available, and only use FreeRTOS API functions when\r
  75         enough has been received to warrant a task being unblocked to process the\r
  76         data.\r
  77 */\r
  78 \r
  79 /* Scheduler includes. */\r
  80 #include "FreeRTOS.h"\r
  81 #include "queue.h"\r
  82 #include "semphr.h"\r
  83 #include "comtest2.h"\r
  84 \r
  85 /* Library includes. */\r
  86 #include "asf.h"\r
  87 \r
  88 /* Demo application includes. */\r
  89 #include "demo_serial.h"\r
  90 /*-----------------------------------------------------------*/\r
  91 \r
  92 /* Misc defines. */\r
  93 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  94 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  95 #define serPMC_USART_ID                                 ( BOARD_ID_USART )\r
  96 \r
  97 /* The USART supported by this file. */\r
  98 #define serUSART_PORT                                   ( USART1 )\r
  99 #define serUSART_IRQ                                    ( USART1_IRQn )\r
 100 \r
 101 /* Every bit in the interrupt mask. */\r
 102 #define serMASK_ALL_INTERRUPTS                  ( 0xffffffffUL )\r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* The queue used to hold received characters. */\r
 107 static QueueHandle_t xRxedChars;\r
 108 static QueueHandle_t xCharsForTx;\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 \r
 113 /*\r
 114  * See the serial.h header file.\r
 115  */\r
 116 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 117 {\r
 118 uint32_t ulChar;\r
 119 xComPortHandle xReturn;\r
 120 const sam_usart_opt_t xUSARTSettings =\r
 121 {\r
 122         ulWantedBaud,\r
 123         US_MR_CHRL_8_BIT,\r
 124         US_MR_PAR_NO,\r
 125         US_MR_NBSTOP_1_BIT,\r
 126         US_MR_CHMODE_NORMAL,\r
 127         0 /* Only used in IrDA mode. */\r
 128 };\r
 129 \r
 130         /* Create the queues used to hold Rx/Tx characters. */\r
 131         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 132         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 133 \r
 134         /* If the queues were created correctly then setup the serial port\r
 135         hardware. */\r
 136         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 137         {\r
 138                 /* Enable the peripheral clock in the PMC. */\r
 139                 pmc_enable_periph_clk( serPMC_USART_ID );\r
 140 \r
 141                 /* Configure USART in serial mode. */\r
 142                 usart_init_rs232( serUSART_PORT, &xUSARTSettings, sysclk_get_cpu_hz() );\r
 143 \r
 144                 /* Disable all the interrupts. */\r
 145                 usart_disable_interrupt( serUSART_PORT, serMASK_ALL_INTERRUPTS );\r
 146 \r
 147                 /* Enable the receiver and transmitter. */\r
 148                 usart_enable_tx( serUSART_PORT );\r
 149                 usart_enable_rx( serUSART_PORT );\r
 150 \r
 151                 /* Clear any characters before enabling interrupt. */\r
 152                 usart_getchar( serUSART_PORT, &ulChar );\r
 153 \r
 154                 /* Enable Rx end interrupt. */\r
 155                 usart_enable_interrupt( serUSART_PORT, US_IER_RXRDY );\r
 156 \r
 157                 /* Configure and enable interrupt of USART. */\r
 158                 NVIC_SetPriority( serUSART_IRQ, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 159                 NVIC_EnableIRQ( serUSART_IRQ );\r
 160         }\r
 161         else\r
 162         {\r
 163                 xReturn = ( xComPortHandle ) 0;\r
 164         }\r
 165 \r
 166         /* This demo file only supports a single port but we have to return\r
 167         something to comply with the standard demo header file. */\r
 168         return xReturn;\r
 169 }\r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 173 {\r
 174         /* The port handle is not required as this driver only supports one port. */\r
 175         ( void ) pxPort;\r
 176 \r
 177         /* Get the next character from the buffer.  Return false if no characters\r
 178         are available, or arrive before xBlockTime expires. */\r
 179         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 180         {\r
 181                 return pdTRUE;\r
 182         }\r
 183         else\r
 184         {\r
 185                 return pdFALSE;\r
 186         }\r
 187 }\r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 191 {\r
 192 signed char *pxNext;\r
 193 \r
 194         /* A couple of parameters that this port does not use. */\r
 195         ( void ) usStringLength;\r
 196         ( void ) pxPort;\r
 197 \r
 198         /* NOTE: This implementation does not handle the queue being full as no\r
 199         block time is used! */\r
 200 \r
 201         /* The port handle is not required as this driver only supports USART1. */\r
 202         ( void ) pxPort;\r
 203 \r
 204         /* Send each character in the string, one at a time. */\r
 205         pxNext = ( signed char * ) pcString;\r
 206         while( *pxNext )\r
 207         {\r
 208                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 209                 pxNext++;\r
 210         }\r
 211 }\r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 215 {\r
 216 signed portBASE_TYPE xReturn;\r
 217 \r
 218         /* This simple example only supports one port. */\r
 219         ( void ) pxPort;\r
 220 \r
 221         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 222         {\r
 223                 xReturn = pdPASS;\r
 224                 usart_enable_interrupt( serUSART_PORT, US_IER_TXRDY );\r
 225         }\r
 226         else\r
 227         {\r
 228                 xReturn = pdFAIL;\r
 229         }\r
 230 \r
 231         return xReturn;\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 void vSerialClose( xComPortHandle xPort )\r
 236 {\r
 237         /* Not supported as not required by the demo application. */\r
 238         ( void ) xPort;\r
 239 }\r
 240 /*-----------------------------------------------------------*/\r
 241 \r
 242 /*\r
 243  * It should be noted that the com test tasks (which use make use of this file)\r
 244  * are included to demonstrate queues being used to communicate between tasks\r
 245  * and interrupts, and to demonstrate a context switch being performed from\r
 246  * inside an interrupt service routine.  The serial driver used here is *not*\r
 247  * intended to represent an efficient implementation.  Real applications should\r
 248  * make use of the USARTS peripheral DMA channel (PDC).\r
 249  */\r
 250 void USART1_Handler( void )\r
 251 {\r
 252 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 253 uint8_t ucChar;\r
 254 uint32_t ulChar;\r
 255 uint32_t ulUSARTStatus, ulUSARTMask;\r
 256 \r
 257         ulUSARTStatus = usart_get_status( serUSART_PORT );\r
 258         ulUSARTMask = usart_get_interrupt_mask( serUSART_PORT );\r
 259         ulUSARTStatus &= ulUSARTMask;\r
 260 \r
 261         if( ( ulUSARTStatus & US_CSR_TXRDY ) != 0UL )\r
 262         {\r
 263                 /* The interrupt was caused by the TX register becoming empty.  Are\r
 264                 there any more characters to transmit? */\r
 265                 if( xQueueReceiveFromISR( xCharsForTx, &ucChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 266                 {\r
 267                         /* A character was retrieved from the queue so can be sent to the\r
 268                         USART now. */\r
 269                         usart_putchar( serUSART_PORT, ( uint32_t ) ucChar );\r
 270                 }\r
 271                 else\r
 272                 {\r
 273                         usart_disable_interrupt( serUSART_PORT, US_IER_TXRDY );\r
 274                 }\r
 275         }\r
 276 \r
 277         if( ( ulUSARTStatus & US_CSR_RXRDY ) != 0UL )\r
 278         {\r
 279                 /* A character has been received on the USART, send it to the Rx\r
 280                 handler task. */\r
 281                 usart_getchar( serUSART_PORT, &ulChar );\r
 282                 ucChar = ( uint8_t ) ( ulChar & 0xffUL );\r
 283                 xQueueSendFromISR( xRxedChars, &ucChar, &xHigherPriorityTaskWoken );\r
 284         }\r
 285 \r
 286         /* If sending or receiving from a queue has caused a task to unblock, and\r
 287         the unblocked task has a priority equal to or higher than the currently\r
 288         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 289         will have automatically been set to pdTRUE within the queue send or receive\r
 290         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 291         directly to the higher priority unblocked task. */\r
 292         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 293 }\r
 294 \r
 295 \r
 296 \r
 297 \r
 298 \r
 299 \r