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

   1 /*\r
   2     FreeRTOS V6.0.1 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS eBook                                  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\r
  22     *                                                                         *\r
  23     ***************************************************************************\r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public \r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it \r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained \r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 \r
  55 /* \r
  56         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART\r
  57 */\r
  58 \r
  59 /* Scheduler includes. */\r
  60 #include "FreeRTOS.h"\r
  61 #include "queue.h"\r
  62 #include "task.h"\r
  63 \r
  64 /* Demo application includes. */\r
  65 #include "serial.h"\r
  66 \r
  67 /* Microblaze driver includes. */\r
  68 #include "xuartlite_l.h"\r
  69 #include "xintc_l.h"\r
  70 \r
  71 /*-----------------------------------------------------------*/\r
  72 \r
  73 /* Queues used to hold received characters, and characters waiting to be\r
  74 transmitted. */\r
  75 static xQueueHandle xRxedChars; \r
  76 static xQueueHandle xCharsForTx; \r
  77 \r
  78 /*-----------------------------------------------------------*/\r
  79 \r
  80 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  81 {\r
  82 unsigned long ulControlReg, ulMask;\r
  83 \r
  84         /* NOTE: The baud rate used by this driver is determined by the hardware\r
  85         parameterization of the UART Lite peripheral, and the baud value passed to\r
  86         this function has no effect. */\r
  87 \r
  88         /* Create the queues used to hold Rx and Tx characters. */\r
  89         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  90         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
  91 \r
  92         if( ( xRxedChars ) && ( xCharsForTx ) )\r
  93         {\r
  94                 /* Disable the interrupt. */\r
  95                 XUartLite_mDisableIntr( XPAR_RS232_UART_BASEADDR );\r
  96                 \r
  97                 /* Flush the fifos. */\r
  98                 ulControlReg = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
  99                 XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_CONTROL_REG_OFFSET, ulControlReg | XUL_CR_FIFO_TX_RESET | XUL_CR_FIFO_RX_RESET );\r
 100 \r
 101                 /* Enable the interrupt again.  The interrupt controller has not yet been \r
 102                 initialised so there is no chance of receiving an interrupt until the \r
 103                 scheduler has been started. */\r
 104                 XUartLite_mEnableIntr( XPAR_RS232_UART_BASEADDR );\r
 105 \r
 106                 /* Enable the interrupt in the interrupt controller while maintaining \r
 107                 all the other bit settings. */\r
 108                 ulMask = XIntc_In32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ) );\r
 109                 ulMask |= XPAR_RS232_UART_INTERRUPT_MASK;\r
 110                 XIntc_Out32( ( XPAR_OPB_INTC_0_BASEADDR + XIN_IER_OFFSET ), ( ulMask ) );\r
 111                 XIntc_mAckIntr( XPAR_INTC_SINGLE_BASEADDR, 2 );\r
 112         }\r
 113         \r
 114         return ( xComPortHandle ) 0;\r
 115 }\r
 116 /*-----------------------------------------------------------*/\r
 117 \r
 118 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 119 {\r
 120         /* The port handle is not required as this driver only supports one UART. */\r
 121         ( void ) pxPort;\r
 122 \r
 123         /* Get the next character from the buffer.  Return false if no characters\r
 124         are available, or arrive before xBlockTime expires. */\r
 125         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 126         {\r
 127                 return pdTRUE;\r
 128         }\r
 129         else\r
 130         {\r
 131                 return pdFALSE;\r
 132         }\r
 133 }\r
 134 /*-----------------------------------------------------------*/\r
 135 \r
 136 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 137 {\r
 138 portBASE_TYPE xReturn = pdTRUE;\r
 139 \r
 140         portENTER_CRITICAL();\r
 141         {\r
 142                 /* If the UART FIFO is full we can block posting the new data on the\r
 143                 Tx queue. */\r
 144                 if( XUartLite_mIsTransmitFull( XPAR_RS232_UART_BASEADDR ) )\r
 145                 {\r
 146                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 147                         {\r
 148                                 xReturn = pdFAIL;\r
 149                         }\r
 150                 }\r
 151                 /* Otherwise, if there is data already in the queue we should add the\r
 152                 new data to the back of the queue to ensure the sequencing is \r
 153                 maintained. */\r
 154                 else if( uxQueueMessagesWaiting( xCharsForTx ) )\r
 155                 {\r
 156                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 157                         {\r
 158                                 xReturn = pdFAIL;\r
 159                         }                       \r
 160                 }\r
 161                 /* If the UART FIFO is not full and there is no data already in the\r
 162                 queue we can write directly to the FIFO without disrupting the \r
 163                 sequence. */\r
 164                 else\r
 165                 {\r
 166                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cOutChar );\r
 167                 }\r
 168         }\r
 169         portEXIT_CRITICAL();\r
 170 \r
 171         return xReturn;\r
 172 }\r
 173 /*-----------------------------------------------------------*/\r
 174 \r
 175 void vSerialClose( xComPortHandle xPort )\r
 176 {\r
 177         /* Not supported as not required by the demo application. */\r
 178         ( void ) xPort;\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 void vSerialISR( void *pvBaseAddress )\r
 183 {\r
 184 unsigned long ulISRStatus;\r
 185 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 186 char cChar;\r
 187 \r
 188         /* Determine the cause of the interrupt. */\r
 189     ulISRStatus = XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_STATUS_REG_OFFSET );\r
 190 \r
 191     if( ( ulISRStatus & ( XUL_SR_RX_FIFO_FULL | XUL_SR_RX_FIFO_VALID_DATA ) ) != 0 )\r
 192         {\r
 193                 /* A character is available - place it in the queue of received\r
 194                 characters.  This might wake a task that was blocked waiting for \r
 195                 data. */\r
 196                 cChar = ( char )XIo_In32( XPAR_RS232_UART_BASEADDR + XUL_RX_FIFO_OFFSET );\r
 197                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 198     }\r
 199 \r
 200     if( ( ulISRStatus & XUL_SR_TX_FIFO_EMPTY ) != 0 )\r
 201     {\r
 202                 /* There is space in the FIFO - if there are any characters queue for\r
 203                 transmission they can be send to the UART now.  This might unblock a\r
 204                 task that was waiting for space to become available on the Tx queue. */\r
 205                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 206                 {\r
 207                         XIo_Out32( XPAR_RS232_UART_BASEADDR + XUL_TX_FIFO_OFFSET, cChar );\r
 208                 }\r
 209     }\r
 210 \r
 211         /* If we woke any tasks we may require a context switch. */\r
 212         if( xHigherPriorityTaskWoken )\r
 213         {\r
 214                 portYIELD_FROM_ISR();\r
 215         }\r
 216 }\r