begriffs open source - freertos/blob - Demo/PPC405_FPU_Xilinx_Virtex4_GCC/RTOSDemo/serial/serial.c

   1 /*\r
   2         FreeRTOS V5.4.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 \r
  49 /* \r
  50         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  51 */\r
  52 \r
  53 /* Scheduler includes. */\r
  54 #include "FreeRTOS.h"\r
  55 #include "queue.h"\r
  56 #include "task.h"\r
  57 \r
  58 /* Demo application includes. */\r
  59 #include "serial.h"\r
  60 \r
  61 /* Library includes. */\r
  62 #include "xparameters.h"\r
  63 #include "xuartlite.h"\r
  64 #include "xuartlite_l.h"\r
  65 \r
  66 /*-----------------------------------------------------------*/\r
  67 \r
  68 /* Queues used to hold received characters, and characters waiting to be\r
  69 transmitted. */\r
  70 static xQueueHandle xRxedChars; \r
  71 static xQueueHandle xCharsForTx; \r
  72 \r
  73 /* Structure that maintains information on the UART being used. */\r
  74 static XUartLite xUART;\r
  75 \r
  76 /*\r
  77  * Sample UART interrupt handler.  Note this is used to demonstrate the kernel\r
  78  * features and test the port - it is not intended to represent an efficient\r
  79  * implementation.\r
  80  */\r
  81 static void vSerialISR( XUartLite *pxUART );\r
  82 \r
  83 /*-----------------------------------------------------------*/\r
  84 \r
  85 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  86 {\r
  87         /* NOTE: The baud rate used by this driver is determined by the hardware\r
  88         parameterization of the UART Lite peripheral, and the baud value passed to\r
  89         this function has no effect. */\r
  90         ( void ) ulWantedBaud;\r
  91 \r
  92         /* Create the queues used to hold Rx and Tx characters. */\r
  93         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  94         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  95 \r
  96         /* Only initialise the UART if the queues were created correctly. */\r
  97         if( ( xRxedChars != NULL ) && ( xCharsForTx != NULL ) )\r
  98         {\r
  99 \r
 100                 XUartLite_Initialize( &xUART, XPAR_RS232_UART_DEVICE_ID );\r
 101                 XUartLite_ResetFifos( &xUART );\r
 102                 XUartLite_DisableInterrupt( &xUART );\r
 103 \r
 104                 if( xPortInstallInterruptHandler( XPAR_XPS_INTC_0_RS232_UART_INTERRUPT_INTR, ( XInterruptHandler )vSerialISR, (void *)&xUART ) == pdPASS )\r
 105                 {\r
 106                         /* xPortInstallInterruptHandler() could fail if \r
 107                         vPortSetupInterruptController() has not been called prior to this \r
 108                         function. */\r
 109                         XUartLite_EnableInterrupt( &xUART );\r
 110                 }\r
 111         }\r
 112         \r
 113         /* There is only one port so the handle is not used. */\r
 114         return ( xComPortHandle ) 0;\r
 115 }\r
 116 /*-----------------------------------------------------------*/\r
 117 \r
 118 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 119 {\r
 120         /* The port handle is not required as this driver only supports one UART. */\r
 121         ( void ) pxPort;\r
 122 \r
 123         /* Get the next character from the buffer.  Return false if no characters\r
 124         are available, or arrive before xBlockTime expires. */\r
 125         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 126         {\r
 127                 return pdTRUE;\r
 128         }\r
 129         else\r
 130         {\r
 131                 return pdFALSE;\r
 132         }\r
 133 }\r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 137 {\r
 138 portBASE_TYPE xReturn = pdTRUE;\r
 139 \r
 140         /* Just to remove compiler warning. */\r
 141         ( void ) pxPort;\r
 142 \r
 143         portENTER_CRITICAL();\r
 144         {\r
 145                 /* If the UART FIFO is full we can block posting the new data on the\r
 146                 Tx queue. */\r
 147                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_BASEADDR ) )\r
 148                 {\r
 149                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 150                         {\r
 151                                 xReturn = pdFAIL;\r
 152                         }\r
 153                 }\r
 154                 /* Otherwise, if there is data already in the queue we should add the\r
 155                 new data to the back of the queue to ensure the sequencing is \r
 156                 maintained. */\r
 157                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 158                 {\r
 159                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 160                         {\r
 161                                 xReturn = pdFAIL;\r
 162                         }                       \r
 163                 }\r
 164                 /* If the UART FIFO is not full and there is no data already in the\r
 165                 queue we can write directly to the FIFO without disrupting the \r
 166                 sequence. */\r
 167                 else\r
 168                 {\r
 169                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 170                 }\r
 171         }\r
 172         portEXIT_CRITICAL();\r
 173 \r
 174         return xReturn;\r
 175 }\r
 176 /*-----------------------------------------------------------*/\r
 177 \r
 178 void vSerialClose( xComPortHandle xPort )\r
 179 {\r
 180         /* Not supported as not required by the demo application. */\r
 181         ( void ) xPort;\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 static void vSerialISR( XUartLite *pxUART )\r
 186 {\r
 187 unsigned portLONG ulISRStatus;\r
 188 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE, lDidSomething;\r
 189 portCHAR cChar;\r
 190 \r
 191         /* Just to remove compiler warning. */\r
 192         ( void ) pxUART;\r
 193 \r
 194         do\r
 195         {\r
 196                 lDidSomething = pdFALSE;\r
 197 \r
 198                 ulISRStatus = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 199 \r
 200                 if( ( ulISRStatus & XUL_SR_RX_FIFO_VALID_DATA ) != 0 )\r
 201                 {\r
 202                         /* A character is available - place it in the queue of received\r
 203                         characters.  This might wake a task that was blocked waiting for \r
 204                         data. */\r
 205                         cChar = ( portCHAR ) XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 206                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 207                         lDidSomething = pdTRUE;\r
 208                 }\r
 209                 \r
 210                 if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 211                 {\r
 212                         /* There is space in the FIFO - if there are any characters queue for\r
 213                         transmission they can be sent to the UART now.  This might unblock a\r
 214                         task that was waiting for space to become available on the Tx queue. */\r
 215                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 216                         {\r
 217                                 XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 218                                 lDidSomething = pdTRUE;\r
 219                         }                       \r
 220                 }\r
 221         } while( lDidSomething == pdTRUE );\r
 222 \r
 223         /* If we woke any tasks we may require a context switch. */\r
 224         if( xHigherPriorityTaskWoken )\r
 225         {\r
 226                 portYIELD_FROM_ISR();\r
 227         }\r
 228 }\r
 229 \r
 230 \r
 231 \r