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

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