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