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