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

   1 /*\r
   2         FreeRTOS.org V4.8.0 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         ***************************************************************************\r
  28         *                                                                                                                                                 *\r
  29         * SAVE TIME AND MONEY!  Why not get us to quote to get FreeRTOS.org               *\r
  30         * running on your hardware - or even write all or part of your application*\r
  31         * for you?  See http://www.OpenRTOS.com for details.                                      *\r
  32         *                                                                                                                                                 *\r
  33         ***************************************************************************\r
  34         ***************************************************************************\r
  35 \r
  36         Please ensure to read the configuration and relevant port sections of the\r
  37         online documentation.\r
  38 \r
  39         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  40         contact details.\r
  41 \r
  42         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  43         critical systems.\r
  44 \r
  45         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  46         licensing and training services.\r
  47 */\r
  48 \r
  49 /*\r
  50 Changes from V1.2.3\r
  51 \r
  52         + The function xPortInitMinimal() has been renamed to \r
  53           xSerialPortInitMinimal() and the function xPortInit() has been renamed\r
  54           to xSerialPortInit().\r
  55 \r
  56 Changes from V2.0.0\r
  57 \r
  58         + Delay periods are now specified using variables and constants of\r
  59           portTickType rather than unsigned portLONG.\r
  60         + xQueueReceiveFromISR() used in place of xQueueReceive() within the ISR.\r
  61 \r
  62 Changes from V2.6.0\r
  63 \r
  64         + Replaced the inb() and outb() functions with direct memory\r
  65           access.  This allows the port to be built with the 20050414 build of\r
  66           WinAVR.\r
  67 */\r
  68 \r
  69 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER. */\r
  70 \r
  71 \r
  72 #include <stdlib.h>\r
  73 #include <avr/interrupt.h>\r
  74 #include "FreeRTOS.h"\r
  75 #include "queue.h"\r
  76 #include "task.h"\r
  77 #include "serial.h"\r
  78 \r
  79 #define serBAUD_DIV_CONSTANT                    ( ( unsigned portLONG ) 16 )\r
  80 \r
  81 /* Constants for writing to UCSRB. */\r
  82 #define serRX_INT_ENABLE                                ( ( unsigned portCHAR ) 0x80 )\r
  83 #define serRX_ENABLE                                    ( ( unsigned portCHAR ) 0x10 )\r
  84 #define serTX_ENABLE                                    ( ( unsigned portCHAR ) 0x08 )\r
  85 #define serTX_INT_ENABLE                                ( ( unsigned portCHAR ) 0x20 )\r
  86 \r
  87 /* Constants for writing to UCSRC. */\r
  88 #define serUCSRC_SELECT                                 ( ( unsigned portCHAR ) 0x80 )\r
  89 #define serEIGHT_DATA_BITS                              ( ( unsigned portCHAR ) 0x06 )\r
  90 \r
  91 static xQueueHandle xRxedChars; \r
  92 static xQueueHandle xCharsForTx; \r
  93 \r
  94 #define vInterruptOn()                                                                          \\r
  95 {                                                                                                                       \\r
  96         unsigned portCHAR ucByte;                                                               \\r
  97                                                                                                                         \\r
  98         ucByte = UCSRB;                                                                                 \\r
  99         ucByte |= serTX_INT_ENABLE;                                                             \\r
 100         UCSRB = ucByte;                                                                                 \\r
 101 }                                                                                                                                                               \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 #define vInterruptOff()                                                                         \\r
 105 {                                                                                                                       \\r
 106         unsigned portCHAR ucInByte;                                                             \\r
 107                                                                                                                         \\r
 108         ucInByte = UCSRB;                                                                               \\r
 109         ucInByte &= ~serTX_INT_ENABLE;                                                  \\r
 110         UCSRB = ucInByte;                                                                               \\r
 111 }\r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 115 {\r
 116 unsigned portLONG ulBaudRateCounter;\r
 117 unsigned portCHAR ucByte;\r
 118 \r
 119         portENTER_CRITICAL();\r
 120         {\r
 121                 /* Create the queues used by the com test task. */\r
 122                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 123                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 124 \r
 125                 /* Calculate the baud rate register value from the equation in the\r
 126                 data sheet. */\r
 127                 ulBaudRateCounter = ( configCPU_CLOCK_HZ / ( serBAUD_DIV_CONSTANT * ulWantedBaud ) ) - ( unsigned portLONG ) 1;\r
 128 \r
 129                 /* Set the baud rate. */        \r
 130                 ucByte = ( unsigned portCHAR ) ( ulBaudRateCounter & ( unsigned portLONG ) 0xff );      \r
 131                 UBRRL = ucByte;\r
 132 \r
 133                 ulBaudRateCounter >>= ( unsigned portLONG ) 8;\r
 134                 ucByte = ( unsigned portCHAR ) ( ulBaudRateCounter & ( unsigned portLONG ) 0xff );      \r
 135                 UBRRH = ucByte;\r
 136 \r
 137                 /* Enable the Rx interrupt.  The Tx interrupt will get enabled\r
 138                 later. Also enable the Rx and Tx. */\r
 139                 UCSRB = ( serRX_INT_ENABLE | serRX_ENABLE | serTX_ENABLE );\r
 140 \r
 141                 /* Set the data bits to 8. */\r
 142                 UCSRC = ( serUCSRC_SELECT | serEIGHT_DATA_BITS );\r
 143         }\r
 144         portEXIT_CRITICAL();\r
 145         \r
 146         /* Unlike other ports, this serial code does not allow for more than one\r
 147         com port.  We therefore don't return a pointer to a port structure and can\r
 148         instead just return NULL. */\r
 149         return NULL;\r
 150 }\r
 151 /*-----------------------------------------------------------*/\r
 152 \r
 153 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 154 {\r
 155         /* Only one port is supported. */\r
 156         ( void ) pxPort;\r
 157 \r
 158         /* Get the next character from the buffer.  Return false if no characters\r
 159         are available, or arrive before xBlockTime expires. */\r
 160         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 161         {\r
 162                 return pdTRUE;\r
 163         }\r
 164         else\r
 165         {\r
 166                 return pdFALSE;\r
 167         }\r
 168 }\r
 169 /*-----------------------------------------------------------*/\r
 170 \r
 171 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 172 {\r
 173         /* Only one port is supported. */\r
 174         ( void ) pxPort;\r
 175 \r
 176         /* Return false if after the block time there is no room on the Tx queue. */\r
 177         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 178         {\r
 179                 return pdFAIL;\r
 180         }\r
 181 \r
 182         vInterruptOn();\r
 183 \r
 184         return pdPASS;\r
 185 }\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 void vSerialClose( xComPortHandle xPort )\r
 189 {\r
 190 unsigned portCHAR ucByte;\r
 191 \r
 192         /* The parameter is not used. */\r
 193         ( void ) xPort;\r
 194 \r
 195         /* Turn off the interrupts.  We may also want to delete the queues and/or\r
 196         re-install the original ISR. */\r
 197 \r
 198         portENTER_CRITICAL();\r
 199         {\r
 200                 vInterruptOff();\r
 201                 ucByte = UCSRB;\r
 202                 ucByte &= ~serRX_INT_ENABLE;\r
 203                 UCSRB = ucByte;\r
 204         }\r
 205         portEXIT_CRITICAL();\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 SIGNAL( SIG_UART_RECV )\r
 210 {\r
 211 signed portCHAR cChar;\r
 212 \r
 213         /* Get the character and post it on the queue of Rxed characters.\r
 214         If the post causes a task to wake force a context switch as the woken task\r
 215         may have a higher priority than the task we have interrupted. */\r
 216         cChar = UDR;\r
 217 \r
 218         if( xQueueSendFromISR( xRxedChars, &cChar, pdFALSE ) )\r
 219         {\r
 220                 taskYIELD();\r
 221         }\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 SIGNAL( SIG_UART_DATA )\r
 226 {\r
 227 signed portCHAR cChar, cTaskWoken;\r
 228 \r
 229         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &cTaskWoken ) == pdTRUE )\r
 230         {\r
 231                 /* Send the next character queued for Tx. */\r
 232                 UDR = cChar;\r
 233         }\r
 234         else\r
 235         {\r
 236                 /* Queue empty, nothing to send. */\r
 237                 vInterruptOff();\r
 238         }\r
 239 }\r
 240 \r