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

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