begriffs open source - cmsis-freertos/blob - Demo/CORTEX_ATSAM3S-EK2_Atmel_Studio/src/serial.c

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