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

   1 /*\r
   2     FreeRTOS V7.4.1 - 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.3\r
  77 \r
  78         + The function xPortInitMinimal() has been renamed to \r
  79           xSerialPortInitMinimal() and the function xPortInit() has been renamed\r
  80           to xSerialPortInit().\r
  81 \r
  82 Changes from V2.0.0\r
  83 \r
  84         + Delay periods are now specified using variables and constants of\r
  85           portTickType rather than unsigned long.\r
  86         + xQueueReceiveFromISR() used in place of xQueueReceive() within the ISR.\r
  87 \r
  88 Changes from V2.6.0\r
  89 \r
  90         + Replaced the inb() and outb() functions with direct memory\r
  91           access.  This allows the port to be built with the 20050414 build of\r
  92           WinAVR.\r
  93 */\r
  94 \r
  95 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. */\r
  96 \r
  97 \r
  98 #include <stdlib.h>\r
  99 #include <avr/interrupt.h>\r
 100 #include "FreeRTOS.h"\r
 101 #include "queue.h"\r
 102 #include "task.h"\r
 103 #include "serial.h"\r
 104 \r
 105 #define serBAUD_DIV_CONSTANT                    ( ( unsigned long ) 16 )\r
 106 \r
 107 /* Constants for writing to UCSRB. */\r
 108 #define serRX_INT_ENABLE                                ( ( unsigned char ) 0x80 )\r
 109 #define serRX_ENABLE                                    ( ( unsigned char ) 0x10 )\r
 110 #define serTX_ENABLE                                    ( ( unsigned char ) 0x08 )\r
 111 #define serTX_INT_ENABLE                                ( ( unsigned char ) 0x20 )\r
 112 \r
 113 /* Constants for writing to UCSRC. */\r
 114 #define serUCSRC_SELECT                                 ( ( unsigned char ) 0x80 )\r
 115 #define serEIGHT_DATA_BITS                              ( ( unsigned char ) 0x06 )\r
 116 \r
 117 static xQueueHandle xRxedChars; \r
 118 static xQueueHandle xCharsForTx; \r
 119 \r
 120 #define vInterruptOn()                                                                          \\r
 121 {                                                                                                                       \\r
 122         unsigned char ucByte;                                                           \\r
 123                                                                                                                         \\r
 124         ucByte = UCSRB;                                                                                 \\r
 125         ucByte |= serTX_INT_ENABLE;                                                             \\r
 126         UCSRB = ucByte;                                                                                 \\r
 127 }                                                                                                                                                               \r
 128 /*-----------------------------------------------------------*/\r
 129 \r
 130 #define vInterruptOff()                                                                         \\r
 131 {                                                                                                                       \\r
 132         unsigned char ucInByte;                                                         \\r
 133                                                                                                                         \\r
 134         ucInByte = UCSRB;                                                                               \\r
 135         ucInByte &= ~serTX_INT_ENABLE;                                                  \\r
 136         UCSRB = ucInByte;                                                                               \\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 141 {\r
 142 unsigned long ulBaudRateCounter;\r
 143 unsigned char ucByte;\r
 144 \r
 145         portENTER_CRITICAL();\r
 146         {\r
 147                 /* Create the queues used by the com test task. */\r
 148                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 149                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 150 \r
 151                 /* Calculate the baud rate register value from the equation in the\r
 152                 data sheet. */\r
 153                 ulBaudRateCounter = ( configCPU_CLOCK_HZ / ( serBAUD_DIV_CONSTANT * ulWantedBaud ) ) - ( unsigned long ) 1;\r
 154 \r
 155                 /* Set the baud rate. */        \r
 156                 ucByte = ( unsigned char ) ( ulBaudRateCounter & ( unsigned long ) 0xff );      \r
 157                 UBRRL = ucByte;\r
 158 \r
 159                 ulBaudRateCounter >>= ( unsigned long ) 8;\r
 160                 ucByte = ( unsigned char ) ( ulBaudRateCounter & ( unsigned long ) 0xff );      \r
 161                 UBRRH = ucByte;\r
 162 \r
 163                 /* Enable the Rx interrupt.  The Tx interrupt will get enabled\r
 164                 later. Also enable the Rx and Tx. */\r
 165                 UCSRB = ( serRX_INT_ENABLE | serRX_ENABLE | serTX_ENABLE );\r
 166 \r
 167                 /* Set the data bits to 8. */\r
 168                 UCSRC = ( serUCSRC_SELECT | serEIGHT_DATA_BITS );\r
 169         }\r
 170         portEXIT_CRITICAL();\r
 171         \r
 172         /* Unlike other ports, this serial code does not allow for more than one\r
 173         com port.  We therefore don't return a pointer to a port structure and can\r
 174         instead just return NULL. */\r
 175         return NULL;\r
 176 }\r
 177 /*-----------------------------------------------------------*/\r
 178 \r
 179 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 180 {\r
 181         /* Only one port is supported. */\r
 182         ( void ) pxPort;\r
 183 \r
 184         /* Get the next character from the buffer.  Return false if no characters\r
 185         are available, or arrive before xBlockTime expires. */\r
 186         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 187         {\r
 188                 return pdTRUE;\r
 189         }\r
 190         else\r
 191         {\r
 192                 return pdFALSE;\r
 193         }\r
 194 }\r
 195 /*-----------------------------------------------------------*/\r
 196 \r
 197 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 198 {\r
 199         /* Only one port is supported. */\r
 200         ( void ) pxPort;\r
 201 \r
 202         /* Return false if after the block time there is no room on the Tx queue. */\r
 203         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 204         {\r
 205                 return pdFAIL;\r
 206         }\r
 207 \r
 208         vInterruptOn();\r
 209 \r
 210         return pdPASS;\r
 211 }\r
 212 /*-----------------------------------------------------------*/\r
 213 \r
 214 void vSerialClose( xComPortHandle xPort )\r
 215 {\r
 216 unsigned char ucByte;\r
 217 \r
 218         /* The parameter is not used. */\r
 219         ( void ) xPort;\r
 220 \r
 221         /* Turn off the interrupts.  We may also want to delete the queues and/or\r
 222         re-install the original ISR. */\r
 223 \r
 224         portENTER_CRITICAL();\r
 225         {\r
 226                 vInterruptOff();\r
 227                 ucByte = UCSRB;\r
 228                 ucByte &= ~serRX_INT_ENABLE;\r
 229                 UCSRB = ucByte;\r
 230         }\r
 231         portEXIT_CRITICAL();\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 SIGNAL( SIG_UART_RECV )\r
 236 {\r
 237 signed char cChar;\r
 238 signed portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 239 \r
 240         /* Get the character and post it on the queue of Rxed characters.\r
 241         If the post causes a task to wake force a context switch as the woken task\r
 242         may have a higher priority than the task we have interrupted. */\r
 243         cChar = UDR;\r
 244 \r
 245         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 246 \r
 247         if( xHigherPriorityTaskWoken != pdFALSE )\r
 248         {\r
 249                 taskYIELD();\r
 250         }\r
 251 }\r
 252 /*-----------------------------------------------------------*/\r
 253 \r
 254 SIGNAL( SIG_UART_DATA )\r
 255 {\r
 256 signed char cChar, cTaskWoken;\r
 257 \r
 258         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &cTaskWoken ) == pdTRUE )\r
 259         {\r
 260                 /* Send the next character queued for Tx. */\r
 261                 UDR = cChar;\r
 262         }\r
 263         else\r
 264         {\r
 265                 /* Queue empty, nothing to send. */\r
 266                 vInterruptOff();\r
 267         }\r
 268 }\r
 269 \r