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

   1 /*\r
   2     FreeRTOS V7.4.2 - 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 /* \r
  77         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  78 */\r
  79 \r
  80 /* Scheduler includes. */\r
  81 #include "FreeRTOS.h"\r
  82 #include "queue.h"\r
  83 #include "task.h"\r
  84 \r
  85 /* Demo application includes. */\r
  86 #include "serial.h"\r
  87 \r
  88 /* Library includes. */\r
  89 #include "xparameters.h"\r
  90 #include "xuartlite.h"\r
  91 #include "xuartlite_l.h"\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 xQueueHandle xRxedChars; \r
  98 static xQueueHandle xCharsForTx; \r
  99 \r
 100 /* Structure that maintains information on the UART being used. */\r
 101 static XUartLite xUART;\r
 102 \r
 103 /*\r
 104  * Sample UART interrupt handler.  Note this is used to demonstrate the kernel\r
 105  * features and test the port - it is not intended to represent an efficient\r
 106  * implementation.\r
 107  */\r
 108 static void vSerialISR( XUartLite *pxUART );\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 113 {\r
 114         /* NOTE: The baud rate used by this driver is determined by the hardware\r
 115         parameterization of the UART Lite peripheral, and the baud value passed to\r
 116         this function has no effect. */\r
 117         ( void ) ulWantedBaud;\r
 118 \r
 119         /* Create the queues used to hold Rx and Tx characters. */\r
 120         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 121         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 122 \r
 123         /* Only initialise the UART if the queues were created correctly. */\r
 124         if( ( xRxedChars != NULL ) && ( xCharsForTx != NULL ) )\r
 125         {\r
 126 \r
 127                 XUartLite_Initialize( &xUART, XPAR_RS232_UART_1_DEVICE_ID );\r
 128                 XUartLite_ResetFifos( &xUART );\r
 129                 XUartLite_DisableInterrupt( &xUART );\r
 130 \r
 131                 if( xPortInstallInterruptHandler( XPAR_XPS_INTC_0_RS232_UART_1_INTERRUPT_INTR, ( XInterruptHandler )vSerialISR, (void *)&xUART ) == pdPASS )\r
 132                 {\r
 133                         /* xPortInstallInterruptHandler() could fail if \r
 134                         vPortSetupInterruptController() has not been called prior to this \r
 135                         function. */\r
 136                         XUartLite_EnableInterrupt( &xUART );\r
 137                 }\r
 138         }\r
 139         \r
 140         /* There is only one port so the handle is not used. */\r
 141         return ( xComPortHandle ) 0;\r
 142 }\r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 146 {\r
 147         /* The port handle is not required as this driver only supports one UART. */\r
 148         ( void ) pxPort;\r
 149 \r
 150         /* Get the next character from the buffer.  Return false if no characters\r
 151         are available, or arrive before xBlockTime expires. */\r
 152         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 153         {\r
 154                 return pdTRUE;\r
 155         }\r
 156         else\r
 157         {\r
 158                 return pdFALSE;\r
 159         }\r
 160 }\r
 161 /*-----------------------------------------------------------*/\r
 162 \r
 163 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 164 {\r
 165 portBASE_TYPE xReturn = pdTRUE;\r
 166 \r
 167         /* Just to remove compiler warning. */\r
 168         ( void ) pxPort;\r
 169 \r
 170         portENTER_CRITICAL();\r
 171         {\r
 172                 /* If the UART FIFO is full we can block posting the new data on the\r
 173                 Tx queue. */\r
 174                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_1_BASEADDR ) )\r
 175                 {\r
 176                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 177                         {\r
 178                                 xReturn = pdFAIL;\r
 179                         }\r
 180                 }\r
 181                 /* Otherwise, if there is data already in the queue we should add the\r
 182                 new data to the back of the queue to ensure the sequencing is \r
 183                 maintained. */\r
 184                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 185                 {\r
 186                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 187                         {\r
 188                                 xReturn = pdFAIL;\r
 189                         }                       \r
 190                 }\r
 191                 /* If the UART FIFO is not full and there is no data already in the\r
 192                 queue we can write directly to the FIFO without disrupting the \r
 193                 sequence. */\r
 194                 else\r
 195                 {\r
 196                         XIo_Out32( XPAR_RS232_UART_1_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 197                 }\r
 198         }\r
 199         portEXIT_CRITICAL();\r
 200 \r
 201         return xReturn;\r
 202 }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 void vSerialClose( xComPortHandle xPort )\r
 206 {\r
 207         /* Not supported as not required by the demo application. */\r
 208         ( void ) xPort;\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 static void vSerialISR( XUartLite *pxUART )\r
 213 {\r
 214 unsigned long ulISRStatus;\r
 215 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE, lDidSomething;\r
 216 char cChar;\r
 217 \r
 218         /* Just to remove compiler warning. */\r
 219         ( void ) pxUART;\r
 220 \r
 221         do\r
 222         {\r
 223                 lDidSomething = pdFALSE;\r
 224 \r
 225                 ulISRStatus = XIo_In32( XPAR_RS232_UART_1_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 226 \r
 227                 if( ( ulISRStatus & XUL_SR_RX_FIFO_VALID_DATA ) != 0 )\r
 228                 {\r
 229                         /* A character is available - place it in the queue of received\r
 230                         characters.  This might wake a task that was blocked waiting for \r
 231                         data. */\r
 232                         cChar = ( char ) XIo_In32( XPAR_RS232_UART_1_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 233                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 234                         lDidSomething = pdTRUE;\r
 235                 }\r
 236                 \r
 237                 if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 238                 {\r
 239                         /* There is space in the FIFO - if there are any characters queue for\r
 240                         transmission they can be sent to the UART now.  This might unblock a\r
 241                         task that was waiting for space to become available on the Tx queue. */\r
 242                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 243                         {\r
 244                                 XIo_Out32( XPAR_RS232_UART_1_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 245                                 lDidSomething = pdTRUE;\r
 246                         }                       \r
 247                 }\r
 248         } while( lDidSomething == pdTRUE );\r
 249 \r
 250         /* If we woke any tasks we may require a context switch. */\r
 251         if( xHigherPriorityTaskWoken )\r
 252         {\r
 253                 portYIELD_FROM_ISR();\r
 254         }\r
 255 }\r
 256 \r
 257 \r
 258 \r