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