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

   1 /*\r
   2     FreeRTOS V6.1.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS books - available as PDF or paperback  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\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 exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     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     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. \r
  56 \r
  57 NOTE:  This driver is primarily to test the scheduler functionality.  It does\r
  58 not effectively use the buffers or DMA and is therefore not intended to be\r
  59 an example of an efficient driver. */\r
  60 \r
  61 /* Standard include file. */\r
  62 #include <stdlib.h>\r
  63 #include <plib.h>\r
  64 \r
  65 /* Scheduler include files. */\r
  66 #include "FreeRTOS.h"\r
  67 #include "queue.h"\r
  68 #include "task.h"\r
  69 \r
  70 /* Demo app include files. */\r
  71 #include "serial.h"\r
  72 \r
  73 /* Hardware setup. */\r
  74 #define serSET_FLAG                                             ( 1 )\r
  75 \r
  76 /* The queues used to communicate between tasks and ISR's. */\r
  77 static xQueueHandle xRxedChars; \r
  78 static xQueueHandle xCharsForTx; \r
  79 \r
  80 /* Flag used to indicate the tx status. */\r
  81 static portBASE_TYPE xTxHasEnded;\r
  82 \r
  83 /*-----------------------------------------------------------*/\r
  84 \r
  85 /* The UART interrupt handler.  As this uses the FreeRTOS assembly interrupt\r
  86 entry point the IPL setting in the following prototype has no effect.  The\r
  87 interrupt priority is set by the call to  ConfigIntUART2() in \r
  88 xSerialPortInitMinimal(). */\r
  89 void __attribute__( (interrupt(ipl1), vector(_UART2_VECTOR))) vU2InterruptWrapper( void );\r
  90 \r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  94 {\r
  95 unsigned short usBRG;\r
  96 \r
  97         /* Create the queues used by the com test task. */\r
  98         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  99         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 100 \r
 101         /* Configure the UART and interrupts. */\r
 102         usBRG = (unsigned short)(( (float)configPERIPHERAL_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 103         OpenUART2( UART_EN, UART_RX_ENABLE | UART_TX_ENABLE | UART_INT_TX | UART_INT_RX_CHAR, usBRG );\r
 104         ConfigIntUART2( ( configKERNEL_INTERRUPT_PRIORITY + 1 ) | UART_INT_SUB_PR0 | UART_TX_INT_EN | UART_RX_INT_EN );\r
 105 \r
 106         xTxHasEnded = pdTRUE;\r
 107 \r
 108         /* Only a single port is implemented so we don't need to return anything. */\r
 109         return NULL;\r
 110 }\r
 111 /*-----------------------------------------------------------*/\r
 112 \r
 113 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 114 {\r
 115         /* Only one port is supported. */\r
 116         ( void ) pxPort;\r
 117 \r
 118         /* Get the next character from the buffer.  Return false if no characters\r
 119         are available or arrive before xBlockTime expires. */\r
 120         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 121         {\r
 122                 return pdTRUE;\r
 123         }\r
 124         else\r
 125         {\r
 126                 return pdFALSE;\r
 127         }\r
 128 }\r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 132 {\r
 133         /* Only one port is supported. */\r
 134         ( void ) pxPort;\r
 135 \r
 136         /* Return false if after the block time there is no room on the Tx queue. */\r
 137         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 138         {\r
 139                 return pdFAIL;\r
 140         }\r
 141 \r
 142         /* A critical section should not be required as xTxHasEnded will not be\r
 143         written to by the ISR if it is already 0 (is this correct?). */\r
 144         if( xTxHasEnded )\r
 145         {\r
 146                 xTxHasEnded = pdFALSE;\r
 147                 IFS1bits.U2TXIF = serSET_FLAG;\r
 148         }\r
 149 \r
 150         return pdPASS;\r
 151 }\r
 152 /*-----------------------------------------------------------*/\r
 153 \r
 154 void vSerialClose( xComPortHandle xPort )\r
 155 {\r
 156 }\r
 157 /*-----------------------------------------------------------*/\r
 158 \r
 159 void vU2InterruptHandler( void )\r
 160 {\r
 161 /* Declared static to minimise stack use. */\r
 162 static char cChar;\r
 163 static portBASE_TYPE xHigherPriorityTaskWoken;\r
 164 \r
 165         xHigherPriorityTaskWoken = pdFALSE;\r
 166 \r
 167         /* Are any Rx interrupts pending? */\r
 168         if( mU2RXGetIntFlag() )\r
 169         {\r
 170                 while( U2STAbits.URXDA )\r
 171                 {\r
 172                         /* Retrieve the received character and place it in the queue of\r
 173                         received characters. */\r
 174                         cChar = U2RXREG;\r
 175                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 176                 }\r
 177                 mU2RXClearIntFlag();\r
 178         }\r
 179 \r
 180         /* Are any Tx interrupts pending? */\r
 181         if( mU2TXGetIntFlag() )\r
 182         {\r
 183                 while( !( U2STAbits.UTXBF ) )\r
 184                 {\r
 185                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 186                         {\r
 187                                 /* Send the next character queued for Tx. */\r
 188                                 U2TXREG = cChar;\r
 189                         }\r
 190                         else\r
 191                         {\r
 192                                 /* Queue empty, nothing to send. */\r
 193                                 xTxHasEnded = pdTRUE;\r
 194                                 break;\r
 195                         }\r
 196                 }\r
 197 \r
 198                 mU2TXClearIntFlag();\r
 199         }\r
 200 \r
 201         /* If sending or receiving necessitates a context switch, then switch now. */\r
 202         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 203 }\r
 204 \r
 205 \r
 206 \r
 207 \r
 208 \r
 209 \r
 210 \r