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

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 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     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 /*\r
  70 Changes from V1.2.3\r
  71 \r
  72         + The function xPortInitMinimal() has been renamed to \r
  73           xSerialPortInitMinimal() and the function xPortInit() has been renamed\r
  74           to xSerialPortInit().\r
  75 \r
  76 Changes from V2.0.0\r
  77 \r
  78         + Delay periods are now specified using variables and constants of\r
  79           portTickType rather than unsigned long.\r
  80         + xQueueReceiveFromISR() used in place of xQueueReceive() within the ISR.\r
  81 \r
  82 Changes from V2.6.0\r
  83 \r
  84         + Replaced the inb() and outb() functions with direct memory\r
  85           access.  This allows the port to be built with the 20050414 build of\r
  86           WinAVR.\r
  87 */\r
  88 \r
  89 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. */\r
  90 \r
  91 \r
  92 #include <stdlib.h>\r
  93 #include <avr/interrupt.h>\r
  94 #include "FreeRTOS.h"\r
  95 #include "queue.h"\r
  96 #include "task.h"\r
  97 #include "serial.h"\r
  98 \r
  99 #define serBAUD_DIV_CONSTANT                    ( ( unsigned long ) 16 )\r
 100 \r
 101 /* Constants for writing to UCSRB. */\r
 102 #define serRX_INT_ENABLE                                ( ( unsigned char ) 0x80 )\r
 103 #define serRX_ENABLE                                    ( ( unsigned char ) 0x10 )\r
 104 #define serTX_ENABLE                                    ( ( unsigned char ) 0x08 )\r
 105 #define serTX_INT_ENABLE                                ( ( unsigned char ) 0x20 )\r
 106 \r
 107 /* Constants for writing to UCSRC. */\r
 108 #define serUCSRC_SELECT                                 ( ( unsigned char ) 0x80 )\r
 109 #define serEIGHT_DATA_BITS                              ( ( unsigned char ) 0x06 )\r
 110 \r
 111 static xQueueHandle xRxedChars; \r
 112 static xQueueHandle xCharsForTx; \r
 113 \r
 114 #define vInterruptOn()                                                                          \\r
 115 {                                                                                                                       \\r
 116         unsigned char ucByte;                                                           \\r
 117                                                                                                                         \\r
 118         ucByte = UCSRB;                                                                                 \\r
 119         ucByte |= serTX_INT_ENABLE;                                                             \\r
 120         UCSRB = ucByte;                                                                                 \\r
 121 }                                                                                                                                                               \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 #define vInterruptOff()                                                                         \\r
 125 {                                                                                                                       \\r
 126         unsigned char ucInByte;                                                         \\r
 127                                                                                                                         \\r
 128         ucInByte = UCSRB;                                                                               \\r
 129         ucInByte &= ~serTX_INT_ENABLE;                                                  \\r
 130         UCSRB = ucInByte;                                                                               \\r
 131 }\r
 132 /*-----------------------------------------------------------*/\r
 133 \r
 134 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 135 {\r
 136 unsigned long ulBaudRateCounter;\r
 137 unsigned char ucByte;\r
 138 \r
 139         portENTER_CRITICAL();\r
 140         {\r
 141                 /* Create the queues used by the com test task. */\r
 142                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 143                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 144 \r
 145                 /* Calculate the baud rate register value from the equation in the\r
 146                 data sheet. */\r
 147                 ulBaudRateCounter = ( configCPU_CLOCK_HZ / ( serBAUD_DIV_CONSTANT * ulWantedBaud ) ) - ( unsigned long ) 1;\r
 148 \r
 149                 /* Set the baud rate. */        \r
 150                 ucByte = ( unsigned char ) ( ulBaudRateCounter & ( unsigned long ) 0xff );      \r
 151                 UBRRL = ucByte;\r
 152 \r
 153                 ulBaudRateCounter >>= ( unsigned long ) 8;\r
 154                 ucByte = ( unsigned char ) ( ulBaudRateCounter & ( unsigned long ) 0xff );      \r
 155                 UBRRH = ucByte;\r
 156 \r
 157                 /* Enable the Rx interrupt.  The Tx interrupt will get enabled\r
 158                 later. Also enable the Rx and Tx. */\r
 159                 UCSRB = ( serRX_INT_ENABLE | serRX_ENABLE | serTX_ENABLE );\r
 160 \r
 161                 /* Set the data bits to 8. */\r
 162                 UCSRC = ( serUCSRC_SELECT | serEIGHT_DATA_BITS );\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 can\r
 168         instead just return NULL. */\r
 169         return NULL;\r
 170 }\r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 174 {\r
 175         /* Only one port is supported. */\r
 176         ( void ) pxPort;\r
 177 \r
 178         /* Get the next character from the buffer.  Return false if no characters\r
 179         are available, or arrive before xBlockTime expires. */\r
 180         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 181         {\r
 182                 return pdTRUE;\r
 183         }\r
 184         else\r
 185         {\r
 186                 return pdFALSE;\r
 187         }\r
 188 }\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 192 {\r
 193         /* Only one port is supported. */\r
 194         ( void ) pxPort;\r
 195 \r
 196         /* Return false if after the block time there is no room on the Tx queue. */\r
 197         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 198         {\r
 199                 return pdFAIL;\r
 200         }\r
 201 \r
 202         vInterruptOn();\r
 203 \r
 204         return pdPASS;\r
 205 }\r
 206 /*-----------------------------------------------------------*/\r
 207 \r
 208 void vSerialClose( xComPortHandle xPort )\r
 209 {\r
 210 unsigned char ucByte;\r
 211 \r
 212         /* The parameter is not used. */\r
 213         ( void ) xPort;\r
 214 \r
 215         /* Turn off the interrupts.  We may also want to delete the queues and/or\r
 216         re-install the original ISR. */\r
 217 \r
 218         portENTER_CRITICAL();\r
 219         {\r
 220                 vInterruptOff();\r
 221                 ucByte = UCSRB;\r
 222                 ucByte &= ~serRX_INT_ENABLE;\r
 223                 UCSRB = ucByte;\r
 224         }\r
 225         portEXIT_CRITICAL();\r
 226 }\r
 227 /*-----------------------------------------------------------*/\r
 228 \r
 229 SIGNAL( SIG_UART_RECV )\r
 230 {\r
 231 signed char cChar;\r
 232 signed portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 233 \r
 234         /* Get the character and post it on the queue of Rxed characters.\r
 235         If the post causes a task to wake force a context switch as the woken task\r
 236         may have a higher priority than the task we have interrupted. */\r
 237         cChar = UDR;\r
 238 \r
 239         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 240 \r
 241         if( xHigherPriorityTaskWoken != pdFALSE )\r
 242         {\r
 243                 taskYIELD();\r
 244         }\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 SIGNAL( SIG_UART_DATA )\r
 249 {\r
 250 signed char cChar, cTaskWoken;\r
 251 \r
 252         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &cTaskWoken ) == pdTRUE )\r
 253         {\r
 254                 /* Send the next character queued for Tx. */\r
 255                 UDR = cChar;\r
 256         }\r
 257         else\r
 258         {\r
 259                 /* Queue empty, nothing to send. */\r
 260                 vInterruptOff();\r
 261         }\r
 262 }\r
 263 \r