git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/ARM7_LPC2106_GCC/serial/serialISR.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 \r
  97 /* \r
  98         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  99 \r
 100         This file contains all the serial port components that must be compiled\r
 101         to ARM mode.  The components that can be compiled to either ARM or THUMB\r
 102         mode are contained in serial.c.\r
 103 \r
 104 */\r
 105 \r
 106 /* Standard includes. */\r
 107 #include <stdlib.h>\r
 108 \r
 109 /* Scheduler includes. */\r
 110 #include "FreeRTOS.h"\r
 111 #include "queue.h"\r
 112 #include "task.h"\r
 113 \r
 114 /* Demo application includes. */\r
 115 #include "serial.h"\r
 116 \r
 117 /*-----------------------------------------------------------*/\r
 118 \r
 119 /* Constant to access the VIC. */\r
 120 #define serCLEAR_VIC_INTERRUPT                  ( ( unsigned long ) 0 )\r
 121 \r
 122 /* Constants to determine the ISR source. */\r
 123 #define serSOURCE_THRE                                  ( ( unsigned char ) 0x02 )\r
 124 #define serSOURCE_RX_TIMEOUT                    ( ( unsigned char ) 0x0c )\r
 125 #define serSOURCE_ERROR                                 ( ( unsigned char ) 0x06 )\r
 126 #define serSOURCE_RX                                    ( ( unsigned char ) 0x04 )\r
 127 #define serINTERRUPT_SOURCE_MASK                ( ( unsigned char ) 0x0f )\r
 128 \r
 129 /* Queues used to hold received characters, and characters waiting to be\r
 130 transmitted. */\r
 131 static QueueHandle_t xRxedChars; \r
 132 static QueueHandle_t xCharsForTx; \r
 133 static volatile long lTHREEmpty;\r
 134 \r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 /* \r
 138  * The queues are created in serialISR.c as they are used from the ISR.\r
 139  * Obtain references to the queues and THRE Empty flag. \r
 140  */\r
 141 void vSerialISRCreateQueues( unsigned portBASE_TYPE uxQueueLength, QueueHandle_t *pxRxedChars, QueueHandle_t *pxCharsForTx, long volatile **pplTHREEmptyFlag );\r
 142 \r
 143 /* UART0 interrupt service routine entry point. */\r
 144 void vUART_ISR_Wrapper( void ) __attribute__ ((naked));\r
 145 \r
 146 /* UART0 interrupt service routine handler. */\r
 147 void vUART_ISR_Handler( void ) __attribute__ ((noinline));\r
 148 \r
 149 /*-----------------------------------------------------------*/\r
 150 void vSerialISRCreateQueues(    unsigned portBASE_TYPE uxQueueLength, QueueHandle_t *pxRxedChars, \r
 151                                                                 QueueHandle_t *pxCharsForTx, long volatile **pplTHREEmptyFlag )\r
 152 {\r
 153         /* Create the queues used to hold Rx and Tx characters. */\r
 154         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 155         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 156 \r
 157         /* Pass back a reference to the queues so the serial API file can \r
 158         post/receive characters. */\r
 159         *pxRxedChars = xRxedChars;\r
 160         *pxCharsForTx = xCharsForTx;\r
 161 \r
 162         /* Initialise the THRE empty flag - and pass back a reference. */\r
 163         lTHREEmpty = ( long ) pdTRUE;\r
 164         *pplTHREEmptyFlag = &lTHREEmpty;\r
 165 }\r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 void vUART_ISR_Wrapper( void )\r
 169 {\r
 170         /* Save the context of the interrupted task. */\r
 171         portSAVE_CONTEXT();\r
 172 \r
 173         /* Call the handler.  This must be a separate function from the wrapper\r
 174         to ensure the correct stack frame is set up. */\r
 175         __asm volatile ("bl vUART_ISR_Handler");\r
 176 \r
 177         /* Restore the context of whichever task is going to run next. */\r
 178         portRESTORE_CONTEXT();\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 void vUART_ISR_Handler( void )\r
 183 {\r
 184 signed char cChar;\r
 185 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 186 \r
 187         /* What caused the interrupt? */\r
 188         switch( UART0_IIR & serINTERRUPT_SOURCE_MASK )\r
 189         {\r
 190                 case serSOURCE_ERROR :  /* Not handling this, but clear the interrupt. */\r
 191                                                                 cChar = UART0_LSR;\r
 192                                                                 break;\r
 193 \r
 194                 case serSOURCE_THRE     :       /* The THRE is empty.  If there is another\r
 195                                                                 character in the Tx queue, send it now. */\r
 196                                                                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 197                                                                 {\r
 198                                                                         UART0_THR = cChar;\r
 199                                                                 }\r
 200                                                                 else\r
 201                                                                 {\r
 202                                                                         /* There are no further characters \r
 203                                                                         queued to send so we can indicate \r
 204                                                                         that the THRE is available. */\r
 205                                                                         lTHREEmpty = pdTRUE;\r
 206                                                                 }\r
 207                                                                 break;\r
 208 \r
 209                 case serSOURCE_RX_TIMEOUT :\r
 210                 case serSOURCE_RX       :       /* A character was received.  Place it in \r
 211                                                                 the queue of received characters. */\r
 212                                                                 cChar = UART0_RBR;\r
 213                                                                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 214                                                                 break;\r
 215 \r
 216                 default                         :       /* There is nothing to do, leave the ISR. */\r
 217                                                                 break;\r
 218         }\r
 219 \r
 220         if( xHigherPriorityTaskWoken )\r
 221         {\r
 222                 portYIELD_FROM_ISR();\r
 223         }\r
 224 \r
 225         /* Clear the ISR in the VIC. */\r
 226         VICVectAddr = serCLEAR_VIC_INTERRUPT;\r
 227 }\r
 228 \r
 229 \r
 230 \r
 231 \r
 232 \r
 233 \r
 234         \r