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

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 \r
  30 /* \r
  31         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  32 \r
  33         Note this driver is used to test the FreeRTOS port.  It is NOT intended to\r
  34         be an example of an efficient implementation!\r
  35 */\r
  36 \r
  37 /* Standard includes. */\r
  38 #include <stdlib.h>\r
  39 \r
  40 /* Scheduler includes. */\r
  41 #include "FreeRTOS.h"\r
  42 #include "queue.h"\r
  43 #include "task.h"\r
  44 \r
  45 /* Demo application includes. */\r
  46 #include "serial.h"\r
  47 \r
  48 /*-----------------------------------------------------------*/\r
  49 \r
  50 /* Constants to setup and access the UART. */\r
  51 #define serDLAB                                                 ( ( unsigned char ) 0x80 )\r
  52 #define serENABLE_INTERRUPTS                    ( ( unsigned char ) 0x03 )\r
  53 #define serNO_PARITY                                    ( ( unsigned char ) 0x00 )\r
  54 #define ser1_STOP_BIT                                   ( ( unsigned char ) 0x00 )\r
  55 #define ser8_BIT_CHARS                                  ( ( unsigned char ) 0x03 )\r
  56 #define serFIFO_ON                                              ( ( unsigned char ) 0x01 )\r
  57 #define serCLEAR_FIFO                                   ( ( unsigned char ) 0x06 )\r
  58 #define serWANTED_CLOCK_SCALING                 ( ( unsigned long ) 16 )\r
  59 \r
  60 /* Constants to setup and access the VIC. */\r
  61 #define serU1VIC_CHANNEL                                ( ( unsigned long ) 0x0007 )\r
  62 #define serU1VIC_CHANNEL_BIT                    ( ( unsigned long ) 0x0080 )\r
  63 #define serU1VIC_ENABLE                                 ( ( unsigned long ) 0x0020 )\r
  64 \r
  65 /* Misc. */\r
  66 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  67 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  68 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  69 \r
  70 /* Constant to access the VIC. */\r
  71 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned long ) 0 )\r
  72 \r
  73 /* Constants to determine the ISR source. */\r
  74 #define serSOURCE_THRE                                  ( ( unsigned char ) 0x02 )\r
  75 #define serSOURCE_RX_TIMEOUT                    ( ( unsigned char ) 0x0c )\r
  76 #define serSOURCE_ERROR                                 ( ( unsigned char ) 0x06 )\r
  77 #define serSOURCE_RX                                    ( ( unsigned char ) 0x04 )\r
  78 #define serINTERRUPT_SOURCE_MASK                ( ( unsigned char ) 0x0f )\r
  79 #define serINTERRUPT_IS_PENDING                 ( ( unsigned char ) 0x01 )\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /*\r
  84  * The asm wrapper for the interrupt service routine.\r
  85  */\r
  86 extern void vUART_ISREntry( void );\r
  87 \r
  88 /* \r
  89  * The C function called from the asm wrapper. \r
  90  */\r
  91 void vUART_ISRHandler( void );\r
  92 \r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95 /* Queues used to hold received characters, and characters waiting to be\r
  96 transmitted. */\r
  97 static QueueHandle_t xRxedChars; \r
  98 static QueueHandle_t xCharsForTx; \r
  99 \r
 100 /* Communication flag between the interrupt service routine and serial API. */\r
 101 static volatile long lTHREEmpty;\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 106 {\r
 107 unsigned long ulDivisor, ulWantedClock;\r
 108 xComPortHandle xReturn = serHANDLE;\r
 109 \r
 110         /* Create the queues used to hold Rx and Tx characters. */\r
 111         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 112         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 113 \r
 114         /* Initialise the THRE empty flag. */\r
 115         lTHREEmpty = pdTRUE;\r
 116 \r
 117         if( \r
 118                 ( xRxedChars != serINVALID_QUEUE ) && \r
 119                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 120                 ( ulWantedBaud != ( unsigned long ) 0 ) \r
 121           )\r
 122         {\r
 123                 portENTER_CRITICAL()\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                         U1LCR |= serDLAB;\r
 131 \r
 132                         /* Setup the divisor. */\r
 133                         U1DLL = ( unsigned char ) ( ulDivisor & ( unsigned long ) 0xff );\r
 134                         ulDivisor >>= 8;\r
 135                         U1DLM = ( unsigned char ) ( ulDivisor & ( unsigned long ) 0xff );\r
 136 \r
 137                         /* Turn on the FIFO's and clear the buffers. */\r
 138                         U1FCR = ( serFIFO_ON | serCLEAR_FIFO );\r
 139 \r
 140                         /* Setup transmission format. */\r
 141                         U1LCR = serNO_PARITY | ser1_STOP_BIT | ser8_BIT_CHARS;\r
 142 \r
 143                         /* Setup the VIC for the UART. */\r
 144                         VICIntSelect &= ~( serU1VIC_CHANNEL_BIT );\r
 145                         VICIntEnable |= serU1VIC_CHANNEL_BIT;\r
 146                         VICVectAddr1 = ( unsigned long ) vUART_ISREntry;\r
 147                         VICVectCntl1 = serU1VIC_CHANNEL | serU1VIC_ENABLE;\r
 148 \r
 149                         /* Enable UART0 interrupts. */\r
 150                         U1IER |= 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 char *pcRxedChar, TickType_t 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 char * const pcString, unsigned short usStringLength )\r
 182 {\r
 183 signed char *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 char * ) 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 char cOutChar, TickType_t 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( lTHREEmpty == ( long ) pdTRUE )\r
 213                 {\r
 214                         /* We wrote the character directly to the UART, so was \r
 215                         successful. */\r
 216                         lTHREEmpty = pdFALSE;\r
 217                         U1THR = 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( lTHREEmpty == ( long ) pdTRUE )\r
 233                         {\r
 234                                 xQueueReceive( xCharsForTx, &cOutChar, serNO_BLOCK );\r
 235                                 lTHREEmpty = pdFALSE;\r
 236                                 U1THR = 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 void vUART_ISRHandler( void )\r
 247 {\r
 248 signed char cChar;\r
 249 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 250 unsigned char ucInterrupt;\r
 251 \r
 252         ucInterrupt = U1IIR;\r
 253 \r
 254         /* The interrupt pending bit is active low. */\r
 255         while( ( ucInterrupt & serINTERRUPT_IS_PENDING ) == 0 )\r
 256         {\r
 257                 /* What caused the interrupt? */\r
 258                 switch( ucInterrupt & serINTERRUPT_SOURCE_MASK )\r
 259                 {\r
 260                         case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 261                                                                         cChar = U1LSR;\r
 262                                                                         break;\r
 263         \r
 264                         case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 265                                                                         character in the Tx queue, send it now. */\r
 266                                                                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 267                                                                         {\r
 268                                                                                 U1THR = cChar;\r
 269                                                                         }\r
 270                                                                         else\r
 271                                                                         {\r
 272                                                                                 /* There are no further characters \r
 273                                                                                 queued to send so we can indicate \r
 274                                                                                 that the THRE is available. */\r
 275                                                                                 lTHREEmpty = pdTRUE;\r
 276                                                                         }\r
 277                                                                         break;\r
 278         \r
 279                         case serSOURCE_RX_TIMEOUT :\r
 280                         case serSOURCE_RX       :       /* A character was received.  Place it in \r
 281                                                                         the queue of received characters. */\r
 282                                                                         cChar = U1RBR;\r
 283                                                                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 284                                                                         break;\r
 285         \r
 286                         default                         :       /* There is nothing to do, leave the ISR. */\r
 287                                                                         break;\r
 288                 }\r
 289 \r
 290                 ucInterrupt = U1IIR;\r
 291         }\r
 292 \r
 293         /* Clear the ISR in the VIC. */\r
 294         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 295 \r
 296         /* Exit the ISR.  If a task was woken by either a character being received\r
 297         or transmitted then a context switch will occur. */\r
 298         portEXIT_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 299 }\r
 300 /*-----------------------------------------------------------*/\r
 301 \r
 302 \r
 303 \r
 304 \r
 305 \r
 306 \r
 307         \r