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

   1 /*\r
   2     FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4     This file is part of the FreeRTOS distribution.\r
   5 \r
   6     FreeRTOS is free software; you can redistribute it and/or modify it    under\r
   7     the terms of the GNU General Public License (version 2) as published by the\r
   8     Free Software Foundation and modified by the FreeRTOS exception.\r
   9     **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10     combined work that includes FreeRTOS without being obliged to provide the\r
  11     source code for proprietary components outside of the FreeRTOS kernel.\r
  12     Alternative commercial license and support terms are also available upon\r
  13     request.  See the licensing section of http://www.FreeRTOS.org for full\r
  14     license details.\r
  15 \r
  16     FreeRTOS is distributed in the hope that it will be useful,    but WITHOUT\r
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19     more details.\r
  20 \r
  21     You should have received a copy of the GNU General Public License along\r
  22     with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23     Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26     ***************************************************************************\r
  27     *                                                                         *\r
  28     * The FreeRTOS eBook and reference manual are available to purchase for a *\r
  29     * small fee. Help yourself get started quickly while also helping the     *\r
  30     * FreeRTOS project! See http://www.FreeRTOS.org/Documentation for details *\r
  31     *                                                                         *\r
  32     ***************************************************************************\r
  33 \r
  34     1 tab == 4 spaces!\r
  35 \r
  36     Please ensure to read the configuration and relevant port sections of the\r
  37     online documentation.\r
  38 \r
  39     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  40     contact details.\r
  41 \r
  42     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  43     critical systems.\r
  44 \r
  45     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  46     licensing and training services.\r
  47 */\r
  48 \r
  49 \r
  50 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. \r
  51 \r
  52 NOTE:  This driver is primarily to test the scheduler functionality.  It does\r
  53 not effectively use the buffers or DMA and is therefore not intended to be\r
  54 an example of an efficient driver. */\r
  55 \r
  56 /* Standard include file. */\r
  57 #include <stdlib.h>\r
  58 \r
  59 /* Scheduler include files. */\r
  60 #include "FreeRTOS.h"\r
  61 #include "queue.h"\r
  62 #include "task.h"\r
  63 \r
  64 /* Demo app include files. */\r
  65 #include "serial.h"\r
  66 \r
  67 /* Hardware setup. */\r
  68 #define serOUTPUT                                               0\r
  69 #define serINPUT                                                1\r
  70 #define serLOW_SPEED                                    0\r
  71 #define serONE_STOP_BIT                                 0\r
  72 #define serEIGHT_DATA_BITS_NO_PARITY    0\r
  73 #define serNORMAL_IDLE_STATE                    0\r
  74 #define serAUTO_BAUD_OFF                                0\r
  75 #define serLOOPBACK_OFF                                 0\r
  76 #define serWAKE_UP_DISABLE                              0\r
  77 #define serNO_HARDWARE_FLOW_CONTROL             0\r
  78 #define serSTANDARD_IO                                  0\r
  79 #define serNO_IRDA                                              0\r
  80 #define serCONTINUE_IN_IDLE_MODE                0\r
  81 #define serUART_ENABLED                                 1\r
  82 #define serINTERRUPT_ON_SINGLE_CHAR             0\r
  83 #define serTX_ENABLE                                    1\r
  84 #define serINTERRUPT_ENABLE                             1\r
  85 #define serINTERRUPT_DISABLE                    0\r
  86 #define serCLEAR_FLAG                                   0\r
  87 #define serSET_FLAG                                             1\r
  88 \r
  89 \r
  90 /* The queues used to communicate between tasks and ISR's. */\r
  91 static xQueueHandle xRxedChars; \r
  92 static xQueueHandle xCharsForTx; \r
  93 \r
  94 static portBASE_TYPE xTxHasEnded;\r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  98 {\r
  99 char cChar;\r
 100 \r
 101         /* Create the queues used by the com test task. */\r
 102         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 103         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 104 \r
 105         /* Setup the UART. */\r
 106         U2MODEbits.BRGH         = serLOW_SPEED;\r
 107         U2MODEbits.STSEL        = serONE_STOP_BIT;\r
 108         U2MODEbits.PDSEL        = serEIGHT_DATA_BITS_NO_PARITY;\r
 109         U2MODEbits.ABAUD        = serAUTO_BAUD_OFF;\r
 110         U2MODEbits.LPBACK       = serLOOPBACK_OFF;\r
 111         U2MODEbits.WAKE         = serWAKE_UP_DISABLE;\r
 112         U2MODEbits.UEN          = serNO_HARDWARE_FLOW_CONTROL;\r
 113         U2MODEbits.IREN         = serNO_IRDA;\r
 114         U2MODEbits.USIDL        = serCONTINUE_IN_IDLE_MODE;\r
 115         U2MODEbits.UARTEN       = serUART_ENABLED;\r
 116 \r
 117         U2BRG = (unsigned short)(( (float)configCPU_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 118 \r
 119         U2STAbits.URXISEL       = serINTERRUPT_ON_SINGLE_CHAR;\r
 120         U2STAbits.UTXEN         = serTX_ENABLE;\r
 121         U2STAbits.UTXINV        = serNORMAL_IDLE_STATE;\r
 122         U2STAbits.UTXISEL0      = serINTERRUPT_ON_SINGLE_CHAR;\r
 123         U2STAbits.UTXISEL1      = serINTERRUPT_ON_SINGLE_CHAR;\r
 124 \r
 125         /* It is assumed that this function is called prior to the scheduler being\r
 126         started.  Therefore interrupts must not be allowed to occur yet as they\r
 127         may attempt to perform a context switch. */\r
 128         portDISABLE_INTERRUPTS();\r
 129 \r
 130         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 131         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 132         IPC7bits.U2RXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 133         IPC7bits.U2TXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 134         IEC1bits.U2TXIE = serINTERRUPT_ENABLE;\r
 135         IEC1bits.U2RXIE = serINTERRUPT_ENABLE;\r
 136 \r
 137         /* Clear the Rx buffer. */\r
 138         while( U2STAbits.URXDA == serSET_FLAG )\r
 139         {\r
 140                 cChar = U2RXREG;\r
 141         }\r
 142 \r
 143         xTxHasEnded = pdTRUE;\r
 144 \r
 145         return NULL;\r
 146 }\r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 150 {\r
 151         /* Only one port is supported. */\r
 152         ( void ) pxPort;\r
 153 \r
 154         /* Get the next character from the buffer.  Return false if no characters\r
 155         are available or arrive before xBlockTime expires. */\r
 156         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 157         {\r
 158                 return pdTRUE;\r
 159         }\r
 160         else\r
 161         {\r
 162                 return pdFALSE;\r
 163         }\r
 164 }\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 168 {\r
 169         /* Only one port is supported. */\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* Return false if after the block time there is no room on the Tx queue. */\r
 173         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 174         {\r
 175                 return pdFAIL;\r
 176         }\r
 177 \r
 178         /* A critical section should not be required as xTxHasEnded will not be\r
 179         written to by the ISR if it is already 0 (is this correct?). */\r
 180         if( xTxHasEnded )\r
 181         {\r
 182                 xTxHasEnded = pdFALSE;\r
 183                 IFS1bits.U2TXIF = serSET_FLAG;\r
 184         }\r
 185 \r
 186         return pdPASS;\r
 187 }\r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 void vSerialClose( xComPortHandle xPort )\r
 191 {\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 void __attribute__((__interrupt__, auto_psv)) _U2RXInterrupt( void )\r
 196 {\r
 197 char cChar;\r
 198 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 199 \r
 200         /* Get the character and post it on the queue of Rxed characters.\r
 201         If the post causes a task to wake force a context switch as the woken task\r
 202         may have a higher priority than the task we have interrupted. */\r
 203         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 204         while( U2STAbits.URXDA )\r
 205         {\r
 206                 cChar = U2RXREG;\r
 207                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 208         }\r
 209 \r
 210         if( xHigherPriorityTaskWoken != pdFALSE )\r
 211         {\r
 212                 taskYIELD();\r
 213         }\r
 214 }\r
 215 /*-----------------------------------------------------------*/\r
 216 \r
 217 void __attribute__((__interrupt__, auto_psv)) _U2TXInterrupt( void )\r
 218 {\r
 219 signed char cChar;\r
 220 portBASE_TYPE xTaskWoken = pdFALSE;\r
 221 \r
 222         /* If the transmit buffer is full we cannot get the next character.\r
 223         Another interrupt will occur the next time there is space so this does\r
 224         not matter. */\r
 225         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 226         while( !( U2STAbits.UTXBF ) )\r
 227         {\r
 228                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 229                 {\r
 230                         /* Send the next character queued for Tx. */\r
 231                         U2TXREG = cChar;\r
 232                 }\r
 233                 else\r
 234                 {\r
 235                         /* Queue empty, nothing to send. */\r
 236                         xTxHasEnded = pdTRUE;\r
 237                         break;\r
 238                 }\r
 239         }\r
 240 \r
 241         if( xTaskWoken != pdFALSE )\r
 242         {\r
 243                 taskYIELD();\r
 244         }\r
 245 }\r
 246 \r
 247 \r