git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Cygnal/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 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR DEMO PURPOSES */\r
  77 #include <stdlib.h>\r
  78 #include "FreeRTOS.h"\r
  79 #include "queue.h"\r
  80 #include "task.h"\r
  81 #include "serial.h"\r
  82 \r
  83 /* Constants required to setup the serial control register. */\r
  84 #define ser8_BIT_MODE                   ( ( unsigned char ) 0x40 )\r
  85 #define serRX_ENABLE                    ( ( unsigned char ) 0x10 )\r
  86 \r
  87 /* Constants to setup the timer used to generate the baud rate. */\r
  88 #define serCLOCK_DIV_48                 ( ( unsigned char ) 0x03 )\r
  89 #define serUSE_PRESCALED_CLOCK  ( ( unsigned char ) 0x10 )\r
  90 #define ser8BIT_WITH_RELOAD             ( ( unsigned char ) 0x20 )\r
  91 #define serSMOD                                 ( ( unsigned char ) 0x10 )\r
  92 \r
  93 static xQueueHandle xRxedChars; \r
  94 static xQueueHandle xCharsForTx; \r
  95 \r
  96 data static unsigned portBASE_TYPE uxTxEmpty;\r
  97 \r
  98 /*-----------------------------------------------------------*/\r
  99 \r
 100 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 101 {\r
 102 unsigned long ulReloadValue;\r
 103 const portFLOAT fBaudConst = ( portFLOAT ) configCPU_CLOCK_HZ * ( portFLOAT ) 2.0;\r
 104 unsigned char ucOriginalSFRPage;\r
 105 \r
 106         portENTER_CRITICAL();\r
 107         {\r
 108                 ucOriginalSFRPage = SFRPAGE;\r
 109                 SFRPAGE = 0;\r
 110 \r
 111                 uxTxEmpty = pdTRUE;\r
 112 \r
 113                 /* Create the queues used by the com test task. */\r
 114                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 115                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( char ) );\r
 116         \r
 117                 /* Calculate the baud rate to use timer 1. */\r
 118                 ulReloadValue = ( unsigned long ) ( ( ( portFLOAT ) 256 - ( fBaudConst / ( portFLOAT ) ( 32 * ulWantedBaud ) ) ) + ( portFLOAT ) 0.5 );\r
 119 \r
 120                 /* Set timer one for desired mode of operation. */\r
 121                 TMOD &= 0x08;\r
 122                 TMOD |= ser8BIT_WITH_RELOAD;\r
 123                 SSTA0 |= serSMOD;\r
 124 \r
 125                 /* Set the reload and start values for the time. */\r
 126                 TL1 = ( unsigned char ) ulReloadValue;\r
 127                 TH1 = ( unsigned char ) ulReloadValue;\r
 128 \r
 129                 /* Setup the control register for standard n, 8, 1 - variable baud rate. */\r
 130                 SCON = ser8_BIT_MODE | serRX_ENABLE;\r
 131 \r
 132                 /* Enable the serial port interrupts */\r
 133                 ES = 1;\r
 134 \r
 135                 /* Start the timer. */\r
 136                 TR1 = 1;\r
 137 \r
 138                 SFRPAGE = ucOriginalSFRPage;\r
 139         }\r
 140         portEXIT_CRITICAL();\r
 141         \r
 142         /* Unlike some ports, this serial code does not allow for more than one\r
 143         com port.  We therefore don't return a pointer to a port structure and can\r
 144         instead just return NULL. */\r
 145         return NULL;\r
 146 }\r
 147 /*-----------------------------------------------------------*/\r
 148 \r
 149 void vSerialISR( void ) interrupt 4\r
 150 {\r
 151 char cChar;\r
 152 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 153 \r
 154         /* 8051 port interrupt routines MUST be placed within a critical section\r
 155         if taskYIELD() is used within the ISR! */\r
 156 \r
 157         portENTER_CRITICAL();\r
 158         {\r
 159                 if( RI ) \r
 160                 {\r
 161                         /* Get the character and post it on the queue of Rxed characters.\r
 162                         If the post causes a task to wake force a context switch if the woken task\r
 163                         has a higher priority than the task we have interrupted. */\r
 164                         cChar = SBUF;\r
 165                         RI = 0;\r
 166 \r
 167                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 168                 }\r
 169 \r
 170                 if( TI ) \r
 171                 {\r
 172                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == ( portBASE_TYPE ) pdTRUE )\r
 173                         {\r
 174                                 /* Send the next character queued for Tx. */\r
 175                                 SBUF = cChar;\r
 176                         }\r
 177                         else\r
 178                         {\r
 179                                 /* Queue empty, nothing to send. */\r
 180                                 uxTxEmpty = pdTRUE;\r
 181                         }\r
 182 \r
 183                         TI = 0;\r
 184                 }\r
 185         \r
 186                 if( xHigherPriorityTaskWoken )\r
 187                 {\r
 188                         portYIELD();\r
 189                 }\r
 190         }\r
 191         portEXIT_CRITICAL();\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 196 {\r
 197         /* There is only one port supported. */\r
 198         ( void ) pxPort;\r
 199 \r
 200         /* Get the next character from the buffer.  Return false if no characters\r
 201         are available, or arrive before xBlockTime expires. */\r
 202         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 203         {\r
 204                 return ( portBASE_TYPE ) pdTRUE;\r
 205         }\r
 206         else\r
 207         {\r
 208                 return ( portBASE_TYPE ) pdFALSE;\r
 209         }\r
 210 }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213 portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 214 {\r
 215 portBASE_TYPE xReturn;\r
 216 \r
 217         /* There is only one port supported. */\r
 218         ( void ) pxPort;\r
 219 \r
 220         portENTER_CRITICAL();\r
 221         {\r
 222                 if( uxTxEmpty == pdTRUE )\r
 223                 {\r
 224                         SBUF = cOutChar;\r
 225                         uxTxEmpty = pdFALSE;\r
 226                         xReturn = ( portBASE_TYPE ) pdTRUE;\r
 227                 }\r
 228                 else\r
 229                 {\r
 230                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 231 \r
 232                         if( xReturn == ( portBASE_TYPE ) pdFALSE )\r
 233                         {\r
 234                                 xReturn = ( portBASE_TYPE ) pdTRUE;\r
 235                         }\r
 236                 }\r
 237         }\r
 238         portEXIT_CRITICAL();\r
 239 \r
 240         return xReturn;\r
 241 }\r
 242 /*-----------------------------------------------------------*/\r
 243 \r
 244 void vSerialClose( xComPortHandle xPort )\r
 245 {\r
 246         /* Not implemented in this port. */\r
 247         ( void ) xPort;\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 \r
 252 \r
 253 \r
 254 \r