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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - 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     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     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 /*\r
  97 Changes from V3.0.0\r
  98         + ISRcode removed. Is now pulled inline to reduce stack-usage.\r
  99 \r
 100 Changes from V3.0.1\r
 101 */\r
 102 \r
 103 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. */\r
 104 \r
 105 /* Scheduler header files. */\r
 106 #include "FreeRTOS.h"\r
 107 #include "task.h"\r
 108 #include "queue.h"\r
 109 \r
 110 #include "serial.h"\r
 111 \r
 112 /* Hardware pin definitions. */\r
 113 #define serTX_PIN                               bTRC6\r
 114 #define serRX_PIN                               bTRC7\r
 115 \r
 116 /* Bit/register definitions. */\r
 117 #define serINPUT                                ( 1 )\r
 118 #define serOUTPUT                               ( 0 )\r
 119 #define serINTERRUPT_ENABLED    ( 1 )\r
 120 \r
 121 /* All ISR's use the PIC18 low priority interrupt. */\r
 122 #define serLOW_PRIORITY                 ( 0 )\r
 123 \r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 /* Queues to interface between comms API and interrupt routines. */\r
 127 QueueHandle_t xRxedChars; \r
 128 QueueHandle_t xCharsForTx;\r
 129 portBASE_TYPE xHigherPriorityTaskWoken;\r
 130 \r
 131 /*-----------------------------------------------------------*/\r
 132 \r
 133 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned char ucQueueLength )\r
 134 {\r
 135         unsigned short usSPBRG;\r
 136         \r
 137         /* Create the queues used by the ISR's to interface to tasks. */\r
 138         xRxedChars = xQueueCreate( ucQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 139         xCharsForTx = xQueueCreate( ucQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 140 \r
 141         portENTER_CRITICAL();\r
 142 \r
 143         /* Setup the IO pins to enable the USART IO. */\r
 144         serTX_PIN       = serINPUT;             // YES really! See datasheet\r
 145         serRX_PIN       = serINPUT;\r
 146 \r
 147         /* Set the TX config register. */\r
 148         TXSTA = 0b00100000;\r
 149                 //        ||||||||--bit0: TX9D  = n/a\r
 150                 //        |||||||---bit1: TRMT  = ReadOnly\r
 151                 //        ||||||----bit2: BRGH  = High speed\r
 152                 //        |||||-----bit3: SENDB = n/a\r
 153                 //        ||||------bit4: SYNC  = Asynchronous mode\r
 154                 //        |||-------bit5: TXEN  = Transmit enable\r
 155                 //        ||--------bit6: TX9   = 8-bit transmission\r
 156                 //        |---------bit7: CSRC  = n/a\r
 157 \r
 158         /* Set the Receive config register. */\r
 159         RCSTA = 0b10010000;\r
 160                 //        ||||||||--bit0: RX9D  = ReadOnly\r
 161                 //        |||||||---bit1: OERR  = ReadOnly\r
 162                 //        ||||||----bit2: FERR  = ReadOnly\r
 163                 //        |||||-----bit3: ADDEN = n/a\r
 164                 //        ||||------bit4: CREN  = Enable receiver\r
 165                 //        |||-------bit5: SREN  = n/a\r
 166                 //        ||--------bit6: RX9   = 8-bit reception\r
 167                 //        |---------bit7: SPEN  = Serial port enabled\r
 168 \r
 169         /* Calculate the baud rate generator value.\r
 170            We use low-speed (BRGH=0), the formula is\r
 171            SPBRG = ( ( FOSC / Desired Baud Rate ) / 64 ) - 1 */\r
 172         usSPBRG = ( ( APROCFREQ / ulWantedBaud ) / 64 ) - 1;\r
 173         if( usSPBRG > 255 )\r
 174         {\r
 175                 SPBRG = 255;\r
 176         }\r
 177         else\r
 178         {\r
 179                 SPBRG = usSPBRG;\r
 180         }\r
 181 \r
 182         /* Set the serial interrupts to use the same priority as the tick. */\r
 183         bTXIP = serLOW_PRIORITY;\r
 184         bRCIP = serLOW_PRIORITY;\r
 185 \r
 186         /* Enable the Rx interrupt now, the Tx interrupt will get enabled when\r
 187         we have data to send. */\r
 188         bRCIE = serINTERRUPT_ENABLED;\r
 189         \r
 190         portEXIT_CRITICAL();\r
 191 \r
 192         /* Unlike other ports, this serial code does not allow for more than one\r
 193         com port.  We therefore don't return a pointer to a port structure and \r
 194         can     instead just return NULL. */\r
 195         return NULL;\r
 196 }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 xComPortHandle xSerialPortInit( eCOMPort ePort, eBaud eWantedBaud, eParity eWantedParity, eDataBits eWantedDataBits, eStopBits eWantedStopBits, unsigned char ucBufferLength )\r
 200 {\r
 201         /* This is not implemented in this port.\r
 202         Use xSerialPortInitMinimal() instead. */\r
 203         return NULL;\r
 204 }\r
 205 /*-----------------------------------------------------------*/\r
 206 \r
 207 portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, char *pcRxedChar, TickType_t xBlockTime )\r
 208 {\r
 209         /* Get the next character from the buffer.  Return false if no characters\r
 210         are available, or arrive before xBlockTime expires. */\r
 211         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 212         {\r
 213                 return ( char ) pdTRUE;\r
 214         }\r
 215 \r
 216         return ( char ) pdFALSE;\r
 217 }\r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, char cOutChar, TickType_t xBlockTime )\r
 221 {\r
 222         /* Return false if after the block time there is no room on the Tx queue. */\r
 223         if( xQueueSend( xCharsForTx, ( const void * ) &cOutChar, xBlockTime ) != ( char ) pdPASS )\r
 224         {\r
 225                 return pdFAIL;\r
 226         }\r
 227 \r
 228         /* Turn interrupt on - ensure the compiler only generates a single \r
 229         instruction for this. */\r
 230         bTXIE = serINTERRUPT_ENABLED;\r
 231 \r
 232         return pdPASS;\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 void vSerialClose( xComPortHandle xPort )\r
 237 {\r
 238         /* Not implemented for this port.\r
 239         To implement, turn off the interrupts and delete the memory\r
 240         allocated to the queues. */\r
 241 }\r