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

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