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

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