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

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