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

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