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

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