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

   1 /*\r
   2         FreeRTOS V5.4.2 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 \r
  49 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.   \r
  50  * \r
  51  * This file only supports UART 1\r
  52  */\r
  53 \r
  54 /* Standard includes. */\r
  55 #include <stdlib.h>\r
  56 #include <signal.h>\r
  57 \r
  58 /* Scheduler includes. */\r
  59 #include "FreeRTOS.h"\r
  60 #include "queue.h"\r
  61 #include "task.h"\r
  62 \r
  63 /* Demo application includes. */\r
  64 #include "serial.h"\r
  65 \r
  66 /* Constants required to setup the hardware. */\r
  67 #define serTX_AND_RX                    ( ( unsigned portCHAR ) 0x03 )\r
  68 \r
  69 /* Misc. constants. */\r
  70 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
  71 \r
  72 /* Enable the UART Tx interrupt. */\r
  73 #define vInterruptOn() IFG2 |= UTXIFG1\r
  74 \r
  75 /* The queue used to hold received characters. */\r
  76 static xQueueHandle xRxedChars; \r
  77 \r
  78 /* The queue used to hold characters waiting transmission. */\r
  79 static xQueueHandle xCharsForTx; \r
  80 \r
  81 static volatile portSHORT sTHREEmpty;\r
  82 \r
  83 /* Interrupt service routines. */\r
  84 interrupt (UART1RX_VECTOR) wakeup vRxISR( void );\r
  85 interrupt (UART1TX_VECTOR) wakeup vTxISR( void );\r
  86 \r
  87 /*-----------------------------------------------------------*/\r
  88 \r
  89 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  90 {\r
  91 unsigned portLONG ulBaudRateCount;\r
  92 \r
  93         /* Initialise the hardware. */\r
  94 \r
  95         /* Generate the baud rate constants for the wanted baud rate. */\r
  96         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
  97 \r
  98         portENTER_CRITICAL();\r
  99         {\r
 100                 /* Create the queues used by the com test task. */\r
 101                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 102                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 103 \r
 104                 /* Reset UART. */\r
 105                 UCTL1 |= SWRST;\r
 106 \r
 107                 /* Set pin function. */\r
 108                 P4SEL |= serTX_AND_RX;\r
 109 \r
 110                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation. \r
 111                 LOOPBACK MODE!*/\r
 112                 U1CTL |= CHAR + LISTEN;\r
 113                 U1TCTL |= SSEL1;\r
 114 \r
 115                 /* Setup baud rate low byte. */\r
 116                 U1BR0 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 117 \r
 118                 /* Setup baud rate high byte. */\r
 119                 ulBaudRateCount >>= 8UL;\r
 120                 U1BR1 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 121 \r
 122                 /* Enable ports. */\r
 123                 ME2 |= UTXE1 + URXE1;\r
 124 \r
 125                 /* Set. */\r
 126                 UCTL1 &= ~SWRST;\r
 127 \r
 128                 /* Nothing in the buffer yet. */\r
 129                 sTHREEmpty = pdTRUE;\r
 130 \r
 131                 /* Enable interrupts. */\r
 132                 IE2 |= URXIE1 + UTXIE1;\r
 133         }\r
 134         portEXIT_CRITICAL();\r
 135         \r
 136         /* Unlike other ports, this serial code does not allow for more than one\r
 137         com port.  We therefore don't return a pointer to a port structure and can\r
 138         instead just return NULL. */\r
 139         return NULL;\r
 140 }\r
 141 /*-----------------------------------------------------------*/\r
 142 \r
 143 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 144 {\r
 145         /* Get the next character from the buffer.  Return false if no characters\r
 146         are available, or arrive before xBlockTime expires. */\r
 147         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 148         {\r
 149                 return pdTRUE;\r
 150         }\r
 151         else\r
 152         {\r
 153                 return pdFALSE;\r
 154         }\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 159 {\r
 160 signed portBASE_TYPE xReturn;\r
 161 \r
 162         /* Transmit a character. */\r
 163 \r
 164         portENTER_CRITICAL();\r
 165         {\r
 166                 if( sTHREEmpty == pdTRUE )\r
 167                 {\r
 168                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that \r
 169                         there are no characters queued to be transmitted - so we can\r
 170                         write the character directly to the shift Tx register. */\r
 171                         sTHREEmpty = pdFALSE;\r
 172                         U1TXBUF = cOutChar;\r
 173                         xReturn = pdPASS;\r
 174                 }\r
 175                 else\r
 176                 {\r
 177                         /* sTHREEmpty is false, so there are still characters waiting to be\r
 178                         transmitted.  We have to queue this character so it gets \r
 179                         transmitted     in turn. */\r
 180 \r
 181                         /* Return false if after the block time there is no room on the Tx \r
 182                         queue.  It is ok to block inside a critical section as each task\r
 183                         maintains it's own critical section status. */\r
 184                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 185 \r
 186                         /* Depending on queue sizing and task prioritisation:  While we \r
 187                         were blocked waiting to post on the queue interrupts were not \r
 188                         disabled.  It is possible that the serial ISR has emptied the \r
 189                         Tx queue, in which case we need to start the Tx off again\r
 190                         writing directly to the Tx register. */\r
 191                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
 192                         {\r
 193                                 /* Get back the character we just posted. */\r
 194                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 195                                 sTHREEmpty = pdFALSE;\r
 196                                 U1TXBUF = cOutChar;\r
 197                         }\r
 198                 }\r
 199         }\r
 200         portEXIT_CRITICAL();\r
 201 \r
 202         return pdPASS;\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 /*\r
 207  * UART RX interrupt service routine.\r
 208  */\r
 209 interrupt (UART1RX_VECTOR) wakeup vRxISR( void )\r
 210 {\r
 211 signed portCHAR cChar;\r
 212 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 213 \r
 214         /* Get the character from the UART and post it on the queue of Rxed \r
 215         characters. */\r
 216         cChar = U1RXBUF;\r
 217 \r
 218         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 219 \r
 220         if( xHigherPriorityTaskWoken )\r
 221         {\r
 222                 /*If the post causes a task to wake force a context switch \r
 223                 as the woken task may have a higher priority than the task we have \r
 224                 interrupted. */\r
 225                 taskYIELD();\r
 226         }\r
 227 }\r
 228 /*-----------------------------------------------------------*/\r
 229 \r
 230 /*\r
 231  * UART Tx interrupt service routine.\r
 232  */\r
 233 interrupt (UART1TX_VECTOR) wakeup vTxISR( void )\r
 234 {\r
 235 signed portCHAR cChar;\r
 236 portBASE_TYPE xTaskWoken = pdFALSE;\r
 237 \r
 238         /* The previous character has been transmitted.  See if there are any\r
 239         further characters waiting transmission. */\r
 240 \r
 241         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 242         {\r
 243                 /* There was another character queued - transmit it now. */\r
 244                 U1TXBUF = cChar;\r
 245         }\r
 246         else\r
 247         {\r
 248                 /* There were no other characters to transmit. */\r
 249                 sTHREEmpty = pdTRUE;\r
 250         }\r
 251 }\r
 252 \r