git.sur5r.net Git - freertos/blob - Demo/ARM7_LPC2129_Keil_RVDS/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 /* \r
  52         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  53 \r
  54         Note this driver is used to test the FreeRTOS port.  It is NOT intended to\r
  55         be an example of an efficient implementation!\r
  56 */\r
  57 \r
  58 /* Standard includes. */\r
  59 #include <stdlib.h>\r
  60 \r
  61 /* Scheduler includes. */\r
  62 #include "FreeRTOS.h"\r
  63 #include "queue.h"\r
  64 #include "task.h"\r
  65 \r
  66 /* Demo application includes. */\r
  67 #include "serial.h"\r
  68 \r
  69 /*-----------------------------------------------------------*/\r
  70 \r
  71 /* Constants to setup and access the UART. */\r
  72 #define serDLAB                                                 ( ( unsigned portCHAR ) 0x80 )\r
  73 #define serENABLE_INTERRUPTS                    ( ( unsigned portCHAR ) 0x03 )\r
  74 #define serNO_PARITY                                    ( ( unsigned portCHAR ) 0x00 )\r
  75 #define ser1_STOP_BIT                                   ( ( unsigned portCHAR ) 0x00 )\r
  76 #define ser8_BIT_CHARS                                  ( ( unsigned portCHAR ) 0x03 )\r
  77 #define serFIFO_ON                                              ( ( unsigned portCHAR ) 0x01 )\r
  78 #define serCLEAR_FIFO                                   ( ( unsigned portCHAR ) 0x06 )\r
  79 #define serWANTED_CLOCK_SCALING                 ( ( unsigned portLONG ) 16 )\r
  80 \r
  81 /* Constants to setup and access the VIC. */\r
  82 #define serU0VIC_CHANNEL                                ( ( unsigned portLONG ) 0x0006 )\r
  83 #define serU0VIC_CHANNEL_BIT                    ( ( unsigned portLONG ) 0x0040 )\r
  84 #define serU0VIC_ENABLE                                 ( ( unsigned portLONG ) 0x0020 )\r
  85 \r
  86 /* Misc. */\r
  87 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  88 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  89 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  90 \r
  91 /* Constant to access the VIC. */\r
  92 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned portLONG ) 0 )\r
  93 \r
  94 /* Constants to determine the ISR source. */\r
  95 #define serSOURCE_THRE                                  ( ( unsigned portCHAR ) 0x02 )\r
  96 #define serSOURCE_RX_TIMEOUT                    ( ( unsigned portCHAR ) 0x0c )\r
  97 #define serSOURCE_ERROR                                 ( ( unsigned portCHAR ) 0x06 )\r
  98 #define serSOURCE_RX                                    ( ( unsigned portCHAR ) 0x04 )\r
  99 #define serINTERRUPT_SOURCE_MASK                ( ( unsigned portCHAR ) 0x0f )\r
 100 \r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 /*\r
 104  * The asm wrapper for the interrupt service routine.\r
 105  */\r
 106 extern void vUART_ISREntry(void);\r
 107 \r
 108 /* \r
 109  * The C function called from the asm wrapper. \r
 110  */\r
 111 void vUART_ISRHandler( void );\r
 112 \r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 /* Queues used to hold received characters, and characters waiting to be\r
 116 transmitted. */\r
 117 static xQueueHandle xRxedChars; \r
 118 static xQueueHandle xCharsForTx; \r
 119 \r
 120 /* Communication flag between the interrupt service routine and serial API. */\r
 121 static volatile portLONG lTHREEmpty;\r
 122 \r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 126 {\r
 127 unsigned portLONG ulDivisor, ulWantedClock;\r
 128 xComPortHandle xReturn = serHANDLE;\r
 129 \r
 130         /* Create the queues used to hold Rx and Tx characters. */\r
 131         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 132         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 133 \r
 134         /* Initialise the THRE empty flag. */\r
 135         lTHREEmpty = pdTRUE;\r
 136 \r
 137         if( \r
 138                 ( xRxedChars != serINVALID_QUEUE ) && \r
 139                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 140                 ( ulWantedBaud != ( unsigned portLONG ) 0 ) \r
 141           )\r
 142         {\r
 143                 portENTER_CRITICAL()\r
 144                 {\r
 145                         /* Setup the baud rate:  Calculate the divisor value. */\r
 146                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 147                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 148 \r
 149                         /* Set the DLAB bit so we can access the divisor. */\r
 150                         U0LCR |= serDLAB;\r
 151 \r
 152                         /* Setup the divisor. */\r
 153                         U0DLL = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 154                         ulDivisor >>= 8;\r
 155                         U0DLM = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 156 \r
 157                         /* Turn on the FIFO's and clear the buffers. */\r
 158                         U0FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 159 \r
 160                         /* Setup transmission format. */\r
 161                         U0LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 162 \r
 163                         /* Setup the VIC for the UART. */\r
 164                         VICIntSelect &= ~( serU0VIC_CHANNEL_BIT );\r
 165                         VICIntEnable |= serU0VIC_CHANNEL_BIT;\r
 166                         VICVectAddr1 = ( unsigned portLONG ) vUART_ISREntry;\r
 167                         VICVectCntl1 = serU0VIC_CHANNEL | serU0VIC_ENABLE;\r
 168 \r
 169                         /* Enable UART0 interrupts. */\r
 170                         U0IER |= serENABLE_INTERRUPTS;\r
 171                 }\r
 172                 portEXIT_CRITICAL();\r
 173         }\r
 174         else\r
 175         {\r
 176                 xReturn = ( xComPortHandle ) 0;\r
 177         }\r
 178 \r
 179         return xReturn;\r
 180 }\r
 181 /*-----------------------------------------------------------*/\r
 182 \r
 183 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 184 {\r
 185         /* The port handle is not required as this driver only supports UART0. */\r
 186         ( void ) pxPort;\r
 187 \r
 188         /* Get the next character from the buffer.  Return false if no characters\r
 189         are available, or arrive before xBlockTime expires. */\r
 190         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 191         {\r
 192                 return pdTRUE;\r
 193         }\r
 194         else\r
 195         {\r
 196                 return pdFALSE;\r
 197         }\r
 198 }\r
 199 /*-----------------------------------------------------------*/\r
 200 \r
 201 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 202 {\r
 203 signed portCHAR *pxNext;\r
 204 \r
 205         /* NOTE: This implementation does not handle the queue being full as no\r
 206         block time is used! */\r
 207 \r
 208         /* The port handle is not required as this driver only supports UART0. */\r
 209         ( void ) pxPort;\r
 210         ( void ) usStringLength;\r
 211 \r
 212         /* Send each character in the string, one at a time. */\r
 213         pxNext = ( signed portCHAR * ) pcString;\r
 214         while( *pxNext )\r
 215         {\r
 216                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 217                 pxNext++;\r
 218         }\r
 219 }\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 223 {\r
 224 signed portBASE_TYPE xReturn;\r
 225 \r
 226         /* The port handle is not required as this driver only supports UART0. */\r
 227         ( void ) pxPort;\r
 228 \r
 229         portENTER_CRITICAL();\r
 230         {\r
 231                 /* Is there space to write directly to the UART? */\r
 232                 if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 233                 {\r
 234                         /* We wrote the character directly to the UART, so was \r
 235                         successful. */\r
 236                         lTHREEmpty = pdFALSE;\r
 237                         U0THR = cOutChar;\r
 238                         xReturn = pdPASS;\r
 239                 }\r
 240                 else \r
 241                 {\r
 242                         /* We cannot write directly to the UART, so queue the character.\r
 243                         Block for a maximum of xBlockTime if there is no space in the\r
 244                         queue.  It is ok to block within a critical section as each\r
 245                         task has it's own critical section management. */\r
 246                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 247 \r
 248                         /* Depending on queue sizing and task prioritisation:  While we \r
 249                         were blocked waiting to post interrupts were not disabled.  It is \r
 250                         possible that the serial ISR has emptied the Tx queue, in which\r
 251                         case we need to start the Tx off again. */\r
 252                         if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 253                         {\r
 254                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 255                                 lTHREEmpty = pdFALSE;\r
 256                                 U0THR = cOutChar;\r
 257                         }\r
 258                 }\r
 259         }\r
 260         portEXIT_CRITICAL();\r
 261 \r
 262         return xReturn;\r
 263 }\r
 264 /*-----------------------------------------------------------*/\r
 265 \r
 266 void vUART_ISRHandler( void )\r
 267 {\r
 268 signed portCHAR cChar;\r
 269 portBASE_TYPE xTaskWokenByRx, xTaskWokenByTx;\r
 270 \r
 271         xTaskWokenByTx = pdFALSE;\r
 272         xTaskWokenByRx = pdFALSE;\r
 273 \r
 274         /* What caused the interrupt? */\r
 275         switch( U0IIR & serINTERRUPT_SOURCE_MASK )\r
 276         {\r
 277                 case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 278                                                                 cChar = U0LSR;\r
 279                                                                 break;\r
 280 \r
 281                 case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 282                                                                 character in the Tx queue, send it now. */\r
 283                                                                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWokenByTx ) == pdTRUE )\r
 284                                                                 {\r
 285                                                                         U0THR = cChar;\r
 286                                                                 }\r
 287                                                                 else\r
 288                                                                 {\r
 289                                                                         /* There are no further characters \r
 290                                                                         queued to send so we can indicate \r
 291                                                                         that the THRE is available. */\r
 292                                                                         lTHREEmpty = pdTRUE;\r
 293                                                                 }\r
 294                                                                 break;\r
 295 \r
 296                 case serSOURCE_RX_TIMEOUT :\r
 297                 case serSOURCE_RX       :       /* A character was received.  Place it in \r
 298                                                                 the queue of received characters. */\r
 299                                                                 cChar = U0RBR;\r
 300                                                                 if( xQueueSendFromISR( xRxedChars, &cChar, pdFALSE ) )\r
 301                                                                 {\r
 302                                                                         xTaskWokenByRx = pdTRUE;\r
 303                                                                 }\r
 304                                                                 break;\r
 305 \r
 306                 default                         :       /* There is nothing to do, leave the ISR. */\r
 307                                                                 break;\r
 308         }\r
 309 \r
 310         /* Clear the ISR in the VIC. */\r
 311         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 312 \r
 313         /* Exit the ISR.  If a task was woken by either a character being received\r
 314         or transmitted then a context switch will occur. */\r
 315         portEXIT_SWITCHING_ISR( ( xTaskWokenByTx || xTaskWokenByRx ) );\r
 316 }\r
 317 /*-----------------------------------------------------------*/\r
 318 \r
 319 \r
 320 \r
 321 \r
 322 \r
 323 \r
 324         \r