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

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