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

   1 /*\r
   2     FreeRTOS V7.5.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   5 \r
   6     ***************************************************************************\r
   7      *                                                                       *\r
   8      *    FreeRTOS provides completely free yet professionally developed,    *\r
   9      *    robust, strictly quality controlled, supported, and cross          *\r
  10      *    platform software that has become a de facto standard.             *\r
  11      *                                                                       *\r
  12      *    Help yourself get started quickly and support the FreeRTOS         *\r
  13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  15      *                                                                       *\r
  16      *    Thank you!                                                         *\r
  17      *                                                                       *\r
  18     ***************************************************************************\r
  19 \r
  20     This file is part of the FreeRTOS distribution.\r
  21 \r
  22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  23     the terms of the GNU General Public License (version 2) as published by the\r
  24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  25 \r
  26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  28     >>! the source code for proprietary components outside of the FreeRTOS\r
  29     >>! kernel.\r
  30 \r
  31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  34     link: http://www.freertos.org/a00114.html\r
  35 \r
  36     1 tab == 4 spaces!\r
  37 \r
  38     ***************************************************************************\r
  39      *                                                                       *\r
  40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  41      *    not run, what could be wrong?"                                     *\r
  42      *                                                                       *\r
  43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  44      *                                                                       *\r
  45     ***************************************************************************\r
  46 \r
  47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  48     license and Real Time Engineers Ltd. contact details.\r
  49 \r
  50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  53 \r
  54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  56     licenses offer ticketed support, indemnification and middleware.\r
  57 \r
  58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  59     engineered and independently SIL3 certified version for use in safety and\r
  60     mission critical applications that require provable dependability.\r
  61 \r
  62     1 tab == 4 spaces!\r
  63 */\r
  64 \r
  65 \r
  66 /* \r
  67         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  68 */\r
  69 \r
  70 /* Scheduler includes. */\r
  71 #include "FreeRTOS.h"\r
  72 #include "queue.h"\r
  73 #include "task.h"\r
  74 \r
  75 /* Demo application includes. */\r
  76 #include "serial.h"\r
  77 \r
  78 /* Library includes. */\r
  79 #include "xparameters.h"\r
  80 #include "xuartlite.h"\r
  81 #include "xuartlite_l.h"\r
  82 \r
  83 /*-----------------------------------------------------------*/\r
  84 \r
  85 /* Queues used to hold received characters, and characters waiting to be\r
  86 transmitted. */\r
  87 static xQueueHandle xRxedChars; \r
  88 static xQueueHandle xCharsForTx; \r
  89 \r
  90 /* Structure that maintains information on the UART being used. */\r
  91 static XUartLite xUART;\r
  92 \r
  93 /*\r
  94  * Sample UART interrupt handler.  Note this is used to demonstrate the kernel\r
  95  * features and test the port - it is not intended to represent an efficient\r
  96  * implementation.\r
  97  */\r
  98 static void vSerialISR( XUartLite *pxUART );\r
  99 \r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 103 {\r
 104         /* NOTE: The baud rate used by this driver is determined by the hardware\r
 105         parameterization of the UART Lite peripheral, and the baud value passed to\r
 106         this function has no effect. */\r
 107         ( void ) ulWantedBaud;\r
 108 \r
 109         /* Create the queues used to hold Rx and Tx characters. */\r
 110         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 111         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 112 \r
 113         /* Only initialise the UART if the queues were created correctly. */\r
 114         if( ( xRxedChars != NULL ) && ( xCharsForTx != NULL ) )\r
 115         {\r
 116 \r
 117                 XUartLite_Initialize( &xUART, XPAR_RS232_UART_1_DEVICE_ID );\r
 118                 XUartLite_ResetFifos( &xUART );\r
 119                 XUartLite_DisableInterrupt( &xUART );\r
 120 \r
 121                 if( xPortInstallInterruptHandler( XPAR_XPS_INTC_0_RS232_UART_1_INTERRUPT_INTR, ( XInterruptHandler )vSerialISR, (void *)&xUART ) == pdPASS )\r
 122                 {\r
 123                         /* xPortInstallInterruptHandler() could fail if \r
 124                         vPortSetupInterruptController() has not been called prior to this \r
 125                         function. */\r
 126                         XUartLite_EnableInterrupt( &xUART );\r
 127                 }\r
 128         }\r
 129         \r
 130         /* There is only one port so the handle is not used. */\r
 131         return ( xComPortHandle ) 0;\r
 132 }\r
 133 /*-----------------------------------------------------------*/\r
 134 \r
 135 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 136 {\r
 137         /* The port handle is not required as this driver only supports one UART. */\r
 138         ( void ) pxPort;\r
 139 \r
 140         /* Get the next character from the buffer.  Return false if no characters\r
 141         are available, or arrive before xBlockTime expires. */\r
 142         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 143         {\r
 144                 return pdTRUE;\r
 145         }\r
 146         else\r
 147         {\r
 148                 return pdFALSE;\r
 149         }\r
 150 }\r
 151 /*-----------------------------------------------------------*/\r
 152 \r
 153 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 154 {\r
 155 portBASE_TYPE xReturn = pdTRUE;\r
 156 \r
 157         /* Just to remove compiler warning. */\r
 158         ( void ) pxPort;\r
 159 \r
 160         portENTER_CRITICAL();\r
 161         {\r
 162                 /* If the UART FIFO is full we can block posting the new data on the\r
 163                 Tx queue. */\r
 164                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_1_BASEADDR ) )\r
 165                 {\r
 166                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 167                         {\r
 168                                 xReturn = pdFAIL;\r
 169                         }\r
 170                 }\r
 171                 /* Otherwise, if there is data already in the queue we should add the\r
 172                 new data to the back of the queue to ensure the sequencing is \r
 173                 maintained. */\r
 174                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 175                 {\r
 176                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 177                         {\r
 178                                 xReturn = pdFAIL;\r
 179                         }                       \r
 180                 }\r
 181                 /* If the UART FIFO is not full and there is no data already in the\r
 182                 queue we can write directly to the FIFO without disrupting the \r
 183                 sequence. */\r
 184                 else\r
 185                 {\r
 186                         XIo_Out32( XPAR_RS232_UART_1_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 187                 }\r
 188         }\r
 189         portEXIT_CRITICAL();\r
 190 \r
 191         return xReturn;\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 void vSerialClose( xComPortHandle xPort )\r
 196 {\r
 197         /* Not supported as not required by the demo application. */\r
 198         ( void ) xPort;\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 static void vSerialISR( XUartLite *pxUART )\r
 203 {\r
 204 unsigned long ulISRStatus;\r
 205 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE, lDidSomething;\r
 206 char cChar;\r
 207 \r
 208         /* Just to remove compiler warning. */\r
 209         ( void ) pxUART;\r
 210 \r
 211         do\r
 212         {\r
 213                 lDidSomething = pdFALSE;\r
 214 \r
 215                 ulISRStatus = XIo_In32( XPAR_RS232_UART_1_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 216 \r
 217                 if( ( ulISRStatus & XUL_SR_RX_FIFO_VALID_DATA ) != 0 )\r
 218                 {\r
 219                         /* A character is available - place it in the queue of received\r
 220                         characters.  This might wake a task that was blocked waiting for \r
 221                         data. */\r
 222                         cChar = ( char ) XIo_In32( XPAR_RS232_UART_1_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 223                         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 224                         lDidSomething = pdTRUE;\r
 225                 }\r
 226                 \r
 227                 if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 228                 {\r
 229                         /* There is space in the FIFO - if there are any characters queue for\r
 230                         transmission they can be sent to the UART now.  This might unblock a\r
 231                         task that was waiting for space to become available on the Tx queue. */\r
 232                         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 233                         {\r
 234                                 XIo_Out32( XPAR_RS232_UART_1_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 235                                 lDidSomething = pdTRUE;\r
 236                         }                       \r
 237                 }\r
 238         } while( lDidSomething == pdTRUE );\r
 239 \r
 240         /* If we woke any tasks we may require a context switch. */\r
 241         if( xHigherPriorityTaskWoken )\r
 242         {\r
 243                 portYIELD_FROM_ISR();\r
 244         }\r
 245 }\r
 246 \r
 247 \r
 248 \r