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

   1 /*\r
   2     FreeRTOS V7.4.1 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 \r
  76 /* \r
  77         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  78 */\r
  79 \r
  80 /* Scheduler includes. */\r
  81 #include "FreeRTOS.h"\r
  82 #include "queue.h"\r
  83 #include "task.h"\r
  84 \r
  85 /* Demo application includes. */\r
  86 #include "serial.h"\r
  87 \r
  88 /* Microblaze driver includes. */\r
  89 #include "xuartlite_l.h"\r
  90 #include "xintc_l.h"\r
  91 \r
  92 /*-----------------------------------------------------------*/\r
  93 \r
  94 /* Queues used to hold received characters, and characters waiting to be\r
  95 transmitted. */\r
  96 static xQueueHandle xRxedChars; \r
  97 static xQueueHandle xCharsForTx; \r
  98 \r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 102 {\r
 103 unsigned long ulControlReg, ulMask;\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 \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         if( ( xRxedChars ) && ( xCharsForTx ) )\r
 114         {\r
 115                 /* Disable the interrupt. */\r
 116                 XUartLite_mDisableIntr( XPAR_RS232_UART_BASEADDR );\r
 117                 \r
 118                 /* Flush the fifos. */\r
 119                 ulControlReg = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 120                 XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_CONTROL_REG_OFFSET, ulControlReg | XUL_CR_FIFO_TX_RESET | XUL_CR_FIFO_RX_RESET );\r
 121 \r
 122                 /* Enable the interrupt again.  The interrupt controller has not yet been \r
 123                 initialised so there is no chance of receiving an interrupt until the \r
 124                 scheduler has been started. */\r
 125                 XUartLite_mEnableIntr( XPAR_RS232_UART_BASEADDR );\r
 126 \r
 127                 /* Enable the interrupt in the interrupt controller while maintaining \r
 128                 all the other bit settings. */\r
 129                 ulMask = XIntc_In32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ) );\r
 130                 ulMask |= XPAR_RS232_UART_INTERRUPT_MASK;\r
 131                 XIntc_Out32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ), ( ulMask ) );\r
 132                 XIntc_mAckIntr( XPAR_INTC_SINGLE_BASEADDR, 2 );\r
 133         }\r
 134         \r
 135         return ( xComPortHandle ) 0;\r
 136 }\r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 140 {\r
 141         /* The port handle is not required as this driver only supports one UART. */\r
 142         ( void ) pxPort;\r
 143 \r
 144         /* Get the next character from the buffer.  Return false if no characters\r
 145         are available, or arrive before xBlockTime expires. */\r
 146         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 147         {\r
 148                 return pdTRUE;\r
 149         }\r
 150         else\r
 151         {\r
 152                 return pdFALSE;\r
 153         }\r
 154 }\r
 155 /*-----------------------------------------------------------*/\r
 156 \r
 157 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 158 {\r
 159 portBASE_TYPE xReturn = pdTRUE;\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 void vSerialISR( void *pvBaseAddress )\r
 204 {\r
 205 unsigned long ulISRStatus;\r
 206 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 207 char cChar;\r
 208 \r
 209         /* Determine the cause of the interrupt. */\r
 210     ulISRStatus = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 211 \r
 212     if( ( ulISRStatus & ( XUL_SR_RX_FIFO_FULL | XUL_SR_RX_FIFO_VALID_DATA ) ) != 0 )\r
 213         {\r
 214                 /* A character is available - place it in the queue of received\r
 215                 characters.  This might wake a task that was blocked waiting for \r
 216                 data. */\r
 217                 cChar = ( char )XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 218                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 219     }\r
 220 \r
 221     if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 222     {\r
 223                 /* There is space in the FIFO - if there are any characters queue for\r
 224                 transmission they can be send to the UART now.  This might unblock a\r
 225                 task that was waiting for space to become available on the Tx queue. */\r
 226                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 227                 {\r
 228                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 229                 }\r
 230     }\r
 231 \r
 232         /* If we woke any tasks we may require a context switch. */\r
 233         if( xHigherPriorityTaskWoken )\r
 234         {\r
 235                 portYIELD_FROM_ISR();\r
 236         }\r
 237 }\r