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

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