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

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