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

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