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

   1 /*\r
   2         FreeRTOS.org V4.5.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 for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 /*\r
  37         Changes from V2.4.0\r
  38 \r
  39                 + Made serial ISR handling more complete and robust.\r
  40 \r
  41         Changes from V2.4.1\r
  42 \r
  43                 + Split serial.c into serial.c and serialISR.c.  serial.c can be \r
  44                   compiled using ARM or THUMB modes.  serialISR.c must always be\r
  45                   compiled in ARM mode.\r
  46                 + Another small change to cSerialPutChar().\r
  47 \r
  48         Changed from V2.5.1\r
  49 \r
  50                 + In cSerialPutChar() an extra check is made to ensure the post to\r
  51                   the queue was successful if then attempting to retrieve the posted\r
  52                   character.\r
  53 \r
  54 */\r
  55 \r
  56 /* \r
  57         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  58 \r
  59         This file contains all the serial port components that can be compiled to\r
  60         either ARM or THUMB mode.  Components that must be compiled to ARM mode are\r
  61         contained in serialISR.c.\r
  62 */\r
  63 \r
  64 /* Standard includes. */\r
  65 #include <stdlib.h>\r
  66 \r
  67 /* Scheduler includes. */\r
  68 #include "FreeRTOS.h"\r
  69 #include "queue.h"\r
  70 #include "task.h"\r
  71 \r
  72 /* Demo application includes. */\r
  73 #include "serial.h"\r
  74 \r
  75 /*-----------------------------------------------------------*/\r
  76 \r
  77 /* Constants to setup and access the UART. */\r
  78 #define serDLAB                                                 ( ( unsigned portCHAR ) 0x80 )\r
  79 #define serENABLE_INTERRUPTS                    ( ( unsigned portCHAR ) 0x03 )\r
  80 #define serNO_PARITY                                    ( ( unsigned portCHAR ) 0x00 )\r
  81 #define ser1_STOP_BIT                                   ( ( unsigned portCHAR ) 0x00 )\r
  82 #define ser8_BIT_CHARS                                  ( ( unsigned portCHAR ) 0x03 )\r
  83 #define serFIFO_ON                                              ( ( unsigned portCHAR ) 0x01 )\r
  84 #define serCLEAR_FIFO                                   ( ( unsigned portCHAR ) 0x06 )\r
  85 #define serWANTED_CLOCK_SCALING                 ( ( unsigned portLONG ) 16 )\r
  86 \r
  87 /* Constants to setup and access the VIC. */\r
  88 #define serUART0_VIC_CHANNEL                    ( ( unsigned portLONG ) 0x0006 )\r
  89 #define serUART0_VIC_CHANNEL_BIT                ( ( unsigned portLONG ) 0x0040 )\r
  90 #define serUART0_VIC_ENABLE                             ( ( unsigned portLONG ) 0x0020 )\r
  91 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned portLONG ) 0 )\r
  92 \r
  93 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  94 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  95 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  96 \r
  97 /*-----------------------------------------------------------*/\r
  98 \r
  99 /* Queues used to hold received characters, and characters waiting to be\r
 100 transmitted. */\r
 101 static xQueueHandle xRxedChars; \r
 102 static xQueueHandle xCharsForTx; \r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* Communication flag between the interrupt service routine and serial API. */\r
 107 static volatile portLONG *plTHREEmpty;\r
 108 \r
 109 /* \r
 110  * The queues are created in serialISR.c as they are used from the ISR.\r
 111  * Obtain references to the queues and THRE Empty flag. \r
 112  */\r
 113 extern void vSerialISRCreateQueues(     unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxRxedChars, xQueueHandle *pxCharsForTx, portLONG volatile **pplTHREEmptyFlag );\r
 114 \r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 118 {\r
 119 unsigned portLONG ulDivisor, ulWantedClock;\r
 120 xComPortHandle xReturn = serHANDLE;\r
 121 extern void ( vUART_ISR )( void );\r
 122 \r
 123         /* The queues are used in the serial ISR routine, so are created from\r
 124         serialISR.c (which is always compiled to ARM mode. */\r
 125         vSerialISRCreateQueues( uxQueueLength, &xRxedChars, &xCharsForTx, &plTHREEmpty );\r
 126 \r
 127         if( \r
 128                 ( xRxedChars != serINVALID_QUEUE ) && \r
 129                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 130                 ( ulWantedBaud != ( unsigned portLONG ) 0 ) \r
 131           )\r
 132         {\r
 133                 portENTER_CRITICAL();\r
 134                 {\r
 135                         /* Setup the baud rate:  Calculate the divisor value. */\r
 136                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 137                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 138 \r
 139                         /* Set the DLAB bit so we can access the divisor. */\r
 140                         UART0_LCR |= serDLAB;\r
 141 \r
 142                         /* Setup the divisor. */\r
 143                         UART0_DLL = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 144                         ulDivisor >>= 8;\r
 145                         UART0_DLM = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 146 \r
 147                         /* Turn on the FIFO's and clear the buffers. */\r
 148                         UART0_FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 149 \r
 150                         /* Setup transmission format. */\r
 151                         UART0_LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 152 \r
 153                         /* Setup the VIC for the UART. */\r
 154                         VICIntSelect &= ~( serUART0_VIC_CHANNEL_BIT );\r
 155                         VICIntEnable |= serUART0_VIC_CHANNEL_BIT;\r
 156                         VICVectAddr1 = ( portLONG ) vUART_ISR;\r
 157                         VICVectCntl1 = serUART0_VIC_CHANNEL | serUART0_VIC_ENABLE;\r
 158 \r
 159                         /* Enable UART0 interrupts. */\r
 160                         UART0_IER |= serENABLE_INTERRUPTS;\r
 161                 }\r
 162                 portEXIT_CRITICAL();\r
 163         }\r
 164         else\r
 165         {\r
 166                 xReturn = ( xComPortHandle ) 0;\r
 167         }\r
 168 \r
 169         return xReturn;\r
 170 }\r
 171 /*-----------------------------------------------------------*/\r
 172 \r
 173 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 174 {\r
 175         /* The port handle is not required as this driver only supports UART0. */\r
 176         ( void ) pxPort;\r
 177 \r
 178         /* Get the next character from the buffer.  Return false if no characters\r
 179         are available, or arrive before xBlockTime expires. */\r
 180         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 181         {\r
 182                 return pdTRUE;\r
 183         }\r
 184         else\r
 185         {\r
 186                 return pdFALSE;\r
 187         }\r
 188 }\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 192 {\r
 193 signed portCHAR *pxNext;\r
 194 \r
 195         /* NOTE: This implementation does not handle the queue being full as no\r
 196         block time is used! */\r
 197 \r
 198         /* The port handle is not required as this driver only supports UART0. */\r
 199         ( void ) pxPort;\r
 200         ( void ) usStringLength;\r
 201 \r
 202         /* Send each character in the string, one at a time. */\r
 203         pxNext = ( signed portCHAR * ) pcString;\r
 204         while( *pxNext )\r
 205         {\r
 206                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 207                 pxNext++;\r
 208         }\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 213 {\r
 214 signed portBASE_TYPE xReturn;\r
 215 \r
 216         /* This demo driver only supports one port so the parameter is not used. */\r
 217         ( void ) pxPort;\r
 218 \r
 219         portENTER_CRITICAL();\r
 220         {\r
 221                 /* Is there space to write directly to the UART? */\r
 222                 if( *plTHREEmpty == ( portLONG ) pdTRUE )\r
 223                 {\r
 224                         /* We wrote the character directly to the UART, so was \r
 225                         successful. */\r
 226                         *plTHREEmpty = pdFALSE;\r
 227                         UART0_THR = cOutChar;\r
 228                         xReturn = pdPASS;\r
 229                 }\r
 230                 else \r
 231                 {\r
 232                         /* We cannot write directly to the UART, so queue the character.\r
 233                         Block for a maximum of xBlockTime if there is no space in the\r
 234                         queue. */\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( ( *plTHREEmpty == ( portLONG ) pdTRUE ) && ( xReturn == pdPASS ) )\r
 242                         {\r
 243                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 244                                 *plTHREEmpty = pdFALSE;\r
 245                                 UART0_THR = 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 void vSerialClose( xComPortHandle xPort )\r
 256 {\r
 257         /* Not supported as not required by the demo application. */\r
 258         ( void ) xPort;\r
 259 }\r
 260 /*-----------------------------------------------------------*/\r
 261 \r
 262 \r
 263 \r
 264 \r
 265 \r
 266         \r