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

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