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

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