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

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