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

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