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

   1 /*\r
   2     FreeRTOS V9.0.0rc2 - 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 #include <signal.h>\r
  79 \r
  80 /* Scheduler includes. */\r
  81 #include "FreeRTOS.h"\r
  82 #include "queue.h"\r
  83 #include "task.h"\r
  84 \r
  85 /* Demo application includes. */\r
  86 #include "serial.h"\r
  87 \r
  88 /* Constants required to setup the hardware. */\r
  89 #define serTX_AND_RX                    ( ( unsigned char ) 0x03 )\r
  90 \r
  91 /* Misc. constants. */\r
  92 #define serNO_BLOCK                             ( ( TickType_t ) 0 )\r
  93 \r
  94 /* Enable the UART Tx interrupt. */\r
  95 #define vInterruptOn() IFG2 |= UTXIFG1\r
  96 \r
  97 /* The queue used to hold received characters. */\r
  98 static QueueHandle_t xRxedChars; \r
  99 \r
 100 /* The queue used to hold characters waiting transmission. */\r
 101 static QueueHandle_t xCharsForTx; \r
 102 \r
 103 static volatile short sTHREEmpty;\r
 104 \r
 105 /* Interrupt service routines. */\r
 106 interrupt (UART1RX_VECTOR) wakeup vRxISR( void );\r
 107 interrupt (UART1TX_VECTOR) wakeup vTxISR( void );\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, TickType_t 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, TickType_t 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 /*\r
 229  * UART RX interrupt service routine.\r
 230  */\r
 231 interrupt (UART1RX_VECTOR) wakeup vRxISR( void )\r
 232 {\r
 233 signed char cChar;\r
 234 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 235 \r
 236         /* Get the character from the UART and post it on the queue of Rxed \r
 237         characters. */\r
 238         cChar = U1RXBUF;\r
 239 \r
 240         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 241 \r
 242         if( xHigherPriorityTaskWoken )\r
 243         {\r
 244                 /*If the post causes a task to wake force a context switch \r
 245                 as the woken task may have a higher priority than the task we have \r
 246                 interrupted. */\r
 247                 taskYIELD();\r
 248         }\r
 249 }\r
 250 /*-----------------------------------------------------------*/\r
 251 \r
 252 /*\r
 253  * UART Tx interrupt service routine.\r
 254  */\r
 255 interrupt (UART1TX_VECTOR) wakeup vTxISR( void )\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 \r