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

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