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

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