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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 \r
  76 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. \r
  77 \r
  78 NOTE:  This driver is primarily to test the scheduler functionality.  It does\r
  79 not effectively use the buffers or DMA and is therefore not intended to be\r
  80 an example of an efficient driver. */\r
  81 \r
  82 /* Standard include file. */\r
  83 #include <stdlib.h>\r
  84 #include <plib.h>\r
  85 \r
  86 /* Scheduler include files. */\r
  87 #include "FreeRTOS.h"\r
  88 #include "queue.h"\r
  89 #include "task.h"\r
  90 \r
  91 /* Demo app include files. */\r
  92 #include "serial.h"\r
  93 \r
  94 /* Hardware setup. */\r
  95 #define serSET_FLAG                                             ( 1 )\r
  96 \r
  97 /* The queues used to communicate between tasks and ISR's. */\r
  98 static xQueueHandle xRxedChars; \r
  99 static xQueueHandle xCharsForTx; \r
 100 \r
 101 /* Flag used to indicate the tx status. */\r
 102 static volatile portBASE_TYPE xTxHasEnded;\r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* The UART interrupt handler.  As this uses the FreeRTOS assembly interrupt\r
 107 entry point the IPL setting in the following prototype has no effect.  The\r
 108 interrupt priority is set by the call to  ConfigIntUART2() in \r
 109 xSerialPortInitMinimal(). */\r
 110 void __attribute__( (interrupt(ipl0), vector(_UART2_VECTOR))) vU2InterruptWrapper( void );\r
 111 \r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 115 {\r
 116 unsigned short usBRG;\r
 117 \r
 118         /* Create the queues used by the com test task. */\r
 119         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 120         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 121 \r
 122         /* Configure the UART and interrupts. */\r
 123         usBRG = (unsigned short)(( (float)configPERIPHERAL_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 124         OpenUART2( UART_EN, UART_RX_ENABLE | UART_TX_ENABLE | UART_INT_TX | UART_INT_RX_CHAR, usBRG );\r
 125         ConfigIntUART2( ( configKERNEL_INTERRUPT_PRIORITY + 1 ) | UART_INT_SUB_PR0 | UART_TX_INT_EN | UART_RX_INT_EN );\r
 126 \r
 127         xTxHasEnded = pdTRUE;\r
 128 \r
 129         /* Only a single port is implemented so we don't need to return anything. */\r
 130         return NULL;\r
 131 }\r
 132 /*-----------------------------------------------------------*/\r
 133 \r
 134 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 135 {\r
 136         /* Only one port is supported. */\r
 137         ( void ) pxPort;\r
 138 \r
 139         /* Get the next character from the buffer.  Return false if no characters\r
 140         are available or arrive before xBlockTime expires. */\r
 141         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 142         {\r
 143                 return pdTRUE;\r
 144         }\r
 145         else\r
 146         {\r
 147                 return pdFALSE;\r
 148         }\r
 149 }\r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 153 {\r
 154 signed portBASE_TYPE xReturn;\r
 155 \r
 156         /* Only one port is supported. */\r
 157         ( void ) pxPort;\r
 158 \r
 159         /* Return false if after the block time there is no room on the Tx queue. */\r
 160         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 161         {\r
 162                 xReturn = pdFAIL;\r
 163         }\r
 164         else\r
 165         {\r
 166                 xReturn = pdPASS;\r
 167         }\r
 168 \r
 169         if( xReturn != pdFAIL )\r
 170         {\r
 171                 /* A critical section should not be required as xTxHasEnded will not be\r
 172                 written to by the ISR if it is already 0. */\r
 173                 if(  xTxHasEnded == pdTRUE )\r
 174                 {\r
 175                         xTxHasEnded = pdFALSE;\r
 176                         IFS1SET = _IFS1_U2TXIF_MASK;\r
 177                 }\r
 178         }\r
 179 \r
 180         return pdPASS;\r
 181 }\r
 182 /*-----------------------------------------------------------*/\r
 183 \r
 184 void vSerialClose( xComPortHandle xPort )\r
 185 {\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 void vU2InterruptHandler( void )\r
 190 {\r
 191 /* Declared static to minimise stack use. */\r
 192 static char cChar;\r
 193 static portBASE_TYPE xHigherPriorityTaskWoken;\r
 194 \r
 195         xHigherPriorityTaskWoken = pdFALSE;\r
 196 \r
 197         /* Are any Rx interrupts pending? */\r
 198         if( IFS1bits.U2RXIF == 1)\r
 199         {\r
 200                 while( U2STAbits.URXDA )\r
 201                 {\r
 202                         /* Retrieve the received character and place it in the queue of\r
 203                         received characters. */\r
 204                         cChar = U2RXREG;\r
 205                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 206                 }\r
 207                 IFS1CLR = _IFS1_U2RXIF_MASK;\r
 208         }\r
 209 \r
 210         /* Are any Tx interrupts pending? */\r
 211         if( IFS1bits.U2TXIF == 1 )\r
 212         {\r
 213                 while( ( U2STAbits.UTXBF ) == 0 )\r
 214                 {\r
 215                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 216                         {\r
 217                                 /* Send the next character queued for Tx. */\r
 218                                 U2TXREG = cChar;\r
 219                         }\r
 220                         else\r
 221                         {\r
 222                                 /* Queue empty, nothing to send. */\r
 223                                 xTxHasEnded = pdTRUE;\r
 224                                 break;\r
 225                         }\r
 226                 }\r
 227 \r
 228                 IFS1CLR = _IFS1_U2TXIF_MASK;\r
 229         }\r
 230 \r
 231         /* If sending or receiving necessitates a context switch, then switch now. */\r
 232         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 233 }\r
 234 \r
 235 \r
 236 \r
 237 \r
 238 \r
 239 \r
 240 \r