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

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\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 modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /*\r
  68         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  69         \r
  70         ***Note*** This example uses queues to send each character into an interrupt\r
  71         service routine and out of an interrupt service routine individually.  This\r
  72         is done to demonstrate queues being used in an interrupt, and to deliberately\r
  73         load the system to test the FreeRTOS port.  It is *NOT* meant to be an\r
  74         example of an efficient implementation.  An efficient implementation should\r
  75         use FIFOs or DMA if available, and only use FreeRTOS API functions when\r
  76         enough has been received to warrant a task being unblocked to process the\r
  77         data.\r
  78 */\r
  79 \r
  80 /* Scheduler includes. */\r
  81 #include "FreeRTOS.h"\r
  82 #include "queue.h"\r
  83 #include "semphr.h"\r
  84 #include "comtest2.h"\r
  85 \r
  86 /* Library includes. */\r
  87 #include "mcu.h"\r
  88 \r
  89 /* Demo application includes. */\r
  90 #include "serial.h"\r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 /* Register bit definitions. */\r
  94 #define serRX_INT_ENABLE                0x10\r
  95 #define serTX_INT_ENABLE                0x08\r
  96 #define serRX_ENABLE                    0x02\r
  97 #define serTX_ENABLE                    0x01\r
  98 #define serORE_ERROR_BIT                0x08\r
  99 #define serFRE_ERROR_BIT                0x10\r
 100 #define serPE_ERROR_BIT                 0x20\r
 101 #define serRX_INT                               0x04\r
 102 #define serTX_INT                               0x02\r
 103 \r
 104 /* Misc defines. */\r
 105 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
 106 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /* The queue used to hold received characters. */\r
 111 static xQueueHandle xRxedChars;\r
 112 static xQueueHandle xCharsForTx;\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /*\r
 117  * See the serial2.h header file.\r
 118  */\r
 119 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 120 {\r
 121         /* Create the queues used to hold Rx/Tx characters. */\r
 122         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 123         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 124         \r
 125         /* If the queues were created correctly then setup the serial port\r
 126         hardware. */\r
 127         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 128         {\r
 129                 /* Ensure interrupts don't fire during the init process.  Interrupts\r
 130                 will be enabled automatically when the first task start running. */\r
 131                 portDISABLE_INTERRUPTS();\r
 132                 \r
 133                 /* Configure P21 and P22 for use by the UART. */\r
 134                 FM3_GPIO->PFR2 |= ( 1 << 0x01 ) | ( 1 << 0x02 );\r
 135                 \r
 136                 /* SIN0_0 and SOT0_0. */\r
 137                 FM3_GPIO->EPFR07 |= ( 1 << 6 );\r
 138                 \r
 139                 /* Reset. */\r
 140                 FM3_MFS0_UART->SCR = 0x80;\r
 141                 \r
 142                 /* Enable output in mode 0. */\r
 143                 FM3_MFS0_UART->SMR = 0x01;\r
 144                 \r
 145                 /* Clear all errors that may already be present. */\r
 146                 FM3_MFS0_UART->SSR = 0x00;\r
 147                 FM3_MFS0_UART->ESCR = 0x00;\r
 148                 \r
 149                 FM3_MFS0_UART->BGR = ( configCPU_CLOCK_HZ / 2UL ) / ( ulWantedBaud - 1UL );\r
 150 \r
 151                 /* Enable Rx, Tx, and the Rx interrupt. */              \r
 152                 FM3_MFS0_UART->SCR |= ( serRX_ENABLE | serTX_ENABLE | serRX_INT_ENABLE );\r
 153                 \r
 154                 /* Configure the NVIC for UART interrupts. */\r
 155                 NVIC_ClearPendingIRQ( MFS0RX_IRQn );\r
 156                 NVIC_EnableIRQ( MFS0RX_IRQn );\r
 157                 \r
 158                 /* The priority *MUST* be at or below\r
 159                 configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY as FreeRTOS API functions\r
 160                 are called in the interrupt handler. */\r
 161                 NVIC_SetPriority( MFS0RX_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 162                 \r
 163                 /* Do the same for the Tx interrupts. */\r
 164                 NVIC_ClearPendingIRQ( MFS0TX_IRQn );\r
 165                 NVIC_EnableIRQ( MFS0TX_IRQn );\r
 166                 \r
 167                 /* The priority *MUST* be at or below\r
 168                 configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY as FreeRTOS API functions\r
 169                 are called in the interrupt handler. */\r
 170                 NVIC_SetPriority( MFS0TX_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 171         }\r
 172 \r
 173         /* This demo file only supports a single port but we have to return\r
 174         something to comply with the standard demo header file. */\r
 175         return ( xComPortHandle ) 0;\r
 176 }\r
 177 /*-----------------------------------------------------------*/\r
 178 \r
 179 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 180 {\r
 181         /* The port handle is not required as this driver only supports one port. */\r
 182         ( void ) pxPort;\r
 183 \r
 184         /* Get the next character from the buffer.  Return false if no characters\r
 185         are available, or arrive before xBlockTime expires. */\r
 186         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 187         {\r
 188                 return pdTRUE;\r
 189         }\r
 190         else\r
 191         {\r
 192                 return pdFALSE;\r
 193         }\r
 194 }\r
 195 /*-----------------------------------------------------------*/\r
 196 \r
 197 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 198 {\r
 199 signed char *pxNext;\r
 200 \r
 201         /* A couple of parameters that this port does not use. */\r
 202         ( void ) usStringLength;\r
 203         ( void ) pxPort;\r
 204 \r
 205         /* NOTE: This implementation does not handle the queue being full as no\r
 206         block time is used! */\r
 207 \r
 208         /* The port handle is not required as this driver only supports one UART. */\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 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 222 {\r
 223 signed portBASE_TYPE xReturn;\r
 224 \r
 225         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 226         {\r
 227                 xReturn = pdPASS;\r
 228                 \r
 229                 /* Enable the UART Tx interrupt. */\r
 230                 FM3_MFS0_UART->SCR |= serTX_INT_ENABLE;\r
 231         }\r
 232         else\r
 233         {\r
 234                 xReturn = pdFAIL;\r
 235         }\r
 236 \r
 237         return xReturn;\r
 238 }\r
 239 /*-----------------------------------------------------------*/\r
 240 \r
 241 void vSerialClose( xComPortHandle xPort )\r
 242 {\r
 243         /* Not supported as not required by the demo application. */\r
 244 }\r
 245 /*-----------------------------------------------------------*/\r
 246 \r
 247 void MFS0RX_IRQHandler( void )\r
 248 {\r
 249 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 250 char cChar;\r
 251 \r
 252         if( ( FM3_MFS0_UART->SSR & ( serORE_ERROR_BIT | serFRE_ERROR_BIT | serPE_ERROR_BIT ) ) != 0 )\r
 253         {\r
 254                 /* A PE, ORE or FRE error occurred.  Clear it. */\r
 255                 FM3_MFS0_UART->SSR |= ( 1 << 7 );\r
 256                 cChar = FM3_MFS0_UART->RDR;\r
 257         }\r
 258         else if( FM3_MFS0_UART->SSR & serRX_INT )\r
 259         {\r
 260                 /* A character has been received on the USART, send it to the Rx\r
 261                 handler task. */\r
 262                 cChar = FM3_MFS0_UART->RDR;\r
 263                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 264         }       \r
 265 \r
 266         /* If sending or receiving from a queue has caused a task to unblock, and\r
 267         the unblocked task has a priority equal to or higher than the currently\r
 268         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 269         will have automatically been set to pdTRUE within the queue send or receive\r
 270         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 271         directly to the higher priority unblocked task. */\r
 272         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 void MFS0TX_IRQHandler( void )\r
 277 {\r
 278 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 279 char cChar;\r
 280 \r
 281         if( FM3_MFS0_UART->SSR & serTX_INT )\r
 282         {\r
 283                 /* The interrupt was caused by the TX register becoming empty.  Are\r
 284                 there any more characters to transmit? */\r
 285                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 286                 {\r
 287                         /* A character was retrieved from the queue so can be sent to the\r
 288                         USART now. */\r
 289                         FM3_MFS0_UART->TDR = cChar;\r
 290                 }\r
 291                 else\r
 292                 {\r
 293                         /* Disable the Tx interrupt. */\r
 294                         FM3_MFS0_UART->SCR &= ~serTX_INT_ENABLE;\r
 295                 }               \r
 296         }       \r
 297 \r
 298         /* If sending or receiving from a queue has caused a task to unblock, and\r
 299         the unblocked task has a priority equal to or higher than the currently\r
 300         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 301         will have automatically been set to pdTRUE within the queue send or receive\r
 302         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 303         directly to the higher priority unblocked task. */\r
 304         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 305 }\r
 306 \r
 307 \r
 308 \r
 309 \r
 310 \r
 311         \r