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

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