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

   1 /*\r
   2         FreeRTOS.org V5.3.0 - Copyright (C) 2003-2009 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 it\r
   7         under the terms of the GNU General Public License (version 2) as published\r
   8         by the Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS.org without being obliged to provide\r
  11         the source code for any proprietary components.  Alternative commercial\r
  12         license and support terms are also available upon request.  See the \r
  13         licensing section of http://www.FreeRTOS.org for full details.\r
  14 \r
  15         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
  16         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  17         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  18         more details.\r
  19 \r
  20         You should have received a copy of the GNU General Public License along\r
  21         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59\r
  22         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  23 \r
  24 \r
  25         ***************************************************************************\r
  26         *                                                                         *\r
  27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  28         *                                                                         *\r
  29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  31         * explains numerous examples that are written using the FreeRTOS API.     *\r
  32         * Full source code for all the examples is provided in an accompanying    *\r
  33         * .zip file.                                                              *\r
  34         *                                                                         *\r
  35         ***************************************************************************\r
  36 \r
  37         1 tab == 4 spaces!\r
  38 \r
  39         Please ensure to read the configuration and relevant port sections of the\r
  40         online documentation.\r
  41 \r
  42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  43         contact details.\r
  44 \r
  45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  46         critical systems.\r
  47 \r
  48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  49         licensing and training services.\r
  50 */\r
  51 \r
  52 /*\r
  53         Changes from V2.4.0\r
  54 \r
  55                 + Made serial ISR handling more complete and robust.\r
  56 \r
  57         Changes from V2.4.1\r
  58 \r
  59                 + Split serial.c into serial.c and serialISR.c.  serial.c can be \r
  60                   compiled using ARM or THUMB modes.  serialISR.c must always be\r
  61                   compiled in ARM mode.\r
  62                 + Another small change to cSerialPutChar().\r
  63 \r
  64         Changed from V2.5.1\r
  65 \r
  66                 + In cSerialPutChar() an extra check is made to ensure the post to\r
  67                   the queue was successful if then attempting to retrieve the posted\r
  68                   character.\r
  69 \r
  70 */\r
  71 \r
  72 /* \r
  73         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  74 \r
  75         This file contains all the serial port components that can be compiled to\r
  76         either ARM or THUMB mode.  Components that must be compiled to ARM mode are\r
  77         contained in serialISR.c.\r
  78 */\r
  79 \r
  80 /* Standard includes. */\r
  81 #include <stdlib.h>\r
  82 \r
  83 /* Scheduler includes. */\r
  84 #include "FreeRTOS.h"\r
  85 #include "queue.h"\r
  86 #include "task.h"\r
  87 \r
  88 /* Demo application includes. */\r
  89 #include "serial.h"\r
  90 \r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 /* Constants to setup and access the UART. */\r
  94 #define serDLAB                                                 ( ( unsigned portCHAR ) 0x80 )\r
  95 #define serENABLE_INTERRUPTS                    ( ( unsigned portCHAR ) 0x03 )\r
  96 #define serNO_PARITY                                    ( ( unsigned portCHAR ) 0x00 )\r
  97 #define ser1_STOP_BIT                                   ( ( unsigned portCHAR ) 0x00 )\r
  98 #define ser8_BIT_CHARS                                  ( ( unsigned portCHAR ) 0x03 )\r
  99 #define serFIFO_ON                                              ( ( unsigned portCHAR ) 0x01 )\r
 100 #define serCLEAR_FIFO                                   ( ( unsigned portCHAR ) 0x06 )\r
 101 #define serWANTED_CLOCK_SCALING                 ( ( unsigned portLONG ) 16 )\r
 102 \r
 103 /* Constants to setup and access the VIC. */\r
 104 #define serUART0_VIC_CHANNEL                    ( ( unsigned portLONG ) 0x0006 )\r
 105 #define serUART0_VIC_CHANNEL_BIT                ( ( unsigned portLONG ) 0x0040 )\r
 106 #define serUART0_VIC_ENABLE                             ( ( unsigned portLONG ) 0x0020 )\r
 107 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned portLONG ) 0 )\r
 108 \r
 109 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
 110 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 111 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
 112 \r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 /* Queues used to hold received characters, and characters waiting to be\r
 116 transmitted. */\r
 117 static xQueueHandle xRxedChars; \r
 118 static xQueueHandle xCharsForTx; \r
 119 \r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 /* Communication flag between the interrupt service routine and serial API. */\r
 123 static volatile portLONG *plTHREEmpty;\r
 124 \r
 125 /* \r
 126  * The queues are created in serialISR.c as they are used from the ISR.\r
 127  * Obtain references to the queues and THRE Empty flag. \r
 128  */\r
 129 extern void vSerialISRCreateQueues(     unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxRxedChars, xQueueHandle *pxCharsForTx, portLONG volatile **pplTHREEmptyFlag );\r
 130 \r
 131 /*-----------------------------------------------------------*/\r
 132 \r
 133 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 134 {\r
 135 unsigned portLONG ulDivisor, ulWantedClock;\r
 136 xComPortHandle xReturn = serHANDLE;\r
 137 extern void ( vUART_ISR_Wrapper )( void );\r
 138 \r
 139         /* The queues are used in the serial ISR routine, so are created from\r
 140         serialISR.c (which is always compiled to ARM mode. */\r
 141         vSerialISRCreateQueues( uxQueueLength, &xRxedChars, &xCharsForTx, &plTHREEmpty );\r
 142 \r
 143         if( \r
 144                 ( xRxedChars != serINVALID_QUEUE ) && \r
 145                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 146                 ( ulWantedBaud != ( unsigned portLONG ) 0 ) \r
 147           )\r
 148         {\r
 149                 portENTER_CRITICAL();\r
 150                 {\r
 151                         /* Setup the baud rate:  Calculate the divisor value. */\r
 152                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 153                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 154 \r
 155                         /* Set the DLAB bit so we can access the divisor. */\r
 156                         UART0_LCR |= serDLAB;\r
 157 \r
 158                         /* Setup the divisor. */\r
 159                         UART0_DLL = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 160                         ulDivisor >>= 8;\r
 161                         UART0_DLM = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 162 \r
 163                         /* Turn on the FIFO's and clear the buffers. */\r
 164                         UART0_FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 165 \r
 166                         /* Setup transmission format. */\r
 167                         UART0_LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 168 \r
 169                         /* Setup the VIC for the UART. */\r
 170                         VICIntSelect &= ~( serUART0_VIC_CHANNEL_BIT );\r
 171                         VICIntEnable |= serUART0_VIC_CHANNEL_BIT;\r
 172                         VICVectAddr1 = ( portLONG ) vUART_ISR_Wrapper;\r
 173                         VICVectCntl1 = serUART0_VIC_CHANNEL | serUART0_VIC_ENABLE;\r
 174 \r
 175                         /* Enable UART0 interrupts. */\r
 176                         UART0_IER |= serENABLE_INTERRUPTS;\r
 177                 }\r
 178                 portEXIT_CRITICAL();\r
 179         }\r
 180         else\r
 181         {\r
 182                 xReturn = ( xComPortHandle ) 0;\r
 183         }\r
 184 \r
 185         return xReturn;\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 190 {\r
 191         /* The port handle is not required as this driver only supports UART0. */\r
 192         ( void ) pxPort;\r
 193 \r
 194         /* Get the next character from the buffer.  Return false if no characters\r
 195         are available, or arrive before xBlockTime expires. */\r
 196         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 197         {\r
 198                 return pdTRUE;\r
 199         }\r
 200         else\r
 201         {\r
 202                 return pdFALSE;\r
 203         }\r
 204 }\r
 205 /*-----------------------------------------------------------*/\r
 206 \r
 207 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 208 {\r
 209 signed portCHAR *pxNext;\r
 210 \r
 211         /* NOTE: This implementation does not handle the queue being full as no\r
 212         block time is used! */\r
 213 \r
 214         /* The port handle is not required as this driver only supports UART0. */\r
 215         ( void ) pxPort;\r
 216         ( void ) usStringLength;\r
 217 \r
 218         /* Send each character in the string, one at a time. */\r
 219         pxNext = ( signed portCHAR * ) pcString;\r
 220         while( *pxNext )\r
 221         {\r
 222                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 223                 pxNext++;\r
 224         }\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 229 {\r
 230 signed portBASE_TYPE xReturn;\r
 231 \r
 232         /* This demo driver only supports one port so the parameter is not used. */\r
 233         ( void ) pxPort;\r
 234 \r
 235         portENTER_CRITICAL();\r
 236         {\r
 237                 /* Is there space to write directly to the UART? */\r
 238                 if( *plTHREEmpty == ( portLONG ) pdTRUE )\r
 239                 {\r
 240                         /* We wrote the character directly to the UART, so was \r
 241                         successful. */\r
 242                         *plTHREEmpty = pdFALSE;\r
 243                         UART0_THR = cOutChar;\r
 244                         xReturn = pdPASS;\r
 245                 }\r
 246                 else \r
 247                 {\r
 248                         /* We cannot write directly to the UART, so queue the character.\r
 249                         Block for a maximum of xBlockTime if there is no space in the\r
 250                         queue. */\r
 251                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 252 \r
 253                         /* Depending on queue sizing and task prioritisation:  While we \r
 254                         were blocked waiting to post interrupts were not disabled.  It is \r
 255                         possible that the serial ISR has emptied the Tx queue, in which\r
 256                         case we need to start the Tx off again. */\r
 257                         if( ( *plTHREEmpty == ( portLONG ) pdTRUE ) && ( xReturn == pdPASS ) )\r
 258                         {\r
 259                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 260                                 *plTHREEmpty = pdFALSE;\r
 261                                 UART0_THR = cOutChar;\r
 262                         }\r
 263                 }\r
 264         }\r
 265         portEXIT_CRITICAL();\r
 266 \r
 267         return xReturn;\r
 268 }\r
 269 /*-----------------------------------------------------------*/\r
 270 \r
 271 void vSerialClose( xComPortHandle xPort )\r
 272 {\r
 273         /* Not supported as not required by the demo application. */\r
 274         ( void ) xPort;\r
 275 }\r
 276 /*-----------------------------------------------------------*/\r
 277 \r
 278 \r
 279 \r
 280 \r
 281 \r
 282         \r