git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/NiosII_CycloneIII_DBC3C40_GCC/RTOSDemo/serial.c

   1 /*\r
   2     FreeRTOS V9.0.1 - Copyright (C) 2017 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /* NOTE:  This is just a test file and not intended to be a generic \r
  71 COM driver. */\r
  72 \r
  73 #include "altera_avalon_uart.h"\r
  74 #include "altera_avalon_uart_regs.h"\r
  75 #include "sys/alt_irq.h"\r
  76 \r
  77 #include "FreeRTOS.h"\r
  78 #include "queue.h"\r
  79 #include "system.h"\r
  80 #include "Serial.h"\r
  81 /*---------------------------------------------------------------------------*/\r
  82 \r
  83 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  84 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  85 /*---------------------------------------------------------------------------*/\r
  86 \r
  87 static QueueHandle_t xRxedChars; \r
  88 static QueueHandle_t xCharsForTx; \r
  89 \r
  90 alt_u32 uartControl;\r
  91 /*---------------------------------------------------------------------------*/\r
  92 \r
  93 static void vUARTInterruptHandler( void* context, alt_u32 id );\r
  94 static void vUARTReceiveHandler( alt_u32 status );\r
  95 static void vUARTTransmitHandler( alt_u32 status );\r
  96 /*---------------------------------------------------------------------------*/\r
  97 \r
  98 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  99 {\r
 100         /* Create the queues used to hold Rx and Tx characters. */\r
 101         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 102         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 103 \r
 104         /* If the queues were created correctly then setup the serial port hardware. */\r
 105         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 106         {\r
 107                 portENTER_CRITICAL();\r
 108                 {\r
 109                         uartControl = ALTERA_AVALON_UART_CONTROL_RTS_MSK | ALTERA_AVALON_UART_CONTROL_RRDY_MSK | ALTERA_AVALON_UART_CONTROL_DCTS_MSK;\r
 110                         IOWR_ALTERA_AVALON_UART_CONTROL( UART_BASE, uartControl ); \r
 111                   \r
 112                     /* register the interrupt handler */\r
 113                         alt_irq_register ( UART_IRQ, NULL, vUARTInterruptHandler );\r
 114                 }\r
 115                 portEXIT_CRITICAL();\r
 116         }\r
 117         else\r
 118         {\r
 119                 return ( xComPortHandle ) 0;\r
 120         }\r
 121     return ( xComPortHandle ) 1;\r
 122 }\r
 123 /*---------------------------------------------------------------------------*/\r
 124 \r
 125 void vSerialClose( xComPortHandle xPort )\r
 126 {\r
 127     /* Never used. */\r
 128 }\r
 129 /*---------------------------------------------------------------------------*/\r
 130 \r
 131 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 132 {\r
 133         /* The port handle is not required as this driver only supports one port. */\r
 134         ( void ) pxPort;\r
 135 \r
 136 \r
 137         /* Get the next character from the buffer.  Return false if no characters\r
 138         are available, or arrive before xBlockTime expires. */\r
 139         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 140         {\r
 141                 return pdTRUE;\r
 142         }\r
 143         else\r
 144         {\r
 145                 uartControl |= ALTERA_AVALON_UART_CONTROL_RRDY_MSK;\r
 146                 IOWR_ALTERA_AVALON_UART_CONTROL( UART_BASE, uartControl );\r
 147                 return pdFALSE;\r
 148         }\r
 149 }\r
 150 /*---------------------------------------------------------------------------*/\r
 151 \r
 152 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 153 {\r
 154 signed portBASE_TYPE lReturn = pdPASS;\r
 155 \r
 156         /* Place the character in the queue of characters to be transmitted. */\r
 157         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 158         {\r
 159         /*Triggers an interrupt on every character or (down) when queue is full. */\r
 160         uartControl |= ALTERA_AVALON_UART_CONTROL_TRDY_MSK; \r
 161         IOWR_ALTERA_AVALON_UART_CONTROL( UART_BASE, uartControl );\r
 162         lReturn = pdPASS;\r
 163     }\r
 164     else\r
 165     {   \r
 166                 lReturn = pdFAIL;\r
 167         }\r
 168         return lReturn;\r
 169 }\r
 170 /*---------------------------------------------------------------------------*/\r
 171 \r
 172 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 173 {\r
 174 signed char *pxNext;\r
 175 \r
 176         /* A couple of parameters that this port does not use. */\r
 177         ( void ) usStringLength;\r
 178         ( void ) pxPort;\r
 179 \r
 180         /* NOTE: This implementation does not handle the queue being full as no block time is used! */\r
 181 \r
 182         /* The port handle is not required as this driver only supports UART0. */\r
 183         ( void ) pxPort;\r
 184 \r
 185         /* Send each character in the string, one at a time. */\r
 186         pxNext = ( signed char * ) pcString;\r
 187         while( *pxNext )\r
 188         {\r
 189                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 190                 pxNext++;\r
 191         }\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 static void vUARTInterruptHandler( void* context, alt_u32 id )\r
 196 {\r
 197         alt_u32 status;\r
 198 \r
 199         /* Read the status register in order to determine the cause of the \r
 200     interrupt. */\r
 201         status = IORD_ALTERA_AVALON_UART_STATUS( UART_BASE );\r
 202         \r
 203         /* Clear any error flags set at the device */\r
 204         IOWR_ALTERA_AVALON_UART_STATUS( UART_BASE, 0 );\r
 205         \r
 206         /* process a read irq */\r
 207         if ( status & ALTERA_AVALON_UART_STATUS_RRDY_MSK )\r
 208         {\r
 209                 vUARTReceiveHandler( status );\r
 210         }\r
 211         \r
 212         /* process a write irq */\r
 213         if ( status & ( ALTERA_AVALON_UART_STATUS_TRDY_MSK  ) )\r
 214         {\r
 215                 vUARTTransmitHandler( status );\r
 216         }\r
 217 }\r
 218 /*---------------------------------------------------------------------------*/\r
 219 \r
 220 static void vUARTReceiveHandler( alt_u32 status )\r
 221 {\r
 222 signed char cChar;\r
 223 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 224 \r
 225         /* If there was an error, discard the data */\r
 226         if ( status & ( ALTERA_AVALON_UART_STATUS_PE_MSK | ALTERA_AVALON_UART_STATUS_FE_MSK ) )\r
 227         {\r
 228         asm("break");\r
 229                 return;\r
 230         }\r
 231 \r
 232         /* Transfer data from the device to the circular buffer */\r
 233         cChar = IORD_ALTERA_AVALON_UART_RXDATA( UART_BASE );\r
 234         if ( pdTRUE != xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken ) )\r
 235         {\r
 236                 /* If the circular buffer was full, disable interrupts. Interrupts will \r
 237         be re-enabled when data is removed from the buffer. */\r
 238                 uartControl &= ~ALTERA_AVALON_UART_CONTROL_RRDY_MSK;\r
 239                 IOWR_ALTERA_AVALON_UART_CONTROL( UART_BASE, uartControl );\r
 240         }\r
 241     \r
 242         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 243 }\r
 244 /*---------------------------------------------------------------------------*/\r
 245 \r
 246 static void vUARTTransmitHandler( alt_u32 status )\r
 247 {\r
 248 signed char cChar;\r
 249 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 250         /* Transfer data if there is some ready to be transferred */\r
 251         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 252         {\r
 253                 IOWR_ALTERA_AVALON_UART_TXDATA( UART_BASE, cChar );\r
 254     }\r
 255     else\r
 256     {\r
 257                 uartControl &= ~ALTERA_AVALON_UART_CONTROL_TRDY_MSK;\r
 258     }\r
 259         \r
 260         IOWR_ALTERA_AVALON_UART_CONTROL( UART_BASE, uartControl );\r
 261     portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );    \r
 262 }    \r
 263 /*---------------------------------------------------------------------------*/\r