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

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