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

   1 /*\r
   2     FreeRTOS V8.1.2 - 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /*  Basic interrupt driven serial port driver for uart1.\r
  67 */\r
  68 \r
  69 /* Standard includes. */\r
  70 #include <stdlib.h>\r
  71 \r
  72 /* Kernel includes. */\r
  73 #include "FreeRTOS.h"\r
  74 #include "queue.h"\r
  75 #include "task.h"\r
  76 \r
  77 /* Demo application includes. */\r
  78 #include <machine/uart.h>\r
  79 #include <machine/ic.h>\r
  80 #include "serial.h"\r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 #define comBLOCK_RETRY_TIME                             10\r
  84 /*-----------------------------------------------------------*/\r
  85 \r
  86 /* The interrupt handlers are naked functions that call C handlers.  The C\r
  87 handlers are marked as noinline to ensure they work correctly when the\r
  88 optimiser is on. */\r
  89 void interrupt5_handler( void ) __attribute__((naked));\r
  90 static void prvTxHandler( void ) __attribute__((noinline));\r
  91 void interrupt6_handler( void ) __attribute__((naked));\r
  92 static void prvRxHandler( void ) __attribute__((noinline));\r
  93 \r
  94 /*-----------------------------------------------------------*/\r
  95 \r
  96 /* Queues used to hold received characters, and characters waiting to be\r
  97 transmitted. */\r
  98 static QueueHandle_t xRxedChars;\r
  99 static QueueHandle_t xCharsForTx;\r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 103 {\r
 104         /* Create the queues used to hold Rx and Tx characters. */\r
 105         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 106         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 107 \r
 108         if( ( xRxedChars ) && ( xCharsForTx ) )\r
 109         {\r
 110                 /* Set up interrupts */\r
 111                 /* tx interrupt will be enabled when we need to send something */\r
 112                 uart1->tx_mask = 0;\r
 113                 uart1->rx_mask = 1;\r
 114                 irq[IRQ_UART1_TX].ien = 1;\r
 115                 irq[IRQ_UART1_RX].ien = 1;\r
 116         }\r
 117 \r
 118         return ( xComPortHandle ) 0;\r
 119 }\r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 123 {\r
 124         /* The port handle is not required as this driver only supports uart1. */\r
 125         (void) pxPort;\r
 126 \r
 127         /* Get the next character from the buffer.      Return false if no characters\r
 128            are available, or arrive before xBlockTime expires. */\r
 129         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 130         {\r
 131                 return pdTRUE;\r
 132         }\r
 133         else\r
 134         {\r
 135                 return pdFALSE;\r
 136         }\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 141 {\r
 142         int i;\r
 143         signed char *pChNext;\r
 144 \r
 145         /* Send each character in the string, one at a time. */\r
 146         pChNext = ( signed char * )pcString;\r
 147         for( i = 0; i < usStringLength; i++ )\r
 148         {\r
 149                 /* Block until character has been transmitted. */\r
 150                 while( xSerialPutChar( pxPort, *pChNext, comBLOCK_RETRY_TIME ) != pdTRUE ); pChNext++;\r
 151         }\r
 152 }\r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 156 {\r
 157         ( void ) pxPort;\r
 158 \r
 159         /* Place the character in the queue of characters to be transmitted. */\r
 160         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 161         {\r
 162                 return pdFAIL;\r
 163         }\r
 164 \r
 165         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 166            queue and send it. This does not need to be in a critical section as\r
 167            if the interrupt has already removed the character the next interrupt\r
 168            will simply turn off the Tx interrupt again. */\r
 169         uart1->tx_mask = 1;\r
 170 \r
 171         return pdPASS;\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 /* UART Tx interrupt handler. */\r
 183 void interrupt5_handler( void )\r
 184 {\r
 185         /* This is a naked function. */\r
 186         portSAVE_CONTEXT();\r
 187         prvTxHandler();\r
 188         portRESTORE_CONTEXT();\r
 189 }\r
 190 /*-----------------------------------------------------------*/\r
 191 \r
 192 static void prvTxHandler( void )\r
 193 {\r
 194 signed char cChar;\r
 195 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 196 \r
 197         /* The interrupt was caused by the transmit fifo having space for at least one\r
 198         character. Are there any more characters to transmit? */\r
 199         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 200         {\r
 201                 /* A character was retrieved from the queue so can be sent to the uart now. */\r
 202                 uart1->tx_data = cChar;\r
 203         }\r
 204         else\r
 205         {\r
 206                 /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 207                 uart1->tx_mask = 0;\r
 208         }\r
 209 \r
 210         /* If an event caused a task to unblock then we call "Yield from ISR" to\r
 211         ensure that the unblocked task is the task that executes when the interrupt\r
 212         completes if the unblocked task has a priority higher than the interrupted\r
 213         task. */\r
 214         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 215 }\r
 216 /*-----------------------------------------------------------*/\r
 217 \r
 218 /* UART Rx interrupt. */\r
 219 void interrupt6_handler( void )\r
 220 {\r
 221         portSAVE_CONTEXT();\r
 222         prvRxHandler();\r
 223         portRESTORE_CONTEXT();\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 static void prvRxHandler( void )\r
 228 {\r
 229 signed char cChar;\r
 230 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 231 \r
 232         /* The interrupt was caused by the receiver getting data. */\r
 233         cChar = uart1->rx_data;\r
 234 \r
 235         xQueueSendFromISR(xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 236 \r
 237         /* If an event caused a task to unblock then we call "Yield from ISR" to\r
 238         ensure that the unblocked task is the task that executes when the interrupt\r
 239         completes if the unblocked task has a priority higher than the interrupted\r
 240         task. */\r
 241         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 242 }\r
 243 /*-----------------------------------------------------------*/\r
 244 \r
 245 \r