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

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