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

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