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

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