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

   1 /*\r
   2         FreeRTOS.org V4.5.0 - Copyright (C) 2003-2007 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 \r
  37 /* \r
  38         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  39 */\r
  40 \r
  41 /* Scheduler includes. */\r
  42 #include "FreeRTOS.h"\r
  43 #include "queue.h"\r
  44 #include "task.h"\r
  45 \r
  46 /* Demo application includes. */\r
  47 #include "serial.h"\r
  48 \r
  49 /* Microblaze driver includes. */\r
  50 #include "xuartlite_l.h"\r
  51 #include "xintc_l.h"\r
  52 \r
  53 /*-----------------------------------------------------------*/\r
  54 \r
  55 /* Queues used to hold received characters, and characters waiting to be\r
  56 transmitted. */\r
  57 static xQueueHandle xRxedChars; \r
  58 static xQueueHandle xCharsForTx; \r
  59 \r
  60 /*-----------------------------------------------------------*/\r
  61 \r
  62 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  63 {\r
  64 unsigned portLONG ulControlReg, ulMask;\r
  65 \r
  66         /* NOTE: The baud rate used by this driver is determined by the hardware\r
  67         parameterization of the UART Lite peripheral, and the baud value passed to\r
  68         this function has no effect. */\r
  69 \r
  70         /* Create the queues used to hold Rx and Tx characters. */\r
  71         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  72         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  73 \r
  74         if( ( xRxedChars ) && ( xCharsForTx ) )\r
  75         {\r
  76                 /* Disable the interrupt. */\r
  77                 XUartLite_mDisableIntr( XPAR_RS232_UART_BASEADDR );\r
  78                 \r
  79                 /* Flush the fifos. */\r
  80                 ulControlReg = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
  81                 XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_CONTROL_REG_OFFSET, ulControlReg | XUL_CR_FIFO_TX_RESET | XUL_CR_FIFO_RX_RESET );\r
  82 \r
  83                 /* Enable the interrupt again.  The interrupt controller has not yet been \r
  84                 initialised so there is no chance of receiving an interrupt until the \r
  85                 scheduler has been started. */\r
  86                 XUartLite_mEnableIntr( XPAR_RS232_UART_BASEADDR );\r
  87 \r
  88                 /* Enable the interrupt in the interrupt controller while maintaining \r
  89                 all the other bit settings. */\r
  90                 ulMask = XIntc_In32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ) );\r
  91                 ulMask |= XPAR_RS232_UART_INTERRUPT_MASK;\r
  92                 XIntc_Out32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ), ( ulMask ) );\r
  93                 XIntc_mAckIntr( XPAR_INTC_SINGLE_BASEADDR, 2 );\r
  94         }\r
  95         \r
  96         return ( xComPortHandle ) 0;\r
  97 }\r
  98 /*-----------------------------------------------------------*/\r
  99 \r
 100 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 101 {\r
 102         /* The port handle is not required as this driver only supports one UART. */\r
 103         ( void ) pxPort;\r
 104 \r
 105         /* Get the next character from the buffer.  Return false if no characters\r
 106         are available, or arrive before xBlockTime expires. */\r
 107         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 108         {\r
 109                 return pdTRUE;\r
 110         }\r
 111         else\r
 112         {\r
 113                 return pdFALSE;\r
 114         }\r
 115 }\r
 116 /*-----------------------------------------------------------*/\r
 117 \r
 118 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 119 {\r
 120 portBASE_TYPE xReturn = pdTRUE;\r
 121 \r
 122         portENTER_CRITICAL();\r
 123         {\r
 124                 /* If the UART FIFO is full we can block posting the new data on the\r
 125                 Tx queue. */\r
 126                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_BASEADDR ) )\r
 127                 {\r
 128                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 129                         {\r
 130                                 xReturn = pdFAIL;\r
 131                         }\r
 132                 }\r
 133                 /* Otherwise, if there is data already in the queue we should add the\r
 134                 new data to the back of the queue to ensure the sequencing is \r
 135                 maintained. */\r
 136                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 137                 {\r
 138                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 139                         {\r
 140                                 xReturn = pdFAIL;\r
 141                         }                       \r
 142                 }\r
 143                 /* If the UART FIFO is not full and there is no data already in the\r
 144                 queue we can write directly to the FIFO without disrupting the \r
 145                 sequence. */\r
 146                 else\r
 147                 {\r
 148                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 149                 }\r
 150         }\r
 151         portEXIT_CRITICAL();\r
 152 \r
 153         return xReturn;\r
 154 }\r
 155 /*-----------------------------------------------------------*/\r
 156 \r
 157 void vSerialClose( xComPortHandle xPort )\r
 158 {\r
 159         /* Not supported as not required by the demo application. */\r
 160         ( void ) xPort;\r
 161 }\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 void vSerialISR( void *pvBaseAddress )\r
 165 {\r
 166 unsigned portLONG ulISRStatus;\r
 167 portBASE_TYPE xTaskWokenByTx = pdFALSE, xTaskWokenByRx = pdFALSE;\r
 168 portCHAR cChar;\r
 169 \r
 170         /* Determine the cause of the interrupt. */\r
 171     ulISRStatus = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 172 \r
 173     if( ( ulISRStatus & ( XUL_SR_RX_FIFO_FULL | XUL_SR_RX_FIFO_VALID_DATA ) ) != 0 )\r
 174         {\r
 175                 /* A character is available - place it in the queue of received\r
 176                 characters.  This might wake a task that was blocked waiting for \r
 177                 data. */\r
 178                 cChar = ( portCHAR )XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 179                 xTaskWokenByRx = xQueueSendFromISR( xRxedChars, &cChar, xTaskWokenByRx );\r
 180     }\r
 181 \r
 182     if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 183     {\r
 184                 /* There is space in the FIFO - if there are any characters queue for\r
 185                 transmission they can be send to the UART now.  This might unblock a\r
 186                 task that was waiting for space to become available on the Tx queue. */\r
 187                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWokenByTx ) == pdTRUE )\r
 188                 {\r
 189                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 190                 }\r
 191     }\r
 192 \r
 193         /* If we woke any tasks we may require a context switch. */\r
 194         if( xTaskWokenByTx || xTaskWokenByRx )\r
 195         {\r
 196                 portYIELD_FROM_ISR();\r
 197         }\r
 198 }\r