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