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

   1 /*\r
   2     FreeRTOS V7.5.2 - 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 /* Microblaze driver includes. */\r
  79 #include "xuartlite_l.h"\r
  80 #include "xintc_l.h"\r
  81 \r
  82 /*-----------------------------------------------------------*/\r
  83 \r
  84 /* Queues used to hold received characters, and characters waiting to be\r
  85 transmitted. */\r
  86 static xQueueHandle xRxedChars; \r
  87 static xQueueHandle xCharsForTx; \r
  88 \r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  92 {\r
  93 unsigned long ulControlReg, ulMask;\r
  94 \r
  95         /* NOTE: The baud rate used by this driver is determined by the hardware\r
  96         parameterization of the UART Lite peripheral, and the baud value passed to\r
  97         this function has no effect. */\r
  98 \r
  99         /* Create the queues used to hold Rx and Tx characters. */\r
 100         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 101         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 102 \r
 103         if( ( xRxedChars ) && ( xCharsForTx ) )\r
 104         {\r
 105                 /* Disable the interrupt. */\r
 106                 XUartLite_mDisableIntr( XPAR_RS232_UART_BASEADDR );\r
 107                 \r
 108                 /* Flush the fifos. */\r
 109                 ulControlReg = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 110                 XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_CONTROL_REG_OFFSET, ulControlReg | XUL_CR_FIFO_TX_RESET | XUL_CR_FIFO_RX_RESET );\r
 111 \r
 112                 /* Enable the interrupt again.  The interrupt controller has not yet been \r
 113                 initialised so there is no chance of receiving an interrupt until the \r
 114                 scheduler has been started. */\r
 115                 XUartLite_mEnableIntr( XPAR_RS232_UART_BASEADDR );\r
 116 \r
 117                 /* Enable the interrupt in the interrupt controller while maintaining \r
 118                 all the other bit settings. */\r
 119                 ulMask = XIntc_In32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ) );\r
 120                 ulMask |= XPAR_RS232_UART_INTERRUPT_MASK;\r
 121                 XIntc_Out32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ), ( ulMask ) );\r
 122                 XIntc_mAckIntr( XPAR_INTC_SINGLE_BASEADDR, 2 );\r
 123         }\r
 124         \r
 125         return ( xComPortHandle ) 0;\r
 126 }\r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 130 {\r
 131         /* The port handle is not required as this driver only supports one UART. */\r
 132         ( void ) pxPort;\r
 133 \r
 134         /* Get the next character from the buffer.  Return false if no characters\r
 135         are available, or arrive before xBlockTime expires. */\r
 136         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 137         {\r
 138                 return pdTRUE;\r
 139         }\r
 140         else\r
 141         {\r
 142                 return pdFALSE;\r
 143         }\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 148 {\r
 149 portBASE_TYPE xReturn = pdTRUE;\r
 150 \r
 151         portENTER_CRITICAL();\r
 152         {\r
 153                 /* If the UART FIFO is full we can block posting the new data on the\r
 154                 Tx queue. */\r
 155                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_BASEADDR ) )\r
 156                 {\r
 157                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 158                         {\r
 159                                 xReturn = pdFAIL;\r
 160                         }\r
 161                 }\r
 162                 /* Otherwise, if there is data already in the queue we should add the\r
 163                 new data to the back of the queue to ensure the sequencing is \r
 164                 maintained. */\r
 165                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 166                 {\r
 167                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 168                         {\r
 169                                 xReturn = pdFAIL;\r
 170                         }                       \r
 171                 }\r
 172                 /* If the UART FIFO is not full and there is no data already in the\r
 173                 queue we can write directly to the FIFO without disrupting the \r
 174                 sequence. */\r
 175                 else\r
 176                 {\r
 177                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 178                 }\r
 179         }\r
 180         portEXIT_CRITICAL();\r
 181 \r
 182         return xReturn;\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 void vSerialClose( xComPortHandle xPort )\r
 187 {\r
 188         /* Not supported as not required by the demo application. */\r
 189         ( void ) xPort;\r
 190 }\r
 191 /*-----------------------------------------------------------*/\r
 192 \r
 193 void vSerialISR( void *pvBaseAddress )\r
 194 {\r
 195 unsigned long ulISRStatus;\r
 196 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 197 char cChar;\r
 198 \r
 199         /* Determine the cause of the interrupt. */\r
 200     ulISRStatus = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 201 \r
 202     if( ( ulISRStatus & ( XUL_SR_RX_FIFO_FULL | XUL_SR_RX_FIFO_VALID_DATA ) ) != 0 )\r
 203         {\r
 204                 /* A character is available - place it in the queue of received\r
 205                 characters.  This might wake a task that was blocked waiting for \r
 206                 data. */\r
 207                 cChar = ( char )XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 208                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 209     }\r
 210 \r
 211     if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 212     {\r
 213                 /* There is space in the FIFO - if there are any characters queue for\r
 214                 transmission they can be send to the UART now.  This might unblock a\r
 215                 task that was waiting for space to become available on the Tx queue. */\r
 216                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 217                 {\r
 218                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 219                 }\r
 220     }\r
 221 \r
 222         /* If we woke any tasks we may require a context switch. */\r
 223         if( xHigherPriorityTaskWoken )\r
 224         {\r
 225                 portYIELD_FROM_ISR();\r
 226         }\r
 227 }\r