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

   1 /*\r
   2     FreeRTOS V7.4.1 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76         Changes from V2.4.0\r
  77 \r
  78                 + Made serial ISR handling more complete and robust.\r
  79 \r
  80         Changes from V2.4.1\r
  81 \r
  82                 + Split serial.c into serial.c and serialISR.c.  serial.c can be \r
  83                   compiled using ARM or THUMB modes.  serialISR.c must always be\r
  84                   compiled in ARM mode.\r
  85                 + Another small change to cSerialPutChar().\r
  86 \r
  87         Changed from V2.5.1\r
  88 \r
  89                 + In cSerialPutChar() an extra check is made to ensure the post to\r
  90                   the queue was successful if then attempting to retrieve the posted\r
  91                   character.\r
  92 \r
  93 */\r
  94 \r
  95 /* \r
  96         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  97 \r
  98         This file contains all the serial port components that can be compiled to\r
  99         either ARM or THUMB mode.  Components that must be compiled to ARM mode are\r
 100         contained in serialISR.c.\r
 101 */\r
 102 \r
 103 /* Standard includes. */\r
 104 #include <stdlib.h>\r
 105 \r
 106 /* Scheduler includes. */\r
 107 #include "FreeRTOS.h"\r
 108 #include "queue.h"\r
 109 #include "task.h"\r
 110 \r
 111 /* Demo application includes. */\r
 112 #include "serial.h"\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /* Constants to setup and access the UART. */\r
 117 #define serDLAB                                                 ( ( unsigned char ) 0x80 )\r
 118 #define serENABLE_INTERRUPTS                    ( ( unsigned char ) 0x03 )\r
 119 #define serNO_PARITY                                    ( ( unsigned char ) 0x00 )\r
 120 #define ser1_STOP_BIT                                   ( ( unsigned char ) 0x00 )\r
 121 #define ser8_BIT_CHARS                                  ( ( unsigned char ) 0x03 )\r
 122 #define serFIFO_ON                                              ( ( unsigned char ) 0x01 )\r
 123 #define serCLEAR_FIFO                                   ( ( unsigned char ) 0x06 )\r
 124 #define serWANTED_CLOCK_SCALING                 ( ( unsigned long ) 16 )\r
 125 \r
 126 /* Constants to setup and access the VIC. */\r
 127 #define serUART0_VIC_CHANNEL                    ( ( unsigned long ) 0x0006 )\r
 128 #define serUART0_VIC_CHANNEL_BIT                ( ( unsigned long ) 0x0040 )\r
 129 #define serUART0_VIC_ENABLE                             ( ( unsigned long ) 0x0020 )\r
 130 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned long ) 0 )\r
 131 \r
 132 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
 133 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 134 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
 135 \r
 136 /*-----------------------------------------------------------*/\r
 137 \r
 138 /* Queues used to hold received characters, and characters waiting to be\r
 139 transmitted. */\r
 140 static xQueueHandle xRxedChars; \r
 141 static xQueueHandle xCharsForTx; \r
 142 \r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 /* Communication flag between the interrupt service routine and serial API. */\r
 146 static volatile long *plTHREEmpty;\r
 147 \r
 148 /* \r
 149  * The queues are created in serialISR.c as they are used from the ISR.\r
 150  * Obtain references to the queues and THRE Empty flag. \r
 151  */\r
 152 extern void vSerialISRCreateQueues(     unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxRxedChars, xQueueHandle *pxCharsForTx, long volatile **pplTHREEmptyFlag );\r
 153 \r
 154 /*-----------------------------------------------------------*/\r
 155 \r
 156 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 157 {\r
 158 unsigned long ulDivisor, ulWantedClock;\r
 159 xComPortHandle xReturn = serHANDLE;\r
 160 extern void ( vUART_ISR_Wrapper )( void );\r
 161 \r
 162         /* The queues are used in the serial ISR routine, so are created from\r
 163         serialISR.c (which is always compiled to ARM mode. */\r
 164         vSerialISRCreateQueues( uxQueueLength, &xRxedChars, &xCharsForTx, &plTHREEmpty );\r
 165 \r
 166         if( \r
 167                 ( xRxedChars != serINVALID_QUEUE ) && \r
 168                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 169                 ( ulWantedBaud != ( unsigned long ) 0 ) \r
 170           )\r
 171         {\r
 172                 portENTER_CRITICAL();\r
 173                 {\r
 174                         /* Setup the baud rate:  Calculate the divisor value. */\r
 175                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 176                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 177 \r
 178                         /* Set the DLAB bit so we can access the divisor. */\r
 179                         UART0_LCR |= serDLAB;\r
 180 \r
 181                         /* Setup the divisor. */\r
 182                         UART0_DLL = ( unsigned char ) ( ulDivisor & ( unsigned long ) 0xff );\r
 183                         ulDivisor >>= 8;\r
 184                         UART0_DLM = ( unsigned char ) ( ulDivisor & ( unsigned long ) 0xff );\r
 185 \r
 186                         /* Turn on the FIFO's and clear the buffers. */\r
 187                         UART0_FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 188 \r
 189                         /* Setup transmission format. */\r
 190                         UART0_LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 191 \r
 192                         /* Setup the VIC for the UART. */\r
 193                         VICIntSelect &= ~( serUART0_VIC_CHANNEL_BIT );\r
 194                         VICIntEnable |= serUART0_VIC_CHANNEL_BIT;\r
 195                         VICVectAddr1 = ( long ) vUART_ISR_Wrapper;\r
 196                         VICVectCntl1 = serUART0_VIC_CHANNEL | serUART0_VIC_ENABLE;\r
 197 \r
 198                         /* Enable UART0 interrupts. */\r
 199                         UART0_IER |= serENABLE_INTERRUPTS;\r
 200                 }\r
 201                 portEXIT_CRITICAL();\r
 202         }\r
 203         else\r
 204         {\r
 205                 xReturn = ( xComPortHandle ) 0;\r
 206         }\r
 207 \r
 208         return xReturn;\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 213 {\r
 214         /* The port handle is not required as this driver only supports UART0. */\r
 215         ( void ) pxPort;\r
 216 \r
 217         /* Get the next character from the buffer.  Return false if no characters\r
 218         are available, or arrive before xBlockTime expires. */\r
 219         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 220         {\r
 221                 return pdTRUE;\r
 222         }\r
 223         else\r
 224         {\r
 225                 return pdFALSE;\r
 226         }\r
 227 }\r
 228 /*-----------------------------------------------------------*/\r
 229 \r
 230 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 231 {\r
 232 signed char *pxNext;\r
 233 \r
 234         /* NOTE: This implementation does not handle the queue being full as no\r
 235         block time is used! */\r
 236 \r
 237         /* The port handle is not required as this driver only supports UART0. */\r
 238         ( void ) pxPort;\r
 239         ( void ) usStringLength;\r
 240 \r
 241         /* Send each character in the string, one at a time. */\r
 242         pxNext = ( signed char * ) pcString;\r
 243         while( *pxNext )\r
 244         {\r
 245                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 246                 pxNext++;\r
 247         }\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 252 {\r
 253 signed portBASE_TYPE xReturn;\r
 254 \r
 255         /* This demo driver only supports one port so the parameter is not used. */\r
 256         ( void ) pxPort;\r
 257 \r
 258         portENTER_CRITICAL();\r
 259         {\r
 260                 /* Is there space to write directly to the UART? */\r
 261                 if( *plTHREEmpty == ( long ) pdTRUE )\r
 262                 {\r
 263                         /* We wrote the character directly to the UART, so was \r
 264                         successful. */\r
 265                         *plTHREEmpty = pdFALSE;\r
 266                         UART0_THR = cOutChar;\r
 267                         xReturn = pdPASS;\r
 268                 }\r
 269                 else \r
 270                 {\r
 271                         /* We cannot write directly to the UART, so queue the character.\r
 272                         Block for a maximum of xBlockTime if there is no space in the\r
 273                         queue. */\r
 274                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 275 \r
 276                         /* Depending on queue sizing and task prioritisation:  While we \r
 277                         were blocked waiting to post interrupts were not disabled.  It is \r
 278                         possible that the serial ISR has emptied the Tx queue, in which\r
 279                         case we need to start the Tx off again. */\r
 280                         if( ( *plTHREEmpty == ( long ) pdTRUE ) && ( xReturn == pdPASS ) )\r
 281                         {\r
 282                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 283                                 *plTHREEmpty = pdFALSE;\r
 284                                 UART0_THR = cOutChar;\r
 285                         }\r
 286                 }\r
 287         }\r
 288         portEXIT_CRITICAL();\r
 289 \r
 290         return xReturn;\r
 291 }\r
 292 /*-----------------------------------------------------------*/\r
 293 \r
 294 void vSerialClose( xComPortHandle xPort )\r
 295 {\r
 296         /* Not supported as not required by the demo application. */\r
 297         ( void ) xPort;\r
 298 }\r
 299 /*-----------------------------------------------------------*/\r
 300 \r
 301 \r
 302 \r
 303 \r
 304 \r
 305         \r