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

   1 /*\r
   2         FreeRTOS V5.4.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 \r
  49 /* \r
  50         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  51 \r
  52         Note this driver is used to test the FreeRTOS port.  It is NOT intended to\r
  53         be an example of an efficient implementation!\r
  54 */\r
  55 \r
  56 /* Standard includes. */\r
  57 #include <stdlib.h>\r
  58 \r
  59 /* Scheduler includes. */\r
  60 #include "FreeRTOS.h"\r
  61 #include "queue.h"\r
  62 #include "task.h"\r
  63 \r
  64 /* Demo application includes. */\r
  65 #include "serial.h"\r
  66 \r
  67 /*-----------------------------------------------------------*/\r
  68 \r
  69 /* Constants to setup and access the UART. */\r
  70 #define serDLAB                                                 ( ( unsigned portCHAR ) 0x80 )\r
  71 #define serENABLE_INTERRUPTS                    ( ( unsigned portCHAR ) 0x03 )\r
  72 #define serNO_PARITY                                    ( ( unsigned portCHAR ) 0x00 )\r
  73 #define ser1_STOP_BIT                                   ( ( unsigned portCHAR ) 0x00 )\r
  74 #define ser8_BIT_CHARS                                  ( ( unsigned portCHAR ) 0x03 )\r
  75 #define serFIFO_ON                                              ( ( unsigned portCHAR ) 0x01 )\r
  76 #define serCLEAR_FIFO                                   ( ( unsigned portCHAR ) 0x06 )\r
  77 #define serWANTED_CLOCK_SCALING                 ( ( unsigned portLONG ) 16 )\r
  78 \r
  79 /* Constants to setup and access the VIC. */\r
  80 #define serU1VIC_CHANNEL                                ( ( unsigned portLONG ) 0x0007 )\r
  81 #define serU1VIC_CHANNEL_BIT                    ( ( unsigned portLONG ) 0x0080 )\r
  82 #define serU1VIC_ENABLE                                 ( ( unsigned portLONG ) 0x0020 )\r
  83 \r
  84 /* Misc. */\r
  85 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  86 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  87 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  88 \r
  89 /* Constant to access the VIC. */\r
  90 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned portLONG ) 0 )\r
  91 \r
  92 /* Constants to determine the ISR source. */\r
  93 #define serSOURCE_THRE                                  ( ( unsigned portCHAR ) 0x02 )\r
  94 #define serSOURCE_RX_TIMEOUT                    ( ( unsigned portCHAR ) 0x0c )\r
  95 #define serSOURCE_ERROR                                 ( ( unsigned portCHAR ) 0x06 )\r
  96 #define serSOURCE_RX                                    ( ( unsigned portCHAR ) 0x04 )\r
  97 #define serINTERRUPT_SOURCE_MASK                ( ( unsigned portCHAR ) 0x0f )\r
  98 #define serINTERRUPT_IS_PENDING                 ( ( unsigned portCHAR ) 0x01 )\r
  99 \r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /*\r
 103  * The asm wrapper for the interrupt service routine.\r
 104  */\r
 105 extern void vUART_ISREntry( void );\r
 106 \r
 107 /* \r
 108  * The C function called from the asm wrapper. \r
 109  */\r
 110 void vUART_ISRHandler( void );\r
 111 \r
 112 /*-----------------------------------------------------------*/\r
 113 \r
 114 /* Queues used to hold received characters, and characters waiting to be\r
 115 transmitted. */\r
 116 static xQueueHandle xRxedChars; \r
 117 static xQueueHandle xCharsForTx; \r
 118 \r
 119 /* Communication flag between the interrupt service routine and serial API. */\r
 120 static volatile portLONG lTHREEmpty;\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 125 {\r
 126 unsigned portLONG ulDivisor, ulWantedClock;\r
 127 xComPortHandle xReturn = serHANDLE;\r
 128 \r
 129         /* Create the queues used to hold Rx and Tx characters. */\r
 130         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 131         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 132 \r
 133         /* Initialise the THRE empty flag. */\r
 134         lTHREEmpty = pdTRUE;\r
 135 \r
 136         if( \r
 137                 ( xRxedChars != serINVALID_QUEUE ) && \r
 138                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 139                 ( ulWantedBaud != ( unsigned portLONG ) 0 ) \r
 140           )\r
 141         {\r
 142                 portENTER_CRITICAL()\r
 143                 {\r
 144                         /* Setup the baud rate:  Calculate the divisor value. */\r
 145                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 146                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 147 \r
 148                         /* Set the DLAB bit so we can access the divisor. */\r
 149                         U1LCR |= serDLAB;\r
 150 \r
 151                         /* Setup the divisor. */\r
 152                         U1DLL = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 153                         ulDivisor >>= 8;\r
 154                         U1DLM = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 155 \r
 156                         /* Turn on the FIFO's and clear the buffers. */\r
 157                         U1FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 158 \r
 159                         /* Setup transmission format. */\r
 160                         U1LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 161 \r
 162                         /* Setup the VIC for the UART. */\r
 163                         VICIntSelect &= ~( serU1VIC_CHANNEL_BIT );\r
 164                         VICIntEnable |= serU1VIC_CHANNEL_BIT;\r
 165                         VICVectAddr1 = ( unsigned portLONG ) vUART_ISREntry;\r
 166                         VICVectCntl1 = serU1VIC_CHANNEL | serU1VIC_ENABLE;\r
 167 \r
 168                         /* Enable UART0 interrupts. */\r
 169                         U1IER |= serENABLE_INTERRUPTS;\r
 170                 }\r
 171                 portEXIT_CRITICAL();\r
 172         }\r
 173         else\r
 174         {\r
 175                 xReturn = ( xComPortHandle ) 0;\r
 176         }\r
 177 \r
 178         return xReturn;\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 183 {\r
 184         /* The port handle is not required as this driver only supports UART0. */\r
 185         ( void ) pxPort;\r
 186 \r
 187         /* Get the next character from the buffer.  Return false if no characters\r
 188         are available, or arrive before xBlockTime expires. */\r
 189         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 190         {\r
 191                 return pdTRUE;\r
 192         }\r
 193         else\r
 194         {\r
 195                 return pdFALSE;\r
 196         }\r
 197 }\r
 198 /*-----------------------------------------------------------*/\r
 199 \r
 200 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 201 {\r
 202 signed portCHAR *pxNext;\r
 203 \r
 204         /* NOTE: This implementation does not handle the queue being full as no\r
 205         block time is used! */\r
 206 \r
 207         /* The port handle is not required as this driver only supports UART0. */\r
 208         ( void ) pxPort;\r
 209         ( void ) usStringLength;\r
 210 \r
 211         /* Send each character in the string, one at a time. */\r
 212         pxNext = ( signed portCHAR * ) pcString;\r
 213         while( *pxNext )\r
 214         {\r
 215                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 216                 pxNext++;\r
 217         }\r
 218 }\r
 219 /*-----------------------------------------------------------*/\r
 220 \r
 221 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 222 {\r
 223 signed portBASE_TYPE xReturn;\r
 224 \r
 225         /* The port handle is not required as this driver only supports UART0. */\r
 226         ( void ) pxPort;\r
 227 \r
 228         portENTER_CRITICAL();\r
 229         {\r
 230                 /* Is there space to write directly to the UART? */\r
 231                 if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 232                 {\r
 233                         /* We wrote the character directly to the UART, so was \r
 234                         successful. */\r
 235                         lTHREEmpty = pdFALSE;\r
 236                         U1THR = cOutChar;\r
 237                         xReturn = pdPASS;\r
 238                 }\r
 239                 else \r
 240                 {\r
 241                         /* We cannot write directly to the UART, so queue the character.\r
 242                         Block for a maximum of xBlockTime if there is no space in the\r
 243                         queue.  It is ok to block within a critical section as each\r
 244                         task has it's own critical section management. */\r
 245                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 246 \r
 247                         /* Depending on queue sizing and task prioritisation:  While we \r
 248                         were blocked waiting to post interrupts were not disabled.  It is \r
 249                         possible that the serial ISR has emptied the Tx queue, in which\r
 250                         case we need to start the Tx off again. */\r
 251                         if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 252                         {\r
 253                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 254                                 lTHREEmpty = pdFALSE;\r
 255                                 U1THR = cOutChar;\r
 256                         }\r
 257                 }\r
 258         }\r
 259         portEXIT_CRITICAL();\r
 260 \r
 261         return xReturn;\r
 262 }\r
 263 /*-----------------------------------------------------------*/\r
 264 \r
 265 void vUART_ISRHandler( void )\r
 266 {\r
 267 signed portCHAR cChar;\r
 268 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 269 unsigned portCHAR ucInterrupt;\r
 270 \r
 271         ucInterrupt = U1IIR;\r
 272 \r
 273         /* The interrupt pending bit is active low. */\r
 274         while( ( ucInterrupt & serINTERRUPT_IS_PENDING ) == 0 )\r
 275         {\r
 276                 /* What caused the interrupt? */\r
 277                 switch( ucInterrupt & serINTERRUPT_SOURCE_MASK )\r
 278                 {\r
 279                         case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 280                                                                         cChar = U1LSR;\r
 281                                                                         break;\r
 282         \r
 283                         case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 284                                                                         character in the Tx queue, send it now. */\r
 285                                                                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 286                                                                         {\r
 287                                                                                 U1THR = cChar;\r
 288                                                                         }\r
 289                                                                         else\r
 290                                                                         {\r
 291                                                                                 /* There are no further characters \r
 292                                                                                 queued to send so we can indicate \r
 293                                                                                 that the THRE is available. */\r
 294                                                                                 lTHREEmpty = pdTRUE;\r
 295                                                                         }\r
 296                                                                         break;\r
 297         \r
 298                         case serSOURCE_RX_TIMEOUT :\r
 299                         case serSOURCE_RX       :       /* A character was received.  Place it in \r
 300                                                                         the queue of received characters. */\r
 301                                                                         cChar = U1RBR;\r
 302                                                                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 303                                                                         break;\r
 304         \r
 305                         default                         :       /* There is nothing to do, leave the ISR. */\r
 306                                                                         break;\r
 307                 }\r
 308 \r
 309                 ucInterrupt = U1IIR;\r
 310         }\r
 311 \r
 312         /* Clear the ISR in the VIC. */\r
 313         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 314 \r
 315         /* Exit the ISR.  If a task was woken by either a character being received\r
 316         or transmitted then a context switch will occur. */\r
 317         portEXIT_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 318 }\r
 319 /*-----------------------------------------------------------*/\r
 320 \r
 321 \r
 322 \r
 323 \r
 324 \r
 325 \r
 326         \r