git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/msp430_CrossWorks/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 \r
  84 /* Scheduler includes. */\r
  85 #include "FreeRTOS.h"\r
  86 #include "queue.h"\r
  87 #include "task.h"\r
  88 \r
  89 /* Demo application includes. */\r
  90 #include "serial.h"\r
  91 \r
  92 /* Constants required to setup the hardware. */\r
  93 #define serTX_AND_RX                    ( ( unsigned char ) 0x03 )\r
  94 \r
  95 /* Misc. constants. */\r
  96 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
  97 \r
  98 /* Enable the UART Tx interrupt. */\r
  99 #define vInterruptOn() IFG2 |= UTXIFG1\r
 100 \r
 101 /* The queue used to hold received characters. */\r
 102 static xQueueHandle xRxedChars; \r
 103 \r
 104 /* The queue used to hold characters waiting transmission. */\r
 105 static xQueueHandle xCharsForTx; \r
 106 \r
 107 static volatile short sTHREEmpty;\r
 108 \r
 109 /*-----------------------------------------------------------*/\r
 110 \r
 111 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 112 {\r
 113 unsigned long ulBaudRateCount;\r
 114 \r
 115         /* Initialise the hardware. */\r
 116 \r
 117         /* Generate the baud rate constants for the wanted baud rate. */\r
 118         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
 119 \r
 120         portENTER_CRITICAL();\r
 121         {\r
 122                 /* Create the queues used by the com test task. */\r
 123                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 124                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 125 \r
 126                 /* Reset UART. */\r
 127                 UCTL1 |= SWRST;\r
 128 \r
 129                 /* Set pin function. */\r
 130                 P4SEL |= serTX_AND_RX;\r
 131 \r
 132                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation. \r
 133                 LOOPBACK MODE!*/\r
 134                 U1CTL |= CHAR + LISTEN;\r
 135                 U1TCTL |= SSEL1;\r
 136 \r
 137                 /* Setup baud rate low byte. */\r
 138                 U1BR0 = ( unsigned char ) ( ulBaudRateCount & ( unsigned long ) 0xff );\r
 139 \r
 140                 /* Setup baud rate high byte. */\r
 141                 ulBaudRateCount >>= 8UL;\r
 142                 U1BR1 = ( unsigned char ) ( ulBaudRateCount & ( unsigned long ) 0xff );\r
 143 \r
 144                 /* Enable ports. */\r
 145                 ME2 |= UTXE1 + URXE1;\r
 146 \r
 147                 /* Set. */\r
 148                 UCTL1 &= ~SWRST;\r
 149 \r
 150                 /* Nothing in the buffer yet. */\r
 151                 sTHREEmpty = pdTRUE;\r
 152 \r
 153                 /* Enable interrupts. */\r
 154                 IE2 |= URXIE1 + UTXIE1;\r
 155         }\r
 156         portEXIT_CRITICAL();\r
 157         \r
 158         /* Unlike other ports, this serial code does not allow for more than one\r
 159         com port.  We therefore don't return a pointer to a port structure and can\r
 160         instead just return NULL. */\r
 161         return NULL;\r
 162 }\r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 166 {\r
 167         /* Get the next character from the buffer.  Return false if no characters\r
 168         are available, or arrive before xBlockTime expires. */\r
 169         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 170         {\r
 171                 return pdTRUE;\r
 172         }\r
 173         else\r
 174         {\r
 175                 return pdFALSE;\r
 176         }\r
 177 }\r
 178 /*-----------------------------------------------------------*/\r
 179 \r
 180 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 181 {\r
 182 signed portBASE_TYPE xReturn;\r
 183 \r
 184         /* Transmit a character. */\r
 185 \r
 186         portENTER_CRITICAL();\r
 187         {\r
 188                 if( sTHREEmpty == pdTRUE )\r
 189                 {\r
 190                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that \r
 191                         there are no characters queued to be transmitted - so we can\r
 192                         write the character directly to the shift Tx register. */\r
 193                         sTHREEmpty = pdFALSE;\r
 194                         U1TXBUF = cOutChar;\r
 195                         xReturn = pdPASS;\r
 196                 }\r
 197                 else\r
 198                 {\r
 199                         /* sTHREEmpty is false, so there are still characters waiting to be\r
 200                         transmitted.  We have to queue this character so it gets \r
 201                         transmitted     in turn. */\r
 202 \r
 203                         /* Return false if after the block time there is no room on the Tx \r
 204                         queue.  It is ok to block inside a critical section as each task\r
 205                         maintains it's own critical section status. */\r
 206                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 207 \r
 208                         /* Depending on queue sizing and task prioritisation:  While we \r
 209                         were blocked waiting to post on the queue interrupts were not \r
 210                         disabled.  It is possible that the serial ISR has emptied the \r
 211                         Tx queue, in which case we need to start the Tx off again\r
 212                         writing directly to the Tx register. */\r
 213                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
 214                         {\r
 215                                 /* Get back the character we just posted. */\r
 216                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 217                                 sTHREEmpty = pdFALSE;\r
 218                                 U1TXBUF = cOutChar;\r
 219                         }\r
 220                 }\r
 221         }\r
 222         portEXIT_CRITICAL();\r
 223 \r
 224         return pdPASS;\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 #if configINTERRUPT_EXAMPLE_METHOD == 1\r
 229 \r
 230         /*\r
 231          * UART RX interrupt service routine.\r
 232          */\r
 233         void vRxISR( void ) __interrupt[ UART1RX_VECTOR ]\r
 234         {\r
 235         signed char cChar;\r
 236         portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 237         \r
 238                 /* Get the character from the UART and post it on the queue of Rxed \r
 239                 characters. */\r
 240                 cChar = U1RXBUF;\r
 241         \r
 242                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 243 \r
 244                 if( xHigherPriorityTaskWoken )\r
 245                 {\r
 246                         /*If the post causes a task to wake force a context switch \r
 247                         as the woken task may have a higher priority than the task we have \r
 248                         interrupted. */\r
 249                         taskYIELD();\r
 250                 }\r
 251 \r
 252         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 253         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 254         }\r
 255         /*-----------------------------------------------------------*/\r
 256         \r
 257         /*\r
 258          * UART Tx interrupt service routine.\r
 259          */\r
 260         void vTxISR( void ) __interrupt[ UART1TX_VECTOR ]\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         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 280         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 281         }\r
 282     /*-----------------------------------------------------------*/\r
 283 \r
 284 #elif configINTERRUPT_EXAMPLE_METHOD == 2\r
 285 \r
 286     /* This is a standard C function as an assembly file wrapper is used as an\r
 287     interrupt entry point. */\r
 288         void vRxISR( void )\r
 289         {\r
 290         signed char cChar;\r
 291         portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 292         \r
 293                 /* Get the character from the UART and post it on the queue of Rxed \r
 294                 characters. */\r
 295                 cChar = U1RXBUF;\r
 296         \r
 297                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 298 \r
 299         /*If the post causes a task to wake force a context switch \r
 300         as the woken task may have a higher priority than the task we have \r
 301         interrupted. */\r
 302         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 303         }\r
 304         /*-----------------------------------------------------------*/\r
 305         \r
 306     /* This is a standard C function as an assembly file wrapper is used as an\r
 307     interrupt entry point. */\r
 308         void vTxISR( void )\r
 309         {\r
 310         signed char cChar;\r
 311         portBASE_TYPE xTaskWoken = pdFALSE;\r
 312         \r
 313                 /* The previous character has been transmitted.  See if there are any\r
 314                 further characters waiting transmission. */\r
 315         \r
 316                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 317                 {\r
 318                         /* There was another character queued - transmit it now. */\r
 319                         U1TXBUF = cChar;\r
 320                 }\r
 321                 else\r
 322                 {\r
 323                         /* There were no other characters to transmit. */\r
 324                         sTHREEmpty = pdTRUE;\r
 325                 }\r
 326         }\r
 327 \r
 328 #endif /* configINTERRUPT_EXAMPLE_METHOD */\r
 329 /*-----------------------------------------------------------*/\r