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

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