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

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