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

   1 /*\r
   2     FreeRTOS V6.0.5 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\r
  22     *                                                                         *\r
  23     ***************************************************************************\r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public \r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it \r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained \r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.\r
  56  *\r
  57  * This file only supports UART 1\r
  58  */\r
  59 \r
  60 /* Standard includes. */\r
  61 #include <stdlib.h>\r
  62 \r
  63 /* Scheduler includes. */\r
  64 #include "FreeRTOS.h"\r
  65 #include "queue.h"\r
  66 #include "task.h"\r
  67 \r
  68 /* Demo application includes. */\r
  69 #include "serial.h"\r
  70 \r
  71 /* Constants required to setup the hardware. */\r
  72 #define serTX_AND_RX                    ( ( unsigned portCHAR ) 0x03 )\r
  73 \r
  74 /* Misc. constants. */\r
  75 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
  76 \r
  77 /* Enable the UART Tx interrupt. */\r
  78 #define vInterruptOn() IFG2 |= UTXIFG1\r
  79 \r
  80 /* The queue used to hold received characters. */\r
  81 static xQueueHandle xRxedChars;\r
  82 \r
  83 /* The queue used to hold characters waiting transmission. */\r
  84 static xQueueHandle xCharsForTx;\r
  85 \r
  86 static volatile portSHORT sTHREEmpty;\r
  87 \r
  88 /*-----------------------------------------------------------*/\r
  89 \r
  90 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  91 {\r
  92 unsigned portLONG 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 portCHAR ) );\r
 103                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\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 portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 118 \r
 119                 /* Setup baud rate high byte. */\r
 120                 ulBaudRateCount >>= 8UL;\r
 121                 U1BR1 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 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 portCHAR *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 portCHAR 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 #if configINTERRUPT_EXAMPLE_METHOD == 1\r
 208 \r
 209         /*\r
 210          * UART RX interrupt service routine.\r
 211          */\r
 212         #pragma vector=UART1RX_VECTOR\r
 213         __interrupt void vRxISR( void )\r
 214         {\r
 215         signed portCHAR cChar;\r
 216         portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 217         \r
 218                 /* Get the character from the UART and post it on the queue of Rxed\r
 219                 characters. */\r
 220                 cChar = U1RXBUF;\r
 221         \r
 222                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 223 \r
 224                 if( xHigherPriorityTaskWoken )\r
 225                 {\r
 226                         /*If the post causes a task to wake force a context switch\r
 227                         as the woken task may have a higher priority than the task we have\r
 228                         interrupted. */\r
 229                         taskYIELD();\r
 230                 }\r
 231 \r
 232         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 233         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 234         }\r
 235         /*-----------------------------------------------------------*/\r
 236         \r
 237         /*\r
 238          * UART Tx interrupt service routine.\r
 239          */\r
 240         #pragma vector=UART1TX_VECTOR\r
 241         __interrupt void vTxISR( void )\r
 242         {\r
 243         signed portCHAR cChar;\r
 244         portBASE_TYPE xTaskWoken = pdFALSE;\r
 245         \r
 246                 /* The previous character has been transmitted.  See if there are any\r
 247                 further characters waiting transmission. */\r
 248         \r
 249                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 250                 {\r
 251                         /* There was another character queued - transmit it now. */\r
 252                         U1TXBUF = cChar;\r
 253                 }\r
 254                 else\r
 255                 {\r
 256                         /* There were no other characters to transmit. */\r
 257                         sTHREEmpty = pdTRUE;\r
 258                 }\r
 259 \r
 260         /* Make sure any low power mode bits are clear before leaving the ISR. */\r
 261         __bic_SR_register_on_exit( SCG1 + SCG0 + OSCOFF + CPUOFF );\r
 262         }\r
 263     /*-----------------------------------------------------------*/\r
 264 \r
 265 #elif configINTERRUPT_EXAMPLE_METHOD == 2\r
 266 \r
 267     /* This is a standard C function as an assembly file wrapper is used as an\r
 268     interrupt entry point. */\r
 269         void vRxISR( void )\r
 270         {\r
 271         signed portCHAR cChar;\r
 272         portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 273         \r
 274                 /* Get the character from the UART and post it on the queue of Rxed\r
 275                 characters. */\r
 276                 cChar = U1RXBUF;\r
 277         \r
 278                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 279 \r
 280         /*If the post causes a task to wake force a context switch\r
 281         as the woken task may have a higher priority than the task we have\r
 282         interrupted. */\r
 283         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 284         }\r
 285         /*-----------------------------------------------------------*/\r
 286         \r
 287     /* This is a standard C function as an assembly file wrapper is used as an\r
 288     interrupt entry point. */\r
 289         void vTxISR( void )\r
 290         {\r
 291         signed portCHAR cChar;\r
 292         portBASE_TYPE xTaskWoken = pdFALSE;\r
 293         \r
 294                 /* The previous character has been transmitted.  See if there are any\r
 295                 further characters waiting transmission. */\r
 296         \r
 297                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 298                 {\r
 299                         /* There was another character queued - transmit it now. */\r
 300                         U1TXBUF = cChar;\r
 301                 }\r
 302                 else\r
 303                 {\r
 304                         /* There were no other characters to transmit. */\r
 305                         sTHREEmpty = pdTRUE;\r
 306                 }\r
 307         }\r
 308 \r
 309 #endif /* configINTERRUPT_EXAMPLE_METHOD */\r
 310 /*-----------------------------------------------------------*/\r