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

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