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

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