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

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