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

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