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

   1 /*\r
   2     FreeRTOS V6.0.5 - Copyright (C) 2010 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 eBook                                  *\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 \r
  64 /* Scheduler include files. */\r
  65 #include "FreeRTOS.h"\r
  66 #include "queue.h"\r
  67 #include "task.h"\r
  68 \r
  69 /* Demo app include files. */\r
  70 #include "serial.h"\r
  71 \r
  72 /* Hardware setup. */\r
  73 #define serOUTPUT                                               0\r
  74 #define serINPUT                                                1\r
  75 #define serLOW_SPEED                                    0\r
  76 #define serONE_STOP_BIT                                 0\r
  77 #define serEIGHT_DATA_BITS_NO_PARITY    0\r
  78 #define serNORMAL_IDLE_STATE                    0\r
  79 #define serAUTO_BAUD_OFF                                0\r
  80 #define serLOOPBACK_OFF                                 0\r
  81 #define serWAKE_UP_DISABLE                              0\r
  82 #define serNO_HARDWARE_FLOW_CONTROL             0\r
  83 #define serSTANDARD_IO                                  0\r
  84 #define serNO_IRDA                                              0\r
  85 #define serCONTINUE_IN_IDLE_MODE                0\r
  86 #define serUART_ENABLED                                 1\r
  87 #define serINTERRUPT_ON_SINGLE_CHAR             0\r
  88 #define serTX_ENABLE                                    1\r
  89 #define serINTERRUPT_ENABLE                             1\r
  90 #define serINTERRUPT_DISABLE                    0\r
  91 #define serCLEAR_FLAG                                   0\r
  92 #define serSET_FLAG                                             1\r
  93 \r
  94 \r
  95 /* The queues used to communicate between tasks and ISR's. */\r
  96 static xQueueHandle xRxedChars; \r
  97 static xQueueHandle xCharsForTx; \r
  98 \r
  99 static portBASE_TYPE xTxHasEnded;\r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 103 {\r
 104 char cChar;\r
 105 \r
 106         /* Create the queues used by the com test task. */\r
 107         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 108         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 109 \r
 110         /* Setup the UART. */\r
 111         U2MODEbits.BRGH         = serLOW_SPEED;\r
 112         U2MODEbits.STSEL        = serONE_STOP_BIT;\r
 113         U2MODEbits.PDSEL        = serEIGHT_DATA_BITS_NO_PARITY;\r
 114         U2MODEbits.RXINV        = serNORMAL_IDLE_STATE;\r
 115         U2MODEbits.ABAUD        = serAUTO_BAUD_OFF;\r
 116         U2MODEbits.LPBACK       = serLOOPBACK_OFF;\r
 117         U2MODEbits.WAKE         = serWAKE_UP_DISABLE;\r
 118         U2MODEbits.UEN          = serNO_HARDWARE_FLOW_CONTROL;\r
 119         U2MODEbits.IREN         = serNO_IRDA;\r
 120         U2MODEbits.USIDL        = serCONTINUE_IN_IDLE_MODE;\r
 121         U2MODEbits.UARTEN       = serUART_ENABLED;\r
 122 \r
 123         U2BRG = (unsigned short)(( (float)configCPU_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 124 \r
 125         U2STAbits.URXISEL       = serINTERRUPT_ON_SINGLE_CHAR;\r
 126         U2STAbits.UTXEN         = serTX_ENABLE;\r
 127         U2STAbits.UTXINV        = serNORMAL_IDLE_STATE;\r
 128         U2STAbits.UTXISEL0      = serINTERRUPT_ON_SINGLE_CHAR;\r
 129         U2STAbits.UTXISEL1      = serINTERRUPT_ON_SINGLE_CHAR;\r
 130 \r
 131         /* It is assumed that this function is called prior to the scheduler being\r
 132         started.  Therefore interrupts must not be allowed to occur yet as they\r
 133         may attempt to perform a context switch. */\r
 134         portDISABLE_INTERRUPTS();\r
 135 \r
 136         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 137         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 138         IPC7bits.U2RXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 139         IPC7bits.U2TXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 140         IEC1bits.U2TXIE = serINTERRUPT_ENABLE;\r
 141         IEC1bits.U2RXIE = serINTERRUPT_ENABLE;\r
 142 \r
 143         /* Clear the Rx buffer. */\r
 144         while( U2STAbits.URXDA == serSET_FLAG )\r
 145         {\r
 146                 cChar = U2RXREG;\r
 147         }\r
 148 \r
 149         xTxHasEnded = pdTRUE;\r
 150 \r
 151         return NULL;\r
 152 }\r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 156 {\r
 157         /* Only one port is supported. */\r
 158         ( void ) pxPort;\r
 159 \r
 160         /* Get the next character from the buffer.  Return false if no characters\r
 161         are available or arrive before xBlockTime expires. */\r
 162         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 163         {\r
 164                 return pdTRUE;\r
 165         }\r
 166         else\r
 167         {\r
 168                 return pdFALSE;\r
 169         }\r
 170 }\r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 174 {\r
 175         /* Only one port is supported. */\r
 176         ( void ) pxPort;\r
 177 \r
 178         /* Return false if after the block time there is no room on the Tx queue. */\r
 179         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 180         {\r
 181                 return pdFAIL;\r
 182         }\r
 183 \r
 184         /* A critical section should not be required as xTxHasEnded will not be\r
 185         written to by the ISR if it is already 0 (is this correct?). */\r
 186         if( xTxHasEnded )\r
 187         {\r
 188                 xTxHasEnded = pdFALSE;\r
 189                 IFS1bits.U2TXIF = serSET_FLAG;\r
 190         }\r
 191 \r
 192         return pdPASS;\r
 193 }\r
 194 /*-----------------------------------------------------------*/\r
 195 \r
 196 void vSerialClose( xComPortHandle xPort )\r
 197 {\r
 198 }\r
 199 /*-----------------------------------------------------------*/\r
 200 \r
 201 void __attribute__((__interrupt__, auto_psv)) _U2RXInterrupt( void )\r
 202 {\r
 203 char cChar;\r
 204 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 205 \r
 206         /* Get the character and post it on the queue of Rxed characters.\r
 207         If the post causes a task to wake force a context switch as the woken task\r
 208         may have a higher priority than the task we have interrupted. */\r
 209         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 210         while( U2STAbits.URXDA )\r
 211         {\r
 212                 cChar = U2RXREG;\r
 213                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 214         }\r
 215 \r
 216         if( xHigherPriorityTaskWoken != pdFALSE )\r
 217         {\r
 218                 taskYIELD();\r
 219         }\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 void __attribute__((__interrupt__, auto_psv)) _U2TXInterrupt( void )\r
 224 {\r
 225 signed char cChar;\r
 226 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 227 \r
 228         /* If the transmit buffer is full we cannot get the next character.\r
 229         Another interrupt will occur the next time there is space so this does\r
 230         not matter. */\r
 231         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 232         while( !( U2STAbits.UTXBF ) )\r
 233         {\r
 234                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 235                 {\r
 236                         /* Send the next character queued for Tx. */\r
 237                         U2TXREG = cChar;\r
 238                 }\r
 239                 else\r
 240                 {\r
 241                         /* Queue empty, nothing to send. */\r
 242                         xTxHasEnded = pdTRUE;\r
 243                         break;\r
 244                 }\r
 245         }\r
 246 \r
 247         if( xHigherPriorityTaskWoken != pdFALSE )\r
 248         {\r
 249                 taskYIELD();\r
 250         }\r
 251 }\r
 252 \r
 253 \r