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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76 Changes from V1.2.5\r
  77 \r
  78         +  Clear overrun errors in the Rx ISR.  Overrun errors prevent any further\r
  79            characters being received.\r
  80 \r
  81 Changes from V2.0.0\r
  82 \r
  83         + Use portTickType in place of unsigned pdLONG for delay periods.\r
  84         + cQueueReieveFromISR() used in place of xQueueReceive() in ISR.\r
  85 */\r
  86 \r
  87 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. */\r
  88 \r
  89 /* Scheduler header files. */\r
  90 #include "FreeRTOS.h"\r
  91 #include "task.h"\r
  92 #include "serial.h"\r
  93 #include "queue.h"\r
  94 \r
  95 /*\r
  96  * Prototypes for ISR's.  The PIC architecture means that these functions\r
  97  * have to be called from port.c.  The prototypes are not however included\r
  98  * in the header as the header is common to all ports.\r
  99  */\r
 100 void vSerialTxISR( void );\r
 101 void vSerialRxISR( void );\r
 102 \r
 103 /* Hardware pin definitions. */\r
 104 #define serTX_PIN       TRISCbits.TRISC6\r
 105 #define serRX_PIN       TRISCbits.TRISC7\r
 106 \r
 107 /* Bit/register definitions. */\r
 108 #define serINPUT                                ( 1 )\r
 109 #define serOUTPUT                               ( 0 )\r
 110 #define serTX_ENABLE                    ( ( unsigned short ) 1 )\r
 111 #define serRX_ENABLE                    ( ( unsigned short ) 1 )\r
 112 #define serHIGH_SPEED                   ( ( unsigned short ) 1 )\r
 113 #define serCONTINUOUS_RX                ( ( unsigned short ) 1 )\r
 114 #define serCLEAR_OVERRUN                ( ( unsigned short ) 0 )\r
 115 #define serINTERRUPT_ENABLED    ( ( unsigned short ) 1 )\r
 116 #define serINTERRUPT_DISABLED   ( ( unsigned short ) 0 )\r
 117 \r
 118 /* All ISR's use the PIC18 low priority interrupt. */\r
 119 #define                                                 serLOW_PRIORITY ( 0 )\r
 120 \r
 121 /*-----------------------------------------------------------*/\r
 122 \r
 123 /* Queues to interface between comms API and interrupt routines. */\r
 124 static xQueueHandle xRxedChars; \r
 125 static xQueueHandle xCharsForTx;\r
 126 \r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 130 {\r
 131 unsigned long ulBaud;\r
 132 \r
 133         /* Calculate the baud rate generator constant.\r
 134         SPBRG = ( (FOSC / Desired Baud Rate) / 16 ) - 1 */\r
 135         ulBaud = configCPU_CLOCK_HZ / ulWantedBaud;\r
 136         ulBaud /= ( unsigned long ) 16;\r
 137         ulBaud -= ( unsigned long ) 1;\r
 138 \r
 139         /* Create the queues used by the ISR's to interface to tasks. */\r
 140         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 141         xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 142 \r
 143         portENTER_CRITICAL();\r
 144         {\r
 145                 /* Start with config registers cleared, so we can just set the wanted\r
 146                 bits. */\r
 147                 TXSTA = ( unsigned short ) 0;\r
 148                 RCSTA = ( unsigned short ) 0;\r
 149 \r
 150                 /* Set the baud rate generator using the above calculated constant. */\r
 151                 SPBRG = ( unsigned char ) ulBaud;\r
 152 \r
 153                 /* Setup the IO pins to enable the USART IO. */\r
 154                 serTX_PIN = serOUTPUT;\r
 155                 serRX_PIN = serINPUT;\r
 156 \r
 157                 /* Set the serial interrupts to use the same priority as the tick. */\r
 158                 IPR1bits.TXIP = serLOW_PRIORITY;\r
 159                 IPR1bits.RCIP = serLOW_PRIORITY;\r
 160 \r
 161                 /* Setup Tx configuration. */\r
 162                 TXSTAbits.BRGH = serHIGH_SPEED;\r
 163                 TXSTAbits.TXEN = serTX_ENABLE;\r
 164 \r
 165                 /* Setup Rx configuration. */\r
 166                 RCSTAbits.SPEN = serRX_ENABLE;\r
 167                 RCSTAbits.CREN = serCONTINUOUS_RX;\r
 168 \r
 169                 /* Enable the Rx interrupt now, the Tx interrupt will get enabled when\r
 170                 we have data to send. */\r
 171                 PIE1bits.RCIE = serINTERRUPT_ENABLED;\r
 172         }\r
 173         portEXIT_CRITICAL();\r
 174 \r
 175         /* Unlike other ports, this serial code does not allow for more than one\r
 176         com port.  We therefore don't return a pointer to a port structure and \r
 177         can     instead just return NULL. */\r
 178         return NULL;\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned portBASE_TYPE uxBufferLength )\r
 183 {\r
 184         /* This is not implemented in this port.\r
 185         Use xSerialPortInitMinimal() instead. */\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 190 {\r
 191         /* Get the next character from the buffer.  Return false if no characters\r
 192         are available, or arrive before xBlockTime expires. */\r
 193         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 194         {\r
 195                 return pdTRUE;\r
 196         }\r
 197         else\r
 198         {\r
 199                 return pdFALSE;\r
 200         }\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 205 {\r
 206         /* Return false if after the block time there is no room on the Tx queue. */\r
 207         if( xQueueSend( xCharsForTx, ( const void * ) &cOutChar, xBlockTime ) != pdPASS )\r
 208         {\r
 209                 return pdFAIL;\r
 210         }\r
 211 \r
 212         /* Turn interrupt on - ensure the compiler only generates a single \r
 213         instruction for this. */\r
 214         PIE1bits.TXIE = serINTERRUPT_ENABLED;\r
 215 \r
 216         return pdPASS;\r
 217 }\r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 void vSerialClose( xComPortHandle xPort )\r
 221 {\r
 222         /* Not implemented for this port.\r
 223         To implement, turn off the interrupts and delete the memory\r
 224         allocated to the queues. */\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 #pragma interruptlow vSerialRxISR save=PRODH, PRODL, TABLAT, section(".tmpdata")\r
 229 void vSerialRxISR( void )\r
 230 {\r
 231 char cChar;\r
 232 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 233 \r
 234         /* Get the character and post it on the queue of Rxed characters.\r
 235         If the post causes a task to wake force a context switch as the woken task\r
 236         may have a higher priority than the task we have interrupted. */\r
 237         cChar = RCREG;\r
 238 \r
 239         /* Clear any overrun errors. */\r
 240         if( RCSTAbits.OERR )\r
 241         {\r
 242                 RCSTAbits.CREN = serCLEAR_OVERRUN;\r
 243                 RCSTAbits.CREN = serCONTINUOUS_RX;      \r
 244         }\r
 245 \r
 246         xQueueSendFromISR( xRxedChars, ( const void * ) &cChar, &xHigherPriorityTaskWoken );\r
 247 \r
 248         if( xHigherPriorityTaskWoken )\r
 249         {\r
 250                 taskYIELD();\r
 251         }\r
 252 }\r
 253 /*-----------------------------------------------------------*/\r
 254 \r
 255 #pragma interruptlow vSerialTxISR save=PRODH, PRODL, TABLAT, section(".tmpdata")\r
 256 void vSerialTxISR( void )\r
 257 {\r
 258 char cChar, cTaskWoken = pdFALSE;\r
 259 \r
 260         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &cTaskWoken ) == pdTRUE )\r
 261         {\r
 262                 /* Send the next character queued for Tx. */\r
 263                 TXREG = cChar;\r
 264         }\r
 265         else\r
 266         {\r
 267                 /* Queue empty, nothing to send. */\r
 268                 PIE1bits.TXIE = serINTERRUPT_DISABLED;\r
 269         }\r
 270 }\r
 271 \r
 272 \r
 273 \r