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

   1 /*\r
   2     FreeRTOS V7.4.0 - 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 itcan 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 V3.0.0\r
  77         + ISRcode removed. Is now pulled inline to reduce stack-usage.\r
  78 \r
  79 Changes from V3.0.1\r
  80 */\r
  81 \r
  82 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. */\r
  83 \r
  84 /* Scheduler header files. */\r
  85 #include "FreeRTOS.h"\r
  86 #include "task.h"\r
  87 #include "queue.h"\r
  88 \r
  89 #include "serial.h"\r
  90 \r
  91 /* Hardware pin definitions. */\r
  92 #define serTX_PIN                               bTRC6\r
  93 #define serRX_PIN                               bTRC7\r
  94 \r
  95 /* Bit/register definitions. */\r
  96 #define serINPUT                                ( 1 )\r
  97 #define serOUTPUT                               ( 0 )\r
  98 #define serINTERRUPT_ENABLED    ( 1 )\r
  99 \r
 100 /* All ISR's use the PIC18 low priority interrupt. */\r
 101 #define serLOW_PRIORITY                 ( 0 )\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Queues to interface between comms API and interrupt routines. */\r
 106 xQueueHandle xRxedChars; \r
 107 xQueueHandle xCharsForTx;\r
 108 portBASE_TYPE xHigherPriorityTaskWoken;\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned char ucQueueLength )\r
 113 {\r
 114         unsigned short usSPBRG;\r
 115         \r
 116         /* Create the queues used by the ISR's to interface to tasks. */\r
 117         xRxedChars = xQueueCreate( ucQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 118         xCharsForTx = xQueueCreate( ucQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 119 \r
 120         portENTER_CRITICAL();\r
 121 \r
 122         /* Setup the IO pins to enable the USART IO. */\r
 123         serTX_PIN       = serINPUT;             // YES really! See datasheet\r
 124         serRX_PIN       = serINPUT;\r
 125 \r
 126         /* Set the TX config register. */\r
 127         TXSTA = 0b00100000;\r
 128                 //        ||||||||--bit0: TX9D  = n/a\r
 129                 //        |||||||---bit1: TRMT  = ReadOnly\r
 130                 //        ||||||----bit2: BRGH  = High speed\r
 131                 //        |||||-----bit3: SENDB = n/a\r
 132                 //        ||||------bit4: SYNC  = Asynchronous mode\r
 133                 //        |||-------bit5: TXEN  = Transmit enable\r
 134                 //        ||--------bit6: TX9   = 8-bit transmission\r
 135                 //        |---------bit7: CSRC  = n/a\r
 136 \r
 137         /* Set the Receive config register. */\r
 138         RCSTA = 0b10010000;\r
 139                 //        ||||||||--bit0: RX9D  = ReadOnly\r
 140                 //        |||||||---bit1: OERR  = ReadOnly\r
 141                 //        ||||||----bit2: FERR  = ReadOnly\r
 142                 //        |||||-----bit3: ADDEN = n/a\r
 143                 //        ||||------bit4: CREN  = Enable receiver\r
 144                 //        |||-------bit5: SREN  = n/a\r
 145                 //        ||--------bit6: RX9   = 8-bit reception\r
 146                 //        |---------bit7: SPEN  = Serial port enabled\r
 147 \r
 148         /* Calculate the baud rate generator value.\r
 149            We use low-speed (BRGH=0), the formula is\r
 150            SPBRG = ( ( FOSC / Desired Baud Rate ) / 64 ) - 1 */\r
 151         usSPBRG = ( ( APROCFREQ / ulWantedBaud ) / 64 ) - 1;\r
 152         if( usSPBRG > 255 )\r
 153         {\r
 154                 SPBRG = 255;\r
 155         }\r
 156         else\r
 157         {\r
 158                 SPBRG = usSPBRG;\r
 159         }\r
 160 \r
 161         /* Set the serial interrupts to use the same priority as the tick. */\r
 162         bTXIP = serLOW_PRIORITY;\r
 163         bRCIP = serLOW_PRIORITY;\r
 164 \r
 165         /* Enable the Rx interrupt now, the Tx interrupt will get enabled when\r
 166         we have data to send. */\r
 167         bRCIE = serINTERRUPT_ENABLED;\r
 168         \r
 169         portEXIT_CRITICAL();\r
 170 \r
 171         /* Unlike other ports, this serial code does not allow for more than one\r
 172         com port.  We therefore don't return a pointer to a port structure and \r
 173         can     instead just return NULL. */\r
 174         return NULL;\r
 175 }\r
 176 /*-----------------------------------------------------------*/\r
 177 \r
 178 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned char ucBufferLength )\r
 179 {\r
 180         /* This is not implemented in this port.\r
 181         Use xSerialPortInitMinimal() instead. */\r
 182         return NULL;\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, char *pcRxedChar, portTickType xBlockTime )\r
 187 {\r
 188         /* Get the next character from the buffer.  Return false if no characters\r
 189         are available, or arrive before xBlockTime expires. */\r
 190         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 191         {\r
 192                 return ( char ) pdTRUE;\r
 193         }\r
 194 \r
 195         return ( char ) pdFALSE;\r
 196 }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, char cOutChar, portTickType xBlockTime )\r
 200 {\r
 201         /* Return false if after the block time there is no room on the Tx queue. */\r
 202         if( xQueueSend( xCharsForTx, ( const void * ) &cOutChar, xBlockTime ) != ( char ) pdPASS )\r
 203         {\r
 204                 return pdFAIL;\r
 205         }\r
 206 \r
 207         /* Turn interrupt on - ensure the compiler only generates a single \r
 208         instruction for this. */\r
 209         bTXIE = serINTERRUPT_ENABLED;\r
 210 \r
 211         return pdPASS;\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 void vSerialClose( xComPortHandle xPort )\r
 216 {\r
 217         /* Not implemented for this port.\r
 218         To implement, turn off the interrupts and delete the memory\r
 219         allocated to the queues. */\r
 220 }\r