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

   1 /*\r
   2     FreeRTOS V7.1.1 - 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.ABAUD        = serAUTO_BAUD_OFF;\r
 128         U2MODEbits.LPBACK       = serLOOPBACK_OFF;\r
 129         U2MODEbits.WAKE         = serWAKE_UP_DISABLE;\r
 130         U2MODEbits.UEN          = serNO_HARDWARE_FLOW_CONTROL;\r
 131         U2MODEbits.IREN         = serNO_IRDA;\r
 132         U2MODEbits.USIDL        = serCONTINUE_IN_IDLE_MODE;\r
 133         U2MODEbits.UARTEN       = serUART_ENABLED;\r
 134 \r
 135         U2BRG = (unsigned short)(( (float)configCPU_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 136 \r
 137         U2STAbits.URXISEL       = serINTERRUPT_ON_SINGLE_CHAR;\r
 138         U2STAbits.UTXEN         = serTX_ENABLE;\r
 139         U2STAbits.UTXINV        = serNORMAL_IDLE_STATE;\r
 140         U2STAbits.UTXISEL0      = serINTERRUPT_ON_SINGLE_CHAR;\r
 141         U2STAbits.UTXISEL1      = serINTERRUPT_ON_SINGLE_CHAR;\r
 142 \r
 143         /* It is assumed that this function is called prior to the scheduler being\r
 144         started.  Therefore interrupts must not be allowed to occur yet as they\r
 145         may attempt to perform a context switch. */\r
 146         portDISABLE_INTERRUPTS();\r
 147 \r
 148         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 149         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 150         IPC7bits.U2RXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 151         IPC7bits.U2TXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 152         IEC1bits.U2TXIE = serINTERRUPT_ENABLE;\r
 153         IEC1bits.U2RXIE = serINTERRUPT_ENABLE;\r
 154 \r
 155         /* Clear the Rx buffer. */\r
 156         while( U2STAbits.URXDA == serSET_FLAG )\r
 157         {\r
 158                 cChar = U2RXREG;\r
 159         }\r
 160 \r
 161         xTxHasEnded = pdTRUE;\r
 162 \r
 163         return NULL;\r
 164 }\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 168 {\r
 169         /* Only one port is supported. */\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* Get the next character from the buffer.  Return false if no characters\r
 173         are available or arrive before xBlockTime expires. */\r
 174         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 175         {\r
 176                 return pdTRUE;\r
 177         }\r
 178         else\r
 179         {\r
 180                 return pdFALSE;\r
 181         }\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 186 {\r
 187         /* Only one port is supported. */\r
 188         ( void ) pxPort;\r
 189 \r
 190         /* Return false if after the block time there is no room on the Tx queue. */\r
 191         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 192         {\r
 193                 return pdFAIL;\r
 194         }\r
 195 \r
 196         /* A critical section should not be required as xTxHasEnded will not be\r
 197         written to by the ISR if it is already 0 (is this correct?). */\r
 198         if( xTxHasEnded )\r
 199         {\r
 200                 xTxHasEnded = pdFALSE;\r
 201                 IFS1bits.U2TXIF = serSET_FLAG;\r
 202         }\r
 203 \r
 204         return pdPASS;\r
 205 }\r
 206 /*-----------------------------------------------------------*/\r
 207 \r
 208 void vSerialClose( xComPortHandle xPort )\r
 209 {\r
 210 }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213 void __attribute__((__interrupt__, auto_psv)) _U2RXInterrupt( void )\r
 214 {\r
 215 char cChar;\r
 216 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 217 \r
 218         /* Get the character and post it on the queue of Rxed characters.\r
 219         If the post causes a task to wake force a context switch as the woken task\r
 220         may have a higher priority than the task we have interrupted. */\r
 221         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 222         while( U2STAbits.URXDA )\r
 223         {\r
 224                 cChar = U2RXREG;\r
 225                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 226         }\r
 227 \r
 228         if( xHigherPriorityTaskWoken != pdFALSE )\r
 229         {\r
 230                 taskYIELD();\r
 231         }\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 void __attribute__((__interrupt__, auto_psv)) _U2TXInterrupt( void )\r
 236 {\r
 237 signed char cChar;\r
 238 portBASE_TYPE xTaskWoken = pdFALSE;\r
 239 \r
 240         /* If the transmit buffer is full we cannot get the next character.\r
 241         Another interrupt will occur the next time there is space so this does\r
 242         not matter. */\r
 243         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 244         while( !( U2STAbits.UTXBF ) )\r
 245         {\r
 246                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 247                 {\r
 248                         /* Send the next character queued for Tx. */\r
 249                         U2TXREG = cChar;\r
 250                 }\r
 251                 else\r
 252                 {\r
 253                         /* Queue empty, nothing to send. */\r
 254                         xTxHasEnded = pdTRUE;\r
 255                         break;\r
 256                 }\r
 257         }\r
 258 \r
 259         if( xTaskWoken != pdFALSE )\r
 260         {\r
 261                 taskYIELD();\r
 262         }\r
 263 }\r
 264 \r
 265 \r