begriffs open source - freertos/blob - Demo/MicroBlaze/serial/serial.c

   1 /*\r
   2         FreeRTOS.org V4.1.2 - Copyright (C) 2003-2006 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 */\r
  32 \r
  33 \r
  34 /* \r
  35         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  36 */\r
  37 \r
  38 /* Scheduler includes. */\r
  39 #include "FreeRTOS.h"\r
  40 #include "queue.h"\r
  41 #include "task.h"\r
  42 \r
  43 /* Demo application includes. */\r
  44 #include "serial.h"\r
  45 \r
  46 /* Microblaze driver includes. */\r
  47 #include "xuartlite_l.h"\r
  48 #include "xintc_l.h"\r
  49 \r
  50 /*-----------------------------------------------------------*/\r
  51 \r
  52 /* Queues used to hold received characters, and characters waiting to be\r
  53 transmitted. */\r
  54 static xQueueHandle xRxedChars; \r
  55 static xQueueHandle xCharsForTx; \r
  56 \r
  57 /*-----------------------------------------------------------*/\r
  58 \r
  59 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  60 {\r
  61 unsigned portLONG ulControlReg, ulMask;\r
  62 \r
  63         /* NOTE: The baud rate used by this driver is determined by the hardware\r
  64         parameterization of the UART Lite peripheral, and the baud value passed to\r
  65         this function has no effect. */\r
  66 \r
  67         /* Create the queues used to hold Rx and Tx characters. */\r
  68         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  69         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
  70 \r
  71         if( ( xRxedChars ) && ( xCharsForTx ) )\r
  72         {\r
  73                 /* Disable the interrupt. */\r
  74                 XUartLite_mDisableIntr( XPAR_RS232_UART_BASEADDR );\r
  75                 \r
  76                 /* Flush the fifos. */\r
  77                 ulControlReg = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
  78                 XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_CONTROL_REG_OFFSET, ulControlReg | XUL_CR_FIFO_TX_RESET | XUL_CR_FIFO_RX_RESET );\r
  79 \r
  80                 /* Enable the interrupt again.  The interrupt controller has not yet been \r
  81                 initialised so there is no chance of receiving an interrupt until the \r
  82                 scheduler has been started. */\r
  83                 XUartLite_mEnableIntr( XPAR_RS232_UART_BASEADDR );\r
  84 \r
  85                 /* Enable the interrupt in the interrupt controller while maintaining \r
  86                 all the other bit settings. */\r
  87                 ulMask = XIntc_In32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ) );\r
  88                 ulMask |= XPAR_RS232_UART_INTERRUPT_MASK;\r
  89                 XIntc_Out32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ), ( ulMask ) );\r
  90                 XIntc_mAckIntr( XPAR_INTC_SINGLE_BASEADDR, 2 );\r
  91         }\r
  92         \r
  93         return ( xComPortHandle ) 0;\r
  94 }\r
  95 /*-----------------------------------------------------------*/\r
  96 \r
  97 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
  98 {\r
  99         /* The port handle is not required as this driver only supports one UART. */\r
 100         ( void ) pxPort;\r
 101 \r
 102         /* Get the next character from the buffer.  Return false if no characters\r
 103         are available, or arrive before xBlockTime expires. */\r
 104         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 105         {\r
 106                 return pdTRUE;\r
 107         }\r
 108         else\r
 109         {\r
 110                 return pdFALSE;\r
 111         }\r
 112 }\r
 113 /*-----------------------------------------------------------*/\r
 114 \r
 115 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 116 {\r
 117 portBASE_TYPE xReturn = pdTRUE;\r
 118 \r
 119         portENTER_CRITICAL();\r
 120         {\r
 121                 /* If the UART FIFO is full we can block posting the new data on the\r
 122                 Tx queue. */\r
 123                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_BASEADDR ) )\r
 124                 {\r
 125                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 126                         {\r
 127                                 xReturn = pdFAIL;\r
 128                         }\r
 129                 }\r
 130                 /* Otherwise, if there is data already in the queue we should add the\r
 131                 new data to the back of the queue to ensure the sequencing is \r
 132                 maintained. */\r
 133                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 134                 {\r
 135                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 136                         {\r
 137                                 xReturn = pdFAIL;\r
 138                         }                       \r
 139                 }\r
 140                 /* If the UART FIFO is not full and there is no data already in the\r
 141                 queue we can write directly to the FIFO without disrupting the \r
 142                 sequence. */\r
 143                 else\r
 144                 {\r
 145                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 146                 }\r
 147         }\r
 148         portEXIT_CRITICAL();\r
 149 \r
 150         return xReturn;\r
 151 }\r
 152 /*-----------------------------------------------------------*/\r
 153 \r
 154 void vSerialClose( xComPortHandle xPort )\r
 155 {\r
 156         /* Not supported as not required by the demo application. */\r
 157         ( void ) xPort;\r
 158 }\r
 159 /*-----------------------------------------------------------*/\r
 160 \r
 161 void vSerialISR( void *pvBaseAddress )\r
 162 {\r
 163 unsigned portLONG ulISRStatus;\r
 164 portBASE_TYPE xTaskWokenByTx = pdFALSE, xTaskWokenByRx = pdFALSE;\r
 165 portCHAR cChar;\r
 166 \r
 167         /* Determine the cause of the interrupt. */\r
 168     ulISRStatus = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 169 \r
 170     if( ( ulISRStatus & ( XUL_SR_RX_FIFO_FULL | XUL_SR_RX_FIFO_VALID_DATA ) ) != 0 )\r
 171         {\r
 172                 /* A character is available - place it in the queue of received\r
 173                 characters.  This might wake a task that was blocked waiting for \r
 174                 data. */\r
 175                 cChar = ( portCHAR )XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 176                 xTaskWokenByRx = xQueueSendFromISR( xRxedChars, &cChar, xTaskWokenByRx );\r
 177     }\r
 178 \r
 179     if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 180     {\r
 181                 /* There is space in the FIFO - if there are any characters queue for\r
 182                 transmission they can be send to the UART now.  This might unblock a\r
 183                 task that was waiting for space to become available on the Tx queue. */\r
 184                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xTaskWokenByTx ) == pdTRUE )\r
 185                 {\r
 186                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 187                 }\r
 188     }\r
 189 \r
 190         /* If we woke any tasks we may require a context switch. */\r
 191         if( xTaskWokenByTx || xTaskWokenByRx )\r
 192         {\r
 193                 portYIELD_FROM_ISR();\r
 194         }\r
 195 }\r