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

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