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

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 \r
  70 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. \r
  71 \r
  72 NOTE:  This driver is primarily to test the scheduler functionality.  It does\r
  73 not effectively use the buffers or DMA and is therefore not intended to be\r
  74 an example of an efficient driver. */\r
  75 \r
  76 /* Standard include file. */\r
  77 #include <stdlib.h>\r
  78 \r
  79 /* Scheduler include files. */\r
  80 #include "FreeRTOS.h"\r
  81 #include "queue.h"\r
  82 #include "task.h"\r
  83 \r
  84 /* Demo app include files. */\r
  85 #include "serial.h"\r
  86 \r
  87 /* Hardware setup. */\r
  88 #define serOUTPUT                                               0\r
  89 #define serINPUT                                                1\r
  90 #define serLOW_SPEED                                    0\r
  91 #define serONE_STOP_BIT                                 0\r
  92 #define serEIGHT_DATA_BITS_NO_PARITY    0\r
  93 #define serNORMAL_IDLE_STATE                    0\r
  94 #define serAUTO_BAUD_OFF                                0\r
  95 #define serLOOPBACK_OFF                                 0\r
  96 #define serWAKE_UP_DISABLE                              0\r
  97 #define serNO_HARDWARE_FLOW_CONTROL             0\r
  98 #define serSTANDARD_IO                                  0\r
  99 #define serNO_IRDA                                              0\r
 100 #define serCONTINUE_IN_IDLE_MODE                0\r
 101 #define serUART_ENABLED                                 1\r
 102 #define serINTERRUPT_ON_SINGLE_CHAR             0\r
 103 #define serTX_ENABLE                                    1\r
 104 #define serINTERRUPT_ENABLE                             1\r
 105 #define serINTERRUPT_DISABLE                    0\r
 106 #define serCLEAR_FLAG                                   0\r
 107 #define serSET_FLAG                                             1\r
 108 \r
 109 \r
 110 /* The queues used to communicate between tasks and ISR's. */\r
 111 static xQueueHandle xRxedChars; \r
 112 static xQueueHandle xCharsForTx; \r
 113 \r
 114 static portBASE_TYPE xTxHasEnded;\r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 118 {\r
 119 char cChar;\r
 120 \r
 121         /* Create the queues used by the com test task. */\r
 122         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 123         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 124 \r
 125         /* Setup the UART. */\r
 126         U2MODEbits.BRGH         = serLOW_SPEED;\r
 127         U2MODEbits.STSEL        = serONE_STOP_BIT;\r
 128         U2MODEbits.PDSEL        = serEIGHT_DATA_BITS_NO_PARITY;\r
 129         U2MODEbits.ABAUD        = serAUTO_BAUD_OFF;\r
 130         U2MODEbits.LPBACK       = serLOOPBACK_OFF;\r
 131         U2MODEbits.WAKE         = serWAKE_UP_DISABLE;\r
 132         U2MODEbits.UEN          = serNO_HARDWARE_FLOW_CONTROL;\r
 133         U2MODEbits.IREN         = serNO_IRDA;\r
 134         U2MODEbits.USIDL        = serCONTINUE_IN_IDLE_MODE;\r
 135         U2MODEbits.UARTEN       = serUART_ENABLED;\r
 136 \r
 137         U2BRG = (unsigned short)(( (float)configCPU_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 138 \r
 139         U2STAbits.URXISEL       = serINTERRUPT_ON_SINGLE_CHAR;\r
 140         U2STAbits.UTXEN         = serTX_ENABLE;\r
 141         U2STAbits.UTXINV        = serNORMAL_IDLE_STATE;\r
 142         U2STAbits.UTXISEL0      = serINTERRUPT_ON_SINGLE_CHAR;\r
 143         U2STAbits.UTXISEL1      = serINTERRUPT_ON_SINGLE_CHAR;\r
 144 \r
 145         /* It is assumed that this function is called prior to the scheduler being\r
 146         started.  Therefore interrupts must not be allowed to occur yet as they\r
 147         may attempt to perform a context switch. */\r
 148         portDISABLE_INTERRUPTS();\r
 149 \r
 150         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 151         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 152         IPC7bits.U2RXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 153         IPC7bits.U2TXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 154         IEC1bits.U2TXIE = serINTERRUPT_ENABLE;\r
 155         IEC1bits.U2RXIE = serINTERRUPT_ENABLE;\r
 156 \r
 157         /* Clear the Rx buffer. */\r
 158         while( U2STAbits.URXDA == serSET_FLAG )\r
 159         {\r
 160                 cChar = U2RXREG;\r
 161         }\r
 162 \r
 163         xTxHasEnded = pdTRUE;\r
 164 \r
 165         return NULL;\r
 166 }\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 170 {\r
 171         /* Only one port is supported. */\r
 172         ( void ) pxPort;\r
 173 \r
 174         /* Get the next character from the buffer.  Return false if no characters\r
 175         are available or arrive before xBlockTime expires. */\r
 176         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 177         {\r
 178                 return pdTRUE;\r
 179         }\r
 180         else\r
 181         {\r
 182                 return pdFALSE;\r
 183         }\r
 184 }\r
 185 /*-----------------------------------------------------------*/\r
 186 \r
 187 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 188 {\r
 189         /* Only one port is supported. */\r
 190         ( void ) pxPort;\r
 191 \r
 192         /* Return false if after the block time there is no room on the Tx queue. */\r
 193         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 194         {\r
 195                 return pdFAIL;\r
 196         }\r
 197 \r
 198         /* A critical section should not be required as xTxHasEnded will not be\r
 199         written to by the ISR if it is already 0 (is this correct?). */\r
 200         if( xTxHasEnded )\r
 201         {\r
 202                 xTxHasEnded = pdFALSE;\r
 203                 IFS1bits.U2TXIF = serSET_FLAG;\r
 204         }\r
 205 \r
 206         return pdPASS;\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 void vSerialClose( xComPortHandle xPort )\r
 211 {\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 void __attribute__((__interrupt__, auto_psv)) _U2RXInterrupt( void )\r
 216 {\r
 217 char cChar;\r
 218 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 219 \r
 220         /* Get the character and post it on the queue of Rxed characters.\r
 221         If the post causes a task to wake force a context switch as the woken task\r
 222         may have a higher priority than the task we have interrupted. */\r
 223         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 224         while( U2STAbits.URXDA )\r
 225         {\r
 226                 cChar = U2RXREG;\r
 227                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 228         }\r
 229 \r
 230         if( xHigherPriorityTaskWoken != pdFALSE )\r
 231         {\r
 232                 taskYIELD();\r
 233         }\r
 234 }\r
 235 /*-----------------------------------------------------------*/\r
 236 \r
 237 void __attribute__((__interrupt__, auto_psv)) _U2TXInterrupt( void )\r
 238 {\r
 239 signed char cChar;\r
 240 portBASE_TYPE xTaskWoken = pdFALSE;\r
 241 \r
 242         /* If the transmit buffer is full we cannot get the next character.\r
 243         Another interrupt will occur the next time there is space so this does\r
 244         not matter. */\r
 245         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 246         while( !( U2STAbits.UTXBF ) )\r
 247         {\r
 248                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 249                 {\r
 250                         /* Send the next character queued for Tx. */\r
 251                         U2TXREG = cChar;\r
 252                 }\r
 253                 else\r
 254                 {\r
 255                         /* Queue empty, nothing to send. */\r
 256                         xTxHasEnded = pdTRUE;\r
 257                         break;\r
 258                 }\r
 259         }\r
 260 \r
 261         if( xTaskWoken != pdFALSE )\r
 262         {\r
 263                 taskYIELD();\r
 264         }\r
 265 }\r
 266 \r
 267 \r