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 serU1VIC_CHANNEL                                ( ( unsigned portLONG ) 0x0007 )\r
  83 #define serU1VIC_CHANNEL_BIT                    ( ( unsigned portLONG ) 0x0080 )\r
  84 #define serU1VIC_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 #define serINTERRUPT_IS_PENDING                 ( ( unsigned portCHAR ) 0x01 )\r
 101 \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /*\r
 105  * The asm wrapper for the interrupt service routine.\r
 106  */\r
 107 extern void vUART_ISREntry( void );\r
 108 \r
 109 /* \r
 110  * The C function called from the asm wrapper. \r
 111  */\r
 112 void vUART_ISRHandler( void );\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /* Queues used to hold received characters, and characters waiting to be\r
 117 transmitted. */\r
 118 static xQueueHandle xRxedChars; \r
 119 static xQueueHandle xCharsForTx; \r
 120 \r
 121 /* Communication flag between the interrupt service routine and serial API. */\r
 122 static volatile portLONG lTHREEmpty;\r
 123 \r
 124 /*-----------------------------------------------------------*/\r
 125 \r
 126 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 127 {\r
 128 unsigned portLONG ulDivisor, ulWantedClock;\r
 129 xComPortHandle xReturn = serHANDLE;\r
 130 \r
 131         /* Create the queues used to hold Rx and Tx characters. */\r
 132         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 133         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 134 \r
 135         /* Initialise the THRE empty flag. */\r
 136         lTHREEmpty = pdTRUE;\r
 137 \r
 138         if( \r
 139                 ( xRxedChars != serINVALID_QUEUE ) && \r
 140                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 141                 ( ulWantedBaud != ( unsigned portLONG ) 0 ) \r
 142           )\r
 143         {\r
 144                 portENTER_CRITICAL()\r
 145                 {\r
 146                         /* Setup the baud rate:  Calculate the divisor value. */\r
 147                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 148                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 149 \r
 150                         /* Set the DLAB bit so we can access the divisor. */\r
 151                         U1LCR |= serDLAB;\r
 152 \r
 153                         /* Setup the divisor. */\r
 154                         U1DLL = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 155                         ulDivisor >>= 8;\r
 156                         U1DLM = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 157 \r
 158                         /* Turn on the FIFO's and clear the buffers. */\r
 159                         U1FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 160 \r
 161                         /* Setup transmission format. */\r
 162                         U1LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 163 \r
 164                         /* Setup the VIC for the UART. */\r
 165                         VICIntSelect &= ~( serU1VIC_CHANNEL_BIT );\r
 166                         VICIntEnable |= serU1VIC_CHANNEL_BIT;\r
 167                         VICVectAddr1 = ( unsigned portLONG ) vUART_ISREntry;\r
 168                         VICVectCntl1 = serU1VIC_CHANNEL | serU1VIC_ENABLE;\r
 169 \r
 170                         /* Enable UART0 interrupts. */\r
 171                         U1IER |= serENABLE_INTERRUPTS;\r
 172                 }\r
 173                 portEXIT_CRITICAL();\r
 174         }\r
 175         else\r
 176         {\r
 177                 xReturn = ( xComPortHandle ) 0;\r
 178         }\r
 179 \r
 180         return xReturn;\r
 181 }\r
 182 /*-----------------------------------------------------------*/\r
 183 \r
 184 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 185 {\r
 186         /* The port handle is not required as this driver only supports UART0. */\r
 187         ( void ) pxPort;\r
 188 \r
 189         /* Get the next character from the buffer.  Return false if no characters\r
 190         are available, or arrive before xBlockTime expires. */\r
 191         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 192         {\r
 193                 return pdTRUE;\r
 194         }\r
 195         else\r
 196         {\r
 197                 return pdFALSE;\r
 198         }\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 203 {\r
 204 signed portCHAR *pxNext;\r
 205 \r
 206         /* NOTE: This implementation does not handle the queue being full as no\r
 207         block time is used! */\r
 208 \r
 209         /* The port handle is not required as this driver only supports UART0. */\r
 210         ( void ) pxPort;\r
 211         ( void ) usStringLength;\r
 212 \r
 213         /* Send each character in the string, one at a time. */\r
 214         pxNext = ( signed portCHAR * ) pcString;\r
 215         while( *pxNext )\r
 216         {\r
 217                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 218                 pxNext++;\r
 219         }\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 224 {\r
 225 signed portBASE_TYPE xReturn;\r
 226 \r
 227         /* The port handle is not required as this driver only supports UART0. */\r
 228         ( void ) pxPort;\r
 229 \r
 230         portENTER_CRITICAL();\r
 231         {\r
 232                 /* Is there space to write directly to the UART? */\r
 233                 if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 234                 {\r
 235                         /* We wrote the character directly to the UART, so was \r
 236                         successful. */\r
 237                         lTHREEmpty = pdFALSE;\r
 238                         U1THR = cOutChar;\r
 239                         xReturn = pdPASS;\r
 240                 }\r
 241                 else \r
 242                 {\r
 243                         /* We cannot write directly to the UART, so queue the character.\r
 244                         Block for a maximum of xBlockTime if there is no space in the\r
 245                         queue.  It is ok to block within a critical section as each\r
 246                         task has it's own critical section management. */\r
 247                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 248 \r
 249                         /* Depending on queue sizing and task prioritisation:  While we \r
 250                         were blocked waiting to post interrupts were not disabled.  It is \r
 251                         possible that the serial ISR has emptied the Tx queue, in which\r
 252                         case we need to start the Tx off again. */\r
 253                         if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 254                         {\r
 255                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 256                                 lTHREEmpty = pdFALSE;\r
 257                                 U1THR = cOutChar;\r
 258                         }\r
 259                 }\r
 260         }\r
 261         portEXIT_CRITICAL();\r
 262 \r
 263         return xReturn;\r
 264 }\r
 265 /*-----------------------------------------------------------*/\r
 266 \r
 267 void vUART_ISRHandler( void )\r
 268 {\r
 269 signed portCHAR cChar;\r
 270 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 271 unsigned portCHAR ucInterrupt;\r
 272 \r
 273         ucInterrupt = U1IIR;\r
 274 \r
 275         /* The interrupt pending bit is active low. */\r
 276         while( ( ucInterrupt & serINTERRUPT_IS_PENDING ) == 0 )\r
 277         {\r
 278                 /* What caused the interrupt? */\r
 279                 switch( ucInterrupt & serINTERRUPT_SOURCE_MASK )\r
 280                 {\r
 281                         case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 282                                                                         cChar = U1LSR;\r
 283                                                                         break;\r
 284         \r
 285                         case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 286                                                                         character in the Tx queue, send it now. */\r
 287                                                                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 288                                                                         {\r
 289                                                                                 U1THR = cChar;\r
 290                                                                         }\r
 291                                                                         else\r
 292                                                                         {\r
 293                                                                                 /* There are no further characters \r
 294                                                                                 queued to send so we can indicate \r
 295                                                                                 that the THRE is available. */\r
 296                                                                                 lTHREEmpty = pdTRUE;\r
 297                                                                         }\r
 298                                                                         break;\r
 299         \r
 300                         case serSOURCE_RX_TIMEOUT :\r
 301                         case serSOURCE_RX       :       /* A character was received.  Place it in \r
 302                                                                         the queue of received characters. */\r
 303                                                                         cChar = U1RBR;\r
 304                                                                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 305                                                                         break;\r
 306         \r
 307                         default                         :       /* There is nothing to do, leave the ISR. */\r
 308                                                                         break;\r
 309                 }\r
 310 \r
 311                 ucInterrupt = U1IIR;\r
 312         }\r
 313 \r
 314         /* Clear the ISR in the VIC. */\r
 315         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 316 \r
 317         /* Exit the ISR.  If a task was woken by either a character being received\r
 318         or transmitted then a context switch will occur. */\r
 319         portEXIT_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 320 }\r
 321 /*-----------------------------------------------------------*/\r
 322 \r
 323 \r
 324 \r
 325 \r
 326 \r
 327 \r
 328         \r