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

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