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

   1 /*\r
   2     FreeRTOS V9.0.0 - Copyright (C) 2016 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 \r
  71 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.   \r
  72  * \r
  73  * This file only supports UART 1\r
  74  */\r
  75 \r
  76 /* Standard includes. */\r
  77 #include <stdlib.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                             ( ( TickType_t ) 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 QueueHandle_t xRxedChars; \r
  98 \r
  99 /* The queue used to hold characters waiting transmission. */\r
 100 static QueueHandle_t xCharsForTx; \r
 101 \r
 102 static volatile short sTHREEmpty;\r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 107 {\r
 108 unsigned long ulBaudRateCount;\r
 109 \r
 110         /* Initialise the hardware. */\r
 111 \r
 112         /* Generate the baud rate constants for the wanted baud rate. */\r
 113         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
 114 \r
 115         portENTER_CRITICAL();\r
 116         {\r
 117                 /* Create the queues used by the com test task. */\r
 118                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 119                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 120 \r
 121                 /* Reset UART. */\r
 122                 UCTL1 |= SWRST;\r
 123 \r
 124                 /* Set pin function. */\r
 125                 P4SEL |= serTX_AND_RX;\r
 126 \r
 127                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation. \r
 128                 LOOPBACK MODE!*/\r
 129                 U1CTL |= CHAR + LISTEN;\r
 130                 U1TCTL |= SSEL1;\r
 131 \r
 132                 /* Setup baud rate low byte. */\r
 133                 U1BR0 = ( unsigned char ) ( ulBaudRateCount & ( unsigned long ) 0xff );\r
 134 \r
 135                 /* Setup baud rate high byte. */\r
 136                 ulBaudRateCount >>= 8UL;\r
 137                 U1BR1 = ( unsigned char ) ( ulBaudRateCount & ( unsigned long ) 0xff );\r
 138 \r
 139                 /* Enable ports. */\r
 140                 ME2 |= UTXE1 + URXE1;\r
 141 \r
 142                 /* Set. */\r
 143                 UCTL1 &= ~SWRST;\r
 144 \r
 145                 /* Nothing in the buffer yet. */\r
 146                 sTHREEmpty = pdTRUE;\r
 147 \r
 148                 /* Enable interrupts. */\r
 149                 IE2 |= URXIE1 + UTXIE1;\r
 150         }\r
 151         portEXIT_CRITICAL();\r
 152         \r
 153         /* Unlike other ports, this serial code does not allow for more than one\r
 154         com port.  We therefore don't return a pointer to a port structure and can\r
 155         instead just return NULL. */\r
 156         return NULL;\r
 157 }\r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 161 {\r
 162         /* Get the next character from the buffer.  Return false if no characters\r
 163         are available, or arrive before xBlockTime expires. */\r
 164         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 165         {\r
 166                 return pdTRUE;\r
 167         }\r
 168         else\r
 169         {\r
 170                 return pdFALSE;\r
 171         }\r
 172 }\r
 173 /*-----------------------------------------------------------*/\r
 174 \r
 175 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 176 {\r
 177 signed portBASE_TYPE xReturn;\r
 178 \r
 179         /* Transmit a character. */\r
 180 \r
 181         portENTER_CRITICAL();\r
 182         {\r
 183                 if( sTHREEmpty == pdTRUE )\r
 184                 {\r
 185                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that \r
 186                         there are no characters queued to be transmitted - so we can\r
 187                         write the character directly to the shift Tx register. */\r
 188                         sTHREEmpty = pdFALSE;\r
 189                         U1TXBUF = cOutChar;\r
 190                         xReturn = pdPASS;\r
 191                 }\r
 192                 else\r
 193                 {\r
 194                         /* sTHREEmpty is false, so there are still characters waiting to be\r
 195                         transmitted.  We have to queue this character so it gets \r
 196                         transmitted     in turn. */\r
 197 \r
 198                         /* Return false if after the block time there is no room on the Tx \r
 199                         queue.  It is ok to block inside a critical section as each task\r
 200                         maintains it's own critical section status. */\r
 201                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 202 \r
 203                         /* Depending on queue sizing and task prioritisation:  While we \r
 204                         were blocked waiting to post on the queue interrupts were not \r
 205                         disabled.  It is possible that the serial ISR has emptied the \r
 206                         Tx queue, in which case we need to start the Tx off again\r
 207                         writing directly to the Tx register. */\r
 208                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
 209                         {\r
 210                                 /* Get back the character we just posted. */\r
 211                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 212                                 sTHREEmpty = pdFALSE;\r
 213                                 U1TXBUF = cOutChar;\r
 214                         }\r
 215                 }\r
 216         }\r
 217         portEXIT_CRITICAL();\r
 218 \r
 219         return pdPASS;\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 #if configINTERRUPT_EXAMPLE_METHOD == 1\r
 224 \r
 225         /*\r
 226          * UART RX interrupt service routine.\r
 227          */\r
 228         void vRxISR( void ) __interrupt[ UART1RX_VECTOR ]\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         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 248         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 249         }\r
 250         /*-----------------------------------------------------------*/\r
 251         \r
 252         /*\r
 253          * UART Tx interrupt service routine.\r
 254          */\r
 255         void vTxISR( void ) __interrupt[ UART1TX_VECTOR ]\r
 256         {\r
 257         signed char cChar;\r
 258         portBASE_TYPE xTaskWoken = pdFALSE;\r
 259         \r
 260                 /* The previous character has been transmitted.  See if there are any\r
 261                 further characters waiting transmission. */\r
 262         \r
 263                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 264                 {\r
 265                         /* There was another character queued - transmit it now. */\r
 266                         U1TXBUF = cChar;\r
 267                 }\r
 268                 else\r
 269                 {\r
 270                         /* There were no other characters to transmit. */\r
 271                         sTHREEmpty = pdTRUE;\r
 272                 }\r
 273 \r
 274         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 275         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 276         }\r
 277     /*-----------------------------------------------------------*/\r
 278 \r
 279 #elif configINTERRUPT_EXAMPLE_METHOD == 2\r
 280 \r
 281     /* This is a standard C function as an assembly file wrapper is used as an\r
 282     interrupt entry point. */\r
 283         void vRxISR( void )\r
 284         {\r
 285         signed char cChar;\r
 286         portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 287         \r
 288                 /* Get the character from the UART and post it on the queue of Rxed \r
 289                 characters. */\r
 290                 cChar = U1RXBUF;\r
 291         \r
 292                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 293 \r
 294         /*If the post causes a task to wake force a context switch \r
 295         as the woken task may have a higher priority than the task we have \r
 296         interrupted. */\r
 297         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 298         }\r
 299         /*-----------------------------------------------------------*/\r
 300         \r
 301     /* This is a standard C function as an assembly file wrapper is used as an\r
 302     interrupt entry point. */\r
 303         void vTxISR( void )\r
 304         {\r
 305         signed char cChar;\r
 306         portBASE_TYPE xTaskWoken = pdFALSE;\r
 307         \r
 308                 /* The previous character has been transmitted.  See if there are any\r
 309                 further characters waiting transmission. */\r
 310         \r
 311                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 312                 {\r
 313                         /* There was another character queued - transmit it now. */\r
 314                         U1TXBUF = cChar;\r
 315                 }\r
 316                 else\r
 317                 {\r
 318                         /* There were no other characters to transmit. */\r
 319                         sTHREEmpty = pdTRUE;\r
 320                 }\r
 321         }\r
 322 \r
 323 #endif /* configINTERRUPT_EXAMPLE_METHOD */\r
 324 /*-----------------------------------------------------------*/\r