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

   1 /*\r
   2         FreeRTOS.org V5.0.2 - Copyright (C) 2003-2008 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     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
  30     * and even write all or part of your application on your behalf.          *\r
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
  32     * expedite your project.                                                  *\r
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 \r
  51 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. \r
  52 \r
  53 NOTE:  This driver is primarily to test the scheduler functionality.  It does\r
  54 not effectively use the buffers or DMA and is therefore not intended to be\r
  55 an example of an efficient driver. */\r
  56 \r
  57 /* Standard include file. */\r
  58 #include <stdlib.h>\r
  59 \r
  60 /* Scheduler include files. */\r
  61 #include "FreeRTOS.h"\r
  62 #include "queue.h"\r
  63 #include "task.h"\r
  64 \r
  65 /* Demo app include files. */\r
  66 #include "serial.h"\r
  67 \r
  68 /* Hardware setup. */\r
  69 #define serOUTPUT                                               0\r
  70 #define serINPUT                                                1\r
  71 #define serLOW_SPEED                                    0\r
  72 #define serONE_STOP_BIT                                 0\r
  73 #define serEIGHT_DATA_BITS_NO_PARITY    0\r
  74 #define serNORMAL_IDLE_STATE                    0\r
  75 #define serAUTO_BAUD_OFF                                0\r
  76 #define serLOOPBACK_OFF                                 0\r
  77 #define serWAKE_UP_DISABLE                              0\r
  78 #define serNO_HARDWARE_FLOW_CONTROL             0\r
  79 #define serSTANDARD_IO                                  0\r
  80 #define serNO_IRDA                                              0\r
  81 #define serCONTINUE_IN_IDLE_MODE                0\r
  82 #define serUART_ENABLED                                 1\r
  83 #define serINTERRUPT_ON_SINGLE_CHAR             0\r
  84 #define serTX_ENABLE                                    1\r
  85 #define serINTERRUPT_ENABLE                             1\r
  86 #define serINTERRUPT_DISABLE                    0\r
  87 #define serCLEAR_FLAG                                   0\r
  88 #define serSET_FLAG                                             1\r
  89 \r
  90 \r
  91 /* The queues used to communicate between tasks and ISR's. */\r
  92 static xQueueHandle xRxedChars; \r
  93 static xQueueHandle xCharsForTx; \r
  94 \r
  95 static portBASE_TYPE xTxHasEnded;\r
  96 /*-----------------------------------------------------------*/\r
  97 \r
  98 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  99 {\r
 100 portCHAR cChar;\r
 101 \r
 102         /* Create the queues used by the com test task. */\r
 103         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 104         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 105 \r
 106         /* Setup the UART. */\r
 107         U2MODEbits.BRGH         = serLOW_SPEED;\r
 108         U2MODEbits.STSEL        = serONE_STOP_BIT;\r
 109         U2MODEbits.PDSEL        = serEIGHT_DATA_BITS_NO_PARITY;\r
 110         U2MODEbits.RXINV        = serNORMAL_IDLE_STATE;\r
 111         U2MODEbits.ABAUD        = serAUTO_BAUD_OFF;\r
 112         U2MODEbits.LPBACK       = serLOOPBACK_OFF;\r
 113         U2MODEbits.WAKE         = serWAKE_UP_DISABLE;\r
 114         U2MODEbits.UEN          = serNO_HARDWARE_FLOW_CONTROL;\r
 115         U2MODEbits.IREN         = serNO_IRDA;\r
 116         U2MODEbits.USIDL        = serCONTINUE_IN_IDLE_MODE;\r
 117         U2MODEbits.UARTEN       = serUART_ENABLED;\r
 118 \r
 119         U2BRG = (unsigned portSHORT)(( (float)configCPU_CLOCK_HZ / ( (float)16 * (float)ulWantedBaud ) ) - (float)0.5);\r
 120 \r
 121         U2STAbits.URXISEL       = serINTERRUPT_ON_SINGLE_CHAR;\r
 122         U2STAbits.UTXEN         = serTX_ENABLE;\r
 123         U2STAbits.UTXINV        = serNORMAL_IDLE_STATE;\r
 124         U2STAbits.UTXISEL0      = serINTERRUPT_ON_SINGLE_CHAR;\r
 125         U2STAbits.UTXISEL1      = serINTERRUPT_ON_SINGLE_CHAR;\r
 126 \r
 127         /* It is assumed that this function is called prior to the scheduler being\r
 128         started.  Therefore interrupts must not be allowed to occur yet as they\r
 129         may attempt to perform a context switch. */\r
 130         portDISABLE_INTERRUPTS();\r
 131 \r
 132         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 133         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 134         IPC7bits.U2RXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 135         IPC7bits.U2TXIP = configKERNEL_INTERRUPT_PRIORITY;\r
 136         IEC1bits.U2TXIE = serINTERRUPT_ENABLE;\r
 137         IEC1bits.U2RXIE = serINTERRUPT_ENABLE;\r
 138 \r
 139         /* Clear the Rx buffer. */\r
 140         while( U2STAbits.URXDA == serSET_FLAG )\r
 141         {\r
 142                 cChar = U2RXREG;\r
 143         }\r
 144 \r
 145         xTxHasEnded = pdTRUE;\r
 146 \r
 147         return NULL;\r
 148 }\r
 149 /*-----------------------------------------------------------*/\r
 150 \r
 151 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 152 {\r
 153         /* Only one port is supported. */\r
 154         ( void ) pxPort;\r
 155 \r
 156         /* Get the next character from the buffer.  Return false if no characters\r
 157         are available or arrive before xBlockTime expires. */\r
 158         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 159         {\r
 160                 return pdTRUE;\r
 161         }\r
 162         else\r
 163         {\r
 164                 return pdFALSE;\r
 165         }\r
 166 }\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 170 {\r
 171         /* Only one port is supported. */\r
 172         ( void ) pxPort;\r
 173 \r
 174         /* Return false if after the block time there is no room on the Tx queue. */\r
 175         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 176         {\r
 177                 return pdFAIL;\r
 178         }\r
 179 \r
 180         /* A critical section should not be required as xTxHasEnded will not be\r
 181         written to by the ISR if it is already 0 (is this correct?). */\r
 182         if( xTxHasEnded )\r
 183         {\r
 184                 xTxHasEnded = pdFALSE;\r
 185                 IFS1bits.U2TXIF = serSET_FLAG;\r
 186         }\r
 187 \r
 188         return pdPASS;\r
 189 }\r
 190 /*-----------------------------------------------------------*/\r
 191 \r
 192 void vSerialClose( xComPortHandle xPort )\r
 193 {\r
 194 }\r
 195 /*-----------------------------------------------------------*/\r
 196 \r
 197 void __attribute__((__interrupt__, auto_psv)) _U2RXInterrupt( void )\r
 198 {\r
 199 portCHAR cChar;\r
 200 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 201 \r
 202         /* Get the character and post it on the queue of Rxed characters.\r
 203         If the post causes a task to wake force a context switch as the woken task\r
 204         may have a higher priority than the task we have interrupted. */\r
 205         IFS1bits.U2RXIF = serCLEAR_FLAG;\r
 206         while( U2STAbits.URXDA )\r
 207         {\r
 208                 cChar = U2RXREG;\r
 209                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 210         }\r
 211 \r
 212         if( xHigherPriorityTaskWoken != pdFALSE )\r
 213         {\r
 214                 taskYIELD();\r
 215         }\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 void __attribute__((__interrupt__, auto_psv)) _U2TXInterrupt( void )\r
 220 {\r
 221 signed portCHAR cChar;\r
 222 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 223 \r
 224         /* If the transmit buffer is full we cannot get the next character.\r
 225         Another interrupt will occur the next time there is space so this does\r
 226         not matter. */\r
 227         IFS1bits.U2TXIF = serCLEAR_FLAG;\r
 228         while( !( U2STAbits.UTXBF ) )\r
 229         {\r
 230                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 231                 {\r
 232                         /* Send the next character queued for Tx. */\r
 233                         U2TXREG = cChar;\r
 234                 }\r
 235                 else\r
 236                 {\r
 237                         /* Queue empty, nothing to send. */\r
 238                         xTxHasEnded = pdTRUE;\r
 239                         break;\r
 240                 }\r
 241         }\r
 242 \r
 243         if( xHigherPriorityTaskWoken != pdFALSE )\r
 244         {\r
 245                 taskYIELD();\r
 246         }\r
 247 }\r
 248 \r
 249 \r