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

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