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