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

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