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

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 \r
  68 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.   \r
  69  * \r
  70  * This file only supports UART 1\r
  71  */\r
  72 \r
  73 /* Standard includes. */\r
  74 #include <stdlib.h>\r
  75 #include <signal.h>\r
  76 \r
  77 /* Scheduler includes. */\r
  78 #include "FreeRTOS.h"\r
  79 #include "queue.h"\r
  80 #include "task.h"\r
  81 \r
  82 /* Demo application includes. */\r
  83 #include "serial.h"\r
  84 \r
  85 /* Constants required to setup the hardware. */\r
  86 #define serTX_AND_RX                    ( ( unsigned char ) 0x03 )\r
  87 \r
  88 /* Misc. constants. */\r
  89 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
  90 \r
  91 /* Enable the UART Tx interrupt. */\r
  92 #define vInterruptOn() IFG2 |= UTXIFG1\r
  93 \r
  94 /* The queue used to hold received characters. */\r
  95 static xQueueHandle xRxedChars; \r
  96 \r
  97 /* The queue used to hold characters waiting transmission. */\r
  98 static xQueueHandle xCharsForTx; \r
  99 \r
 100 static volatile short sTHREEmpty;\r
 101 \r
 102 /* Interrupt service routines. */\r
 103 interrupt (UART1RX_VECTOR) wakeup vRxISR( void );\r
 104 interrupt (UART1TX_VECTOR) wakeup vTxISR( void );\r
 105 \r
 106 /*-----------------------------------------------------------*/\r
 107 \r
 108 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 109 {\r
 110 unsigned long ulBaudRateCount;\r
 111 \r
 112         /* Initialise the hardware. */\r
 113 \r
 114         /* Generate the baud rate constants for the wanted baud rate. */\r
 115         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
 116 \r
 117         portENTER_CRITICAL();\r
 118         {\r
 119                 /* Create the queues used by the com test task. */\r
 120                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 121                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 122 \r
 123                 /* Reset UART. */\r
 124                 UCTL1 |= SWRST;\r
 125 \r
 126                 /* Set pin function. */\r
 127                 P4SEL |= serTX_AND_RX;\r
 128 \r
 129                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation. \r
 130                 LOOPBACK MODE!*/\r
 131                 U1CTL |= CHAR + LISTEN;\r
 132                 U1TCTL |= SSEL1;\r
 133 \r
 134                 /* Setup baud rate low byte. */\r
 135                 U1BR0 = ( unsigned char ) ( ulBaudRateCount & ( unsigned long ) 0xff );\r
 136 \r
 137                 /* Setup baud rate high byte. */\r
 138                 ulBaudRateCount >>= 8UL;\r
 139                 U1BR1 = ( unsigned char ) ( ulBaudRateCount & ( unsigned long ) 0xff );\r
 140 \r
 141                 /* Enable ports. */\r
 142                 ME2 |= UTXE1 + URXE1;\r
 143 \r
 144                 /* Set. */\r
 145                 UCTL1 &= ~SWRST;\r
 146 \r
 147                 /* Nothing in the buffer yet. */\r
 148                 sTHREEmpty = pdTRUE;\r
 149 \r
 150                 /* Enable interrupts. */\r
 151                 IE2 |= URXIE1 + UTXIE1;\r
 152         }\r
 153         portEXIT_CRITICAL();\r
 154         \r
 155         /* Unlike other ports, this serial code does not allow for more than one\r
 156         com port.  We therefore don't return a pointer to a port structure and can\r
 157         instead just return NULL. */\r
 158         return NULL;\r
 159 }\r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 163 {\r
 164         /* Get the next character from the buffer.  Return false if no characters\r
 165         are available, or arrive before xBlockTime expires. */\r
 166         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 167         {\r
 168                 return pdTRUE;\r
 169         }\r
 170         else\r
 171         {\r
 172                 return pdFALSE;\r
 173         }\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 178 {\r
 179 signed portBASE_TYPE xReturn;\r
 180 \r
 181         /* Transmit a character. */\r
 182 \r
 183         portENTER_CRITICAL();\r
 184         {\r
 185                 if( sTHREEmpty == pdTRUE )\r
 186                 {\r
 187                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that \r
 188                         there are no characters queued to be transmitted - so we can\r
 189                         write the character directly to the shift Tx register. */\r
 190                         sTHREEmpty = pdFALSE;\r
 191                         U1TXBUF = cOutChar;\r
 192                         xReturn = pdPASS;\r
 193                 }\r
 194                 else\r
 195                 {\r
 196                         /* sTHREEmpty is false, so there are still characters waiting to be\r
 197                         transmitted.  We have to queue this character so it gets \r
 198                         transmitted     in turn. */\r
 199 \r
 200                         /* Return false if after the block time there is no room on the Tx \r
 201                         queue.  It is ok to block inside a critical section as each task\r
 202                         maintains it's own critical section status. */\r
 203                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 204 \r
 205                         /* Depending on queue sizing and task prioritisation:  While we \r
 206                         were blocked waiting to post on the queue interrupts were not \r
 207                         disabled.  It is possible that the serial ISR has emptied the \r
 208                         Tx queue, in which case we need to start the Tx off again\r
 209                         writing directly to the Tx register. */\r
 210                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
 211                         {\r
 212                                 /* Get back the character we just posted. */\r
 213                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 214                                 sTHREEmpty = pdFALSE;\r
 215                                 U1TXBUF = cOutChar;\r
 216                         }\r
 217                 }\r
 218         }\r
 219         portEXIT_CRITICAL();\r
 220 \r
 221         return pdPASS;\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 /*\r
 226  * UART RX interrupt service routine.\r
 227  */\r
 228 interrupt (UART1RX_VECTOR) wakeup vRxISR( void )\r
 229 {\r
 230 signed char cChar;\r
 231 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 232 \r
 233         /* Get the character from the UART and post it on the queue of Rxed \r
 234         characters. */\r
 235         cChar = U1RXBUF;\r
 236 \r
 237         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 238 \r
 239         if( xHigherPriorityTaskWoken )\r
 240         {\r
 241                 /*If the post causes a task to wake force a context switch \r
 242                 as the woken task may have a higher priority than the task we have \r
 243                 interrupted. */\r
 244                 taskYIELD();\r
 245         }\r
 246 }\r
 247 /*-----------------------------------------------------------*/\r
 248 \r
 249 /*\r
 250  * UART Tx interrupt service routine.\r
 251  */\r
 252 interrupt (UART1TX_VECTOR) wakeup vTxISR( void )\r
 253 {\r
 254 signed char cChar;\r
 255 portBASE_TYPE xTaskWoken = pdFALSE;\r
 256 \r
 257         /* The previous character has been transmitted.  See if there are any\r
 258         further characters waiting transmission. */\r
 259 \r
 260         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 261         {\r
 262                 /* There was another character queued - transmit it now. */\r
 263                 U1TXBUF = cChar;\r
 264         }\r
 265         else\r
 266         {\r
 267                 /* There were no other characters to transmit. */\r
 268                 sTHREEmpty = pdTRUE;\r
 269         }\r
 270 }\r
 271 \r