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

   1 /*\r
   2         FreeRTOS.org V5.1.1 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\r
  29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
  30     * and even write all or part of your application on your behalf.          *\r
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
  32     * expedite your project.                                                  *\r
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 \r
  51 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.\r
  52  *\r
  53  * This file only supports UART 1\r
  54  */\r
  55 \r
  56 /* Standard includes. */\r
  57 #include <stdlib.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 portCHAR ) 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 portSHORT sTHREEmpty;\r
  83 \r
  84 /*-----------------------------------------------------------*/\r
  85 \r
  86 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  87 {\r
  88 unsigned portLONG ulBaudRateCount;\r
  89 \r
  90         /* Initialise the hardware. */\r
  91 \r
  92         /* Generate the baud rate constants for the wanted baud rate. */\r
  93         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
  94 \r
  95         portENTER_CRITICAL();\r
  96         {\r
  97                 /* Create the queues used by the com test task. */\r
  98                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  99                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 100 \r
 101                 /* Reset UART. */\r
 102                 UCTL1 |= SWRST;\r
 103 \r
 104                 /* Set pin function. */\r
 105                 P4SEL |= serTX_AND_RX;\r
 106 \r
 107                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation.\r
 108                 LOOPBACK MODE!*/\r
 109                 U1CTL |= CHAR + LISTEN;\r
 110                 U1TCTL |= SSEL1;\r
 111 \r
 112                 /* Setup baud rate low byte. */\r
 113                 U1BR0 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 114 \r
 115                 /* Setup baud rate high byte. */\r
 116                 ulBaudRateCount >>= 8UL;\r
 117                 U1BR1 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 118 \r
 119                 /* Enable ports. */\r
 120                 ME2 |= UTXE1 + URXE1;\r
 121 \r
 122                 /* Set. */\r
 123                 UCTL1 &= ~SWRST;\r
 124 \r
 125                 /* Nothing in the buffer yet. */\r
 126                 sTHREEmpty = pdTRUE;\r
 127 \r
 128                 /* Enable interrupts. */\r
 129                 IE2 |= URXIE1 + UTXIE1;\r
 130         }\r
 131         portEXIT_CRITICAL();\r
 132         \r
 133         /* Unlike other ports, this serial code does not allow for more than one\r
 134         com port.  We therefore don't return a pointer to a port structure and can\r
 135         instead just return NULL. */\r
 136         return NULL;\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 141 {\r
 142         /* Get the next character from the buffer.  Return false if no characters\r
 143         are available, or arrive before xBlockTime expires. */\r
 144         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 145         {\r
 146                 return pdTRUE;\r
 147         }\r
 148         else\r
 149         {\r
 150                 return pdFALSE;\r
 151         }\r
 152 }\r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 156 {\r
 157 signed portBASE_TYPE xReturn;\r
 158 \r
 159         /* Transmit a character. */\r
 160 \r
 161         portENTER_CRITICAL();\r
 162         {\r
 163                 if( sTHREEmpty == pdTRUE )\r
 164                 {\r
 165                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that\r
 166                         there are no characters queued to be transmitted - so we can\r
 167                         write the character directly to the shift Tx register. */\r
 168                         sTHREEmpty = pdFALSE;\r
 169                         U1TXBUF = cOutChar;\r
 170                         xReturn = pdPASS;\r
 171                 }\r
 172                 else\r
 173                 {\r
 174                         /* sTHREEmpty is false, so there are still characters waiting to be\r
 175                         transmitted.  We have to queue this character so it gets\r
 176                         transmitted     in turn. */\r
 177 \r
 178                         /* Return false if after the block time there is no room on the Tx\r
 179                         queue.  It is ok to block inside a critical section as each task\r
 180                         maintains it's own critical section status. */\r
 181                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 182 \r
 183                         /* Depending on queue sizing and task prioritisation:  While we\r
 184                         were blocked waiting to post on the queue interrupts were not\r
 185                         disabled.  It is possible that the serial ISR has emptied the\r
 186                         Tx queue, in which case we need to start the Tx off again\r
 187                         writing directly to the Tx register. */\r
 188                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
 189                         {\r
 190                                 /* Get back the character we just posted. */\r
 191                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 192                                 sTHREEmpty = pdFALSE;\r
 193                                 U1TXBUF = cOutChar;\r
 194                         }\r
 195                 }\r
 196         }\r
 197         portEXIT_CRITICAL();\r
 198 \r
 199         return pdPASS;\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 #if configINTERRUPT_EXAMPLE_METHOD == 1\r
 204 \r
 205         /*\r
 206          * UART RX interrupt service routine.\r
 207          */\r
 208         #pragma vector=UART1RX_VECTOR\r
 209         __interrupt void 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         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 229         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 230         }\r
 231         /*-----------------------------------------------------------*/\r
 232         \r
 233         /*\r
 234          * UART Tx interrupt service routine.\r
 235          */\r
 236         #pragma vector=UART1TX_VECTOR\r
 237         __interrupt void vTxISR( void )\r
 238         {\r
 239         signed portCHAR cChar;\r
 240         portBASE_TYPE xTaskWoken = pdFALSE;\r
 241         \r
 242                 /* The previous character has been transmitted.  See if there are any\r
 243                 further characters waiting transmission. */\r
 244         \r
 245                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 246                 {\r
 247                         /* There was another character queued - transmit it now. */\r
 248                         U1TXBUF = cChar;\r
 249                 }\r
 250                 else\r
 251                 {\r
 252                         /* There were no other characters to transmit. */\r
 253                         sTHREEmpty = pdTRUE;\r
 254                 }\r
 255 \r
 256         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 257         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 258         }\r
 259     /*-----------------------------------------------------------*/\r
 260 \r
 261 #elif configINTERRUPT_EXAMPLE_METHOD == 2\r
 262 \r
 263     /* This is a standard C function as an assembly file wrapper is used as an\r
 264     interrupt entry point. */\r
 265         void vRxISR( void )\r
 266         {\r
 267         signed portCHAR cChar;\r
 268         portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 269         \r
 270                 /* Get the character from the UART and post it on the queue of Rxed\r
 271                 characters. */\r
 272                 cChar = U1RXBUF;\r
 273         \r
 274                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 275 \r
 276         /*If the post causes a task to wake force a context switch\r
 277         as the woken task may have a higher priority than the task we have\r
 278         interrupted. */\r
 279         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 280         }\r
 281         /*-----------------------------------------------------------*/\r
 282         \r
 283     /* This is a standard C function as an assembly file wrapper is used as an\r
 284     interrupt entry point. */\r
 285         void vTxISR( void )\r
 286         {\r
 287         signed portCHAR cChar;\r
 288         portBASE_TYPE xTaskWoken = pdFALSE;\r
 289         \r
 290                 /* The previous character has been transmitted.  See if there are any\r
 291                 further characters waiting transmission. */\r
 292         \r
 293                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 294                 {\r
 295                         /* There was another character queued - transmit it now. */\r
 296                         U1TXBUF = cChar;\r
 297                 }\r
 298                 else\r
 299                 {\r
 300                         /* There were no other characters to transmit. */\r
 301                         sTHREEmpty = pdTRUE;\r
 302                 }\r
 303         }\r
 304 \r
 305 #endif /* configINTERRUPT_EXAMPLE_METHOD */\r
 306 /*-----------------------------------------------------------*/\r