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

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 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     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 \r
  54 /* BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER.   \r
  55  * \r
  56  * This file only supports UART 1\r
  57  */\r
  58 \r
  59 /* Standard includes. */\r
  60 #include <stdlib.h>\r
  61 #include <signal.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 /* Interrupt service routines. */\r
  89 interrupt (UART1RX_VECTOR) wakeup vRxISR( void );\r
  90 interrupt (UART1TX_VECTOR) wakeup vTxISR( void );\r
  91 \r
  92 /*-----------------------------------------------------------*/\r
  93 \r
  94 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  95 {\r
  96 unsigned portLONG ulBaudRateCount;\r
  97 \r
  98         /* Initialise the hardware. */\r
  99 \r
 100         /* Generate the baud rate constants for the wanted baud rate. */\r
 101         ulBaudRateCount = configCPU_CLOCK_HZ / ulWantedBaud;\r
 102 \r
 103         portENTER_CRITICAL();\r
 104         {\r
 105                 /* Create the queues used by the com test task. */\r
 106                 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 107                 xCharsForTx = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 108 \r
 109                 /* Reset UART. */\r
 110                 UCTL1 |= SWRST;\r
 111 \r
 112                 /* Set pin function. */\r
 113                 P4SEL |= serTX_AND_RX;\r
 114 \r
 115                 /* All other bits remain at zero for n, 8, 1 interrupt driven operation. \r
 116                 LOOPBACK MODE!*/\r
 117                 U1CTL |= CHAR + LISTEN;\r
 118                 U1TCTL |= SSEL1;\r
 119 \r
 120                 /* Setup baud rate low byte. */\r
 121                 U1BR0 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 122 \r
 123                 /* Setup baud rate high byte. */\r
 124                 ulBaudRateCount >>= 8UL;\r
 125                 U1BR1 = ( unsigned portCHAR ) ( ulBaudRateCount & ( unsigned portLONG ) 0xff );\r
 126 \r
 127                 /* Enable ports. */\r
 128                 ME2 |= UTXE1 + URXE1;\r
 129 \r
 130                 /* Set. */\r
 131                 UCTL1 &= ~SWRST;\r
 132 \r
 133                 /* Nothing in the buffer yet. */\r
 134                 sTHREEmpty = pdTRUE;\r
 135 \r
 136                 /* Enable interrupts. */\r
 137                 IE2 |= URXIE1 + UTXIE1;\r
 138         }\r
 139         portEXIT_CRITICAL();\r
 140         \r
 141         /* Unlike other ports, this serial code does not allow for more than one\r
 142         com port.  We therefore don't return a pointer to a port structure and can\r
 143         instead just return NULL. */\r
 144         return NULL;\r
 145 }\r
 146 /*-----------------------------------------------------------*/\r
 147 \r
 148 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 149 {\r
 150         /* Get the next character from the buffer.  Return false if no characters\r
 151         are available, or arrive before xBlockTime expires. */\r
 152         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 153         {\r
 154                 return pdTRUE;\r
 155         }\r
 156         else\r
 157         {\r
 158                 return pdFALSE;\r
 159         }\r
 160 }\r
 161 /*-----------------------------------------------------------*/\r
 162 \r
 163 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 164 {\r
 165 signed portBASE_TYPE xReturn;\r
 166 \r
 167         /* Transmit a character. */\r
 168 \r
 169         portENTER_CRITICAL();\r
 170         {\r
 171                 if( sTHREEmpty == pdTRUE )\r
 172                 {\r
 173                         /* If sTHREEmpty is true then the UART Tx ISR has indicated that \r
 174                         there are no characters queued to be transmitted - so we can\r
 175                         write the character directly to the shift Tx register. */\r
 176                         sTHREEmpty = pdFALSE;\r
 177                         U1TXBUF = cOutChar;\r
 178                         xReturn = pdPASS;\r
 179                 }\r
 180                 else\r
 181                 {\r
 182                         /* sTHREEmpty is false, so there are still characters waiting to be\r
 183                         transmitted.  We have to queue this character so it gets \r
 184                         transmitted     in turn. */\r
 185 \r
 186                         /* Return false if after the block time there is no room on the Tx \r
 187                         queue.  It is ok to block inside a critical section as each task\r
 188                         maintains it's own critical section status. */\r
 189                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 190 \r
 191                         /* Depending on queue sizing and task prioritisation:  While we \r
 192                         were blocked waiting to post on the queue interrupts were not \r
 193                         disabled.  It is possible that the serial ISR has emptied the \r
 194                         Tx queue, in which case we need to start the Tx off again\r
 195                         writing directly to the Tx register. */\r
 196                         if( ( sTHREEmpty == pdTRUE ) && ( xReturn == pdPASS ) )\r
 197                         {\r
 198                                 /* Get back the character we just posted. */\r
 199                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 200                                 sTHREEmpty = pdFALSE;\r
 201                                 U1TXBUF = cOutChar;\r
 202                         }\r
 203                 }\r
 204         }\r
 205         portEXIT_CRITICAL();\r
 206 \r
 207         return pdPASS;\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 /*\r
 212  * UART RX interrupt service routine.\r
 213  */\r
 214 interrupt (UART1RX_VECTOR) wakeup vRxISR( void )\r
 215 {\r
 216 signed portCHAR cChar;\r
 217 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 218 \r
 219         /* Get the character from the UART and post it on the queue of Rxed \r
 220         characters. */\r
 221         cChar = U1RXBUF;\r
 222 \r
 223         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 224 \r
 225         if( xHigherPriorityTaskWoken )\r
 226         {\r
 227                 /*If the post causes a task to wake force a context switch \r
 228                 as the woken task may have a higher priority than the task we have \r
 229                 interrupted. */\r
 230                 taskYIELD();\r
 231         }\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 /*\r
 236  * UART Tx interrupt service routine.\r
 237  */\r
 238 interrupt (UART1TX_VECTOR) wakeup vTxISR( void )\r
 239 {\r
 240 signed portCHAR cChar;\r
 241 portBASE_TYPE xTaskWoken = pdFALSE;\r
 242 \r
 243         /* The previous character has been transmitted.  See if there are any\r
 244         further characters waiting transmission. */\r
 245 \r
 246         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWoken ) == pdTRUE )\r
 247         {\r
 248                 /* There was another character queued - transmit it now. */\r
 249                 U1TXBUF = cChar;\r
 250         }\r
 251         else\r
 252         {\r
 253                 /* There were no other characters to transmit. */\r
 254                 sTHREEmpty = pdTRUE;\r
 255         }\r
 256 }\r
 257 \r