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

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