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

   1 /*\r
   2     FreeRTOS V6.0.0 - 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     * The FreeRTOS eBook and reference manual are available to purchase for a *\r
  29     * small fee. Help yourself get started quickly while also helping the     *\r
  30     * FreeRTOS project! See http://www.FreeRTOS.org/Documentation for details *\r
  31     *                                                                         *\r
  32     ***************************************************************************\r
  33 \r
  34     1 tab == 4 spaces!\r
  35 \r
  36     Please ensure to read the configuration and relevant port sections of the\r
  37     online documentation.\r
  38 \r
  39     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  40     contact details.\r
  41 \r
  42     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  43     critical systems.\r
  44 \r
  45     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  46     licensing and training services.\r
  47 */\r
  48 \r
  49 \r
  50 /* \r
  51         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  52 \r
  53         Note this driver is used to test the FreeRTOS port.  It is NOT intended to\r
  54         be an example of an efficient implementation!\r
  55 */\r
  56 \r
  57 /* Standard includes. */\r
  58 #include <stdlib.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 /*-----------------------------------------------------------*/\r
  69 \r
  70 /* Constants to setup and access the UART. */\r
  71 #define serDLAB                                                 ( ( unsigned char ) 0x80 )\r
  72 #define serENABLE_INTERRUPTS                    ( ( unsigned char ) 0x03 )\r
  73 #define serNO_PARITY                                    ( ( unsigned char ) 0x00 )\r
  74 #define ser1_STOP_BIT                                   ( ( unsigned char ) 0x00 )\r
  75 #define ser8_BIT_CHARS                                  ( ( unsigned char ) 0x03 )\r
  76 #define serFIFO_ON                                              ( ( unsigned char ) 0x01 )\r
  77 #define serCLEAR_FIFO                                   ( ( unsigned char ) 0x06 )\r
  78 #define serWANTED_CLOCK_SCALING                 ( ( unsigned long ) 16 )\r
  79 \r
  80 /* Constants to setup and access the VIC. */\r
  81 #define serU1VIC_CHANNEL                                ( ( unsigned long ) 0x0007 )\r
  82 #define serU1VIC_CHANNEL_BIT                    ( ( unsigned long ) 0x0080 )\r
  83 #define serU1VIC_ENABLE                                 ( ( unsigned long ) 0x0020 )\r
  84 \r
  85 /* Misc. */\r
  86 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  87 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  88 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  89 \r
  90 /* Constant to access the VIC. */\r
  91 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned long ) 0 )\r
  92 \r
  93 /* Constants to determine the ISR source. */\r
  94 #define serSOURCE_THRE                                  ( ( unsigned char ) 0x02 )\r
  95 #define serSOURCE_RX_TIMEOUT                    ( ( unsigned char ) 0x0c )\r
  96 #define serSOURCE_ERROR                                 ( ( unsigned char ) 0x06 )\r
  97 #define serSOURCE_RX                                    ( ( unsigned char ) 0x04 )\r
  98 #define serINTERRUPT_SOURCE_MASK                ( ( unsigned char ) 0x0f )\r
  99 #define serINTERRUPT_IS_PENDING                 ( ( unsigned char ) 0x01 )\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 long lTHREEmpty;\r
 122 \r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 126 {\r
 127 unsigned long 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 char ) );\r
 132         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\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 long ) 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                         U1LCR |= serDLAB;\r
 151 \r
 152                         /* Setup the divisor. */\r
 153                         U1DLL = ( unsigned char ) ( ulDivisor & ( unsigned long ) 0xff );\r
 154                         ulDivisor >>= 8;\r
 155                         U1DLM = ( unsigned char ) ( ulDivisor & ( unsigned long ) 0xff );\r
 156 \r
 157                         /* Turn on the FIFO's and clear the buffers. */\r
 158                         U1FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 159 \r
 160                         /* Setup transmission format. */\r
 161                         U1LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 162 \r
 163                         /* Setup the VIC for the UART. */\r
 164                         VICIntSelect &= ~( serU1VIC_CHANNEL_BIT );\r
 165                         VICIntEnable |= serU1VIC_CHANNEL_BIT;\r
 166                         VICVectAddr1 = ( unsigned long ) vUART_ISREntry;\r
 167                         VICVectCntl1 = serU1VIC_CHANNEL | serU1VIC_ENABLE;\r
 168 \r
 169                         /* Enable UART0 interrupts. */\r
 170                         U1IER |= 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 char *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 char * const pcString, unsigned short usStringLength )\r
 202 {\r
 203 signed char *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 char * ) 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 char 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 == ( long ) pdTRUE )\r
 233                 {\r
 234                         /* We wrote the character directly to the UART, so was \r
 235                         successful. */\r
 236                         lTHREEmpty = pdFALSE;\r
 237                         U1THR = 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 == ( long ) pdTRUE )\r
 253                         {\r
 254                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 255                                 lTHREEmpty = pdFALSE;\r
 256                                 U1THR = 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 char cChar;\r
 269 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 270 unsigned char ucInterrupt;\r
 271 \r
 272         ucInterrupt = U1IIR;\r
 273 \r
 274         /* The interrupt pending bit is active low. */\r
 275         while( ( ucInterrupt & serINTERRUPT_IS_PENDING ) == 0 )\r
 276         {\r
 277                 /* What caused the interrupt? */\r
 278                 switch( ucInterrupt & serINTERRUPT_SOURCE_MASK )\r
 279                 {\r
 280                         case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 281                                                                         cChar = U1LSR;\r
 282                                                                         break;\r
 283         \r
 284                         case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 285                                                                         character in the Tx queue, send it now. */\r
 286                                                                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 287                                                                         {\r
 288                                                                                 U1THR = cChar;\r
 289                                                                         }\r
 290                                                                         else\r
 291                                                                         {\r
 292                                                                                 /* There are no further characters \r
 293                                                                                 queued to send so we can indicate \r
 294                                                                                 that the THRE is available. */\r
 295                                                                                 lTHREEmpty = pdTRUE;\r
 296                                                                         }\r
 297                                                                         break;\r
 298         \r
 299                         case serSOURCE_RX_TIMEOUT :\r
 300                         case serSOURCE_RX       :       /* A character was received.  Place it in \r
 301                                                                         the queue of received characters. */\r
 302                                                                         cChar = U1RBR;\r
 303                                                                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\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                 ucInterrupt = U1IIR;\r
 311         }\r
 312 \r
 313         /* Clear the ISR in the VIC. */\r
 314         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 315 \r
 316         /* Exit the ISR.  If a task was woken by either a character being received\r
 317         or transmitted then a context switch will occur. */\r
 318         portEXIT_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 319 }\r
 320 /*-----------------------------------------------------------*/\r
 321 \r
 322 \r
 323 \r
 324 \r
 325 \r
 326 \r
 327         \r