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

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