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

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