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

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