git.sur5r.net Git - freertos/blob - Demo/ARM7_LPC2129_IAR/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 /*\r
  55         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  56 */\r
  57 \r
  58 /* Standard includes. */\r
  59 #include <stdlib.h>\r
  60 \r
  61 /* Scheduler includes. */\r
  62 #include "FreeRTOS.h"\r
  63 #include "queue.h"\r
  64 #include "task.h"\r
  65 \r
  66 /* Demo application includes. */\r
  67 #include "serial.h"\r
  68 \r
  69 /*-----------------------------------------------------------*/\r
  70 \r
  71 /* Constants to setup and access the UART. */\r
  72 #define serDLAB                                                 ( ( unsigned portCHAR ) 0x80 )\r
  73 #define serENABLE_INTERRUPTS                    ( ( unsigned portCHAR ) 0x03 )\r
  74 #define serNO_PARITY                                    ( ( unsigned portCHAR ) 0x00 )\r
  75 #define ser1_STOP_BIT                                   ( ( unsigned portCHAR ) 0x00 )\r
  76 #define ser8_BIT_CHARS                                  ( ( unsigned portCHAR ) 0x03 )\r
  77 #define serFIFO_ON                                              ( ( unsigned portCHAR ) 0x01 )\r
  78 #define serCLEAR_FIFO                                   ( ( unsigned portCHAR ) 0x06 )\r
  79 #define serWANTED_CLOCK_SCALING                 ( ( unsigned portLONG ) 16 )\r
  80 \r
  81 /* Constants to setup and access the VIC. */\r
  82 #define serU0VIC_CHANNEL                                ( ( unsigned portLONG ) 0x0006 )\r
  83 #define serU0VIC_CHANNEL_BIT                    ( ( unsigned portLONG ) 0x0040 )\r
  84 #define serU0VIC_ENABLE                                 ( ( unsigned portLONG ) 0x0020 )\r
  85 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned portLONG ) 0 )\r
  86 \r
  87 /* Constants to determine the ISR source. */\r
  88 #define serSOURCE_THRE                                  ( ( unsigned portCHAR ) 0x02 )\r
  89 #define serSOURCE_RX_TIMEOUT                    ( ( unsigned portCHAR ) 0x0c )\r
  90 #define serSOURCE_ERROR                                 ( ( unsigned portCHAR ) 0x06 )\r
  91 #define serSOURCE_RX                                    ( ( unsigned portCHAR ) 0x04 )\r
  92 #define serINTERRUPT_SOURCE_MASK                ( ( unsigned portCHAR ) 0x0f )\r
  93 \r
  94 /* Misc. */\r
  95 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  96 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  97 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  98 \r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 /* Queues used to hold received characters, and characters waiting to be\r
 102 transmitted. */\r
 103 static xQueueHandle xRxedChars;\r
 104 static xQueueHandle xCharsForTx;\r
 105 static volatile portLONG lTHREEmpty = pdFALSE;\r
 106 \r
 107 /*-----------------------------------------------------------*/\r
 108 \r
 109 /* The ISR.  Note that this is called by a wrapper written in the file\r
 110 SerialISR.s79.  See the WEB documentation for this port for further\r
 111 information. */\r
 112 __arm void vSerialISR( void );\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 117 {\r
 118 unsigned portLONG ulDivisor, ulWantedClock;\r
 119 xComPortHandle xReturn = serHANDLE;\r
 120 extern void ( vSerialISREntry) ( void );\r
 121 \r
 122         /* Create the queues used to hold Rx and Tx characters. */\r
 123         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 124         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 125 \r
 126         /* Initialise the THRE empty flag. */\r
 127         lTHREEmpty = pdTRUE;\r
 128 \r
 129         if(\r
 130                 ( xRxedChars != serINVALID_QUEUE ) &&\r
 131                 ( xCharsForTx != serINVALID_QUEUE ) &&\r
 132                 ( ulWantedBaud != ( unsigned portLONG ) 0 )\r
 133           )\r
 134         {\r
 135                 portENTER_CRITICAL();\r
 136                 {\r
 137                         /* Setup the baud rate:  Calculate the divisor value. */\r
 138                         ulWantedClock = ulWantedBaud * serWANTED_CLOCK_SCALING;\r
 139                         ulDivisor = configCPU_CLOCK_HZ / ulWantedClock;\r
 140 \r
 141                         /* Set the DLAB bit so we can access the divisor. */\r
 142                         U0LCR |= serDLAB;\r
 143 \r
 144                         /* Setup the divisor. */\r
 145                         U0DLL = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 146                         ulDivisor >>= 8;\r
 147                         U0DLM = ( unsigned portCHAR ) ( ulDivisor & ( unsigned portLONG ) 0xff );\r
 148 \r
 149                         /* Turn on the FIFO's and clear the buffers. */\r
 150                         U0FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 151 \r
 152                         /* Setup transmission format. */\r
 153                         U0LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 154 \r
 155                         /* Setup the VIC for the UART. */\r
 156                         VICIntSelect &= ~( serU0VIC_CHANNEL_BIT );\r
 157                         VICIntEnable |= serU0VIC_CHANNEL_BIT;\r
 158                         VICVectAddr1 = ( unsigned portLONG ) vSerialISREntry;\r
 159                         VICVectCntl1 = serU0VIC_CHANNEL | serU0VIC_ENABLE;\r
 160 \r
 161                         /* Enable UART0 interrupts. */\r
 162                         U0IER |= serENABLE_INTERRUPTS;\r
 163                 }\r
 164                 portEXIT_CRITICAL();\r
 165 \r
 166                 xReturn = ( xComPortHandle ) 1;\r
 167         }\r
 168         else\r
 169         {\r
 170                 xReturn = ( xComPortHandle ) 0;\r
 171         }\r
 172 \r
 173         return xReturn;\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 178 {\r
 179         /* The port handle is not required as this driver only supports UART0. */\r
 180         ( void ) pxPort;\r
 181 \r
 182         /* Get the next character from the buffer.  Return false if no characters\r
 183         are available, or arrive before xBlockTime expires. */\r
 184         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 185         {\r
 186                 return pdTRUE;\r
 187         }\r
 188         else\r
 189         {\r
 190                 return pdFALSE;\r
 191         }\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 196 {\r
 197 signed portCHAR *pxNext;\r
 198 \r
 199         /* NOTE: This implementation does not handle the queue being full as no\r
 200         block time is used! */\r
 201 \r
 202         /* The port handle is not required as this driver only supports UART0. */\r
 203         ( void ) pxPort;\r
 204         ( void ) usStringLength;\r
 205 \r
 206         /* Send each character in the string, one at a time. */\r
 207         pxNext = ( signed portCHAR * ) pcString;\r
 208         while( *pxNext )\r
 209         {\r
 210                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 211                 pxNext++;\r
 212         }\r
 213 }\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 217 {\r
 218 signed portBASE_TYPE xReturn;\r
 219 \r
 220         /* The port handle is not required as this driver only supports UART0. */\r
 221         ( void ) pxPort;\r
 222 \r
 223         portENTER_CRITICAL();\r
 224         {\r
 225                 /* Is there space to write directly to the UART? */\r
 226                 if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 227                 {\r
 228                         /* We wrote the character directly to the UART, so was\r
 229                         successful. */\r
 230                         lTHREEmpty = pdFALSE;\r
 231                         U0THR = cOutChar;\r
 232                         xReturn = pdPASS;\r
 233                 }\r
 234                 else\r
 235                 {\r
 236                         /* We cannot write directly to the UART, so queue the character.\r
 237                         Block for a maximum of xBlockTime if there is no space in the\r
 238                         queue.  It is ok to block within a critical section as each\r
 239                         task has it's own critical section management. */\r
 240                         xReturn = xQueueSend( xCharsForTx, &cOutChar, xBlockTime );\r
 241 \r
 242                         /* Depending on queue sizing and task prioritisation:  While we\r
 243                         were blocked waiting to post interrupts were not disabled.  It is\r
 244                         possible that the serial ISR has emptied the Tx queue, in which\r
 245                         case we need to start the Tx off again. */\r
 246                         if( lTHREEmpty == ( portLONG ) pdTRUE )\r
 247                         {\r
 248                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 249                                 lTHREEmpty = pdFALSE;\r
 250                                 U0THR = cOutChar;\r
 251                         }\r
 252                 }\r
 253         }\r
 254         portEXIT_CRITICAL();\r
 255 \r
 256         return xReturn;\r
 257 }\r
 258 /*-----------------------------------------------------------*/\r
 259 \r
 260 __arm void vSerialISR( void )\r
 261 {\r
 262 signed portCHAR cChar;\r
 263 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 264 \r
 265         /* What caused the interrupt? */\r
 266         switch( U0IIR & serINTERRUPT_SOURCE_MASK )\r
 267         {\r
 268                 case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 269                                                                 cChar = U0LSR;\r
 270                                                                 break;\r
 271 \r
 272                 case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 273                                                                 character in the Tx queue, send it now. */\r
 274                                                                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 275                                                                 {\r
 276                                                                         U0THR = cChar;\r
 277                                                                 }\r
 278                                                                 else\r
 279                                                                 {\r
 280                                                                         /* There are no further characters\r
 281                                                                         queued to send so we can indicate\r
 282                                                                         that the THRE is available. */\r
 283                                                                         lTHREEmpty = pdTRUE;\r
 284                                                                 }\r
 285                                                                 break;\r
 286 \r
 287                 case serSOURCE_RX_TIMEOUT :\r
 288                 case serSOURCE_RX       :       /* A character was received.  Place it in\r
 289                                                                 the queue of received characters. */\r
 290                                                                 cChar = U0RBR;\r
 291                                                                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 292                                                                 break;\r
 293 \r
 294                 default                         :       /* There is nothing to do, leave the ISR. */\r
 295                                                                 break;\r
 296         }\r
 297 \r
 298         /* Exit the ISR.  If a task was woken by either a character being received\r
 299         or transmitted then a context switch will occur. */\r
 300         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 301 \r
 302         /* Clear the ISR in the VIC. */\r
 303         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 304 }\r
 305 /*-----------------------------------------------------------*/\r