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

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