git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_MB9A310_IAR_Keil/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 /*\r
  97         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  98         \r
  99         ***Note*** This example uses queues to send each character into an interrupt\r
 100         service routine and out of an interrupt service routine individually.  This\r
 101         is done to demonstrate queues being used in an interrupt, and to deliberately\r
 102         load the system to test the FreeRTOS port.  It is *NOT* meant to be an\r
 103         example of an efficient implementation.  An efficient implementation should\r
 104         use FIFOs or DMA if available, and only use FreeRTOS API functions when\r
 105         enough has been received to warrant a task being unblocked to process the\r
 106         data.\r
 107 */\r
 108 \r
 109 /* Scheduler includes. */\r
 110 #include "FreeRTOS.h"\r
 111 #include "queue.h"\r
 112 #include "semphr.h"\r
 113 #include "comtest2.h"\r
 114 \r
 115 /* Library includes. */\r
 116 #include "mcu.h"\r
 117 \r
 118 /* Demo application includes. */\r
 119 #include "serial.h"\r
 120 /*-----------------------------------------------------------*/\r
 121 \r
 122 /* Register bit definitions. */\r
 123 #define serRX_INT_ENABLE                0x10\r
 124 #define serTX_INT_ENABLE                0x08\r
 125 #define serRX_ENABLE                    0x02\r
 126 #define serTX_ENABLE                    0x01\r
 127 #define serORE_ERROR_BIT                0x08\r
 128 #define serFRE_ERROR_BIT                0x10\r
 129 #define serPE_ERROR_BIT                 0x20\r
 130 #define serRX_INT                               0x04\r
 131 #define serTX_INT                               0x02\r
 132 \r
 133 /* Misc defines. */\r
 134 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
 135 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
 136 \r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 /* The queue used to hold received characters. */\r
 140 static QueueHandle_t xRxedChars;\r
 141 static QueueHandle_t xCharsForTx;\r
 142 \r
 143 /*-----------------------------------------------------------*/\r
 144 \r
 145 /*\r
 146  * See the serial2.h header file.\r
 147  */\r
 148 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 149 {\r
 150         /* Create the queues used to hold Rx/Tx characters. */\r
 151         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 152         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 153         \r
 154         /* If the queues were created correctly then setup the serial port\r
 155         hardware. */\r
 156         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 157         {\r
 158                 /* Ensure interrupts don't fire during the init process.  Interrupts\r
 159                 will be enabled automatically when the first task start running. */\r
 160                 portDISABLE_INTERRUPTS();\r
 161                 \r
 162                 /* Configure P21 and P22 for use by the UART. */\r
 163                 FM3_GPIO->PFR2 |= ( 1 << 0x01 ) | ( 1 << 0x02 );\r
 164                 \r
 165                 /* SIN0_0 and SOT0_0. */\r
 166                 FM3_GPIO->EPFR07 |= ( 1 << 6 );\r
 167                 \r
 168                 /* Reset. */\r
 169                 FM3_MFS0_UART->SCR = 0x80;\r
 170                 \r
 171                 /* Enable output in mode 0. */\r
 172                 FM3_MFS0_UART->SMR = 0x01;\r
 173                 \r
 174                 /* Clear all errors that may already be present. */\r
 175                 FM3_MFS0_UART->SSR = 0x00;\r
 176                 FM3_MFS0_UART->ESCR = 0x00;\r
 177                 \r
 178                 FM3_MFS0_UART->BGR = ( configCPU_CLOCK_HZ / 2UL ) / ( ulWantedBaud - 1UL );\r
 179 \r
 180                 /* Enable Rx, Tx, and the Rx interrupt. */              \r
 181                 FM3_MFS0_UART->SCR |= ( serRX_ENABLE | serTX_ENABLE | serRX_INT_ENABLE );\r
 182                 \r
 183                 /* Configure the NVIC for UART interrupts. */\r
 184                 NVIC_ClearPendingIRQ( MFS0RX_IRQn );\r
 185                 NVIC_EnableIRQ( MFS0RX_IRQn );\r
 186                 \r
 187                 /* The priority *MUST* be at or below\r
 188                 configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY as FreeRTOS API functions\r
 189                 are called in the interrupt handler. */\r
 190                 NVIC_SetPriority( MFS0RX_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 191                 \r
 192                 /* Do the same for the Tx interrupts. */\r
 193                 NVIC_ClearPendingIRQ( MFS0TX_IRQn );\r
 194                 NVIC_EnableIRQ( MFS0TX_IRQn );\r
 195                 \r
 196                 /* The priority *MUST* be at or below\r
 197                 configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY as FreeRTOS API functions\r
 198                 are called in the interrupt handler. */\r
 199                 NVIC_SetPriority( MFS0TX_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );\r
 200         }\r
 201 \r
 202         /* This demo file only supports a single port but we have to return\r
 203         something to comply with the standard demo header file. */\r
 204         return ( xComPortHandle ) 0;\r
 205 }\r
 206 /*-----------------------------------------------------------*/\r
 207 \r
 208 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 209 {\r
 210         /* The port handle is not required as this driver only supports one port. */\r
 211         ( void ) pxPort;\r
 212 \r
 213         /* Get the next character from the buffer.  Return false if no characters\r
 214         are available, or arrive before xBlockTime expires. */\r
 215         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 216         {\r
 217                 return pdTRUE;\r
 218         }\r
 219         else\r
 220         {\r
 221                 return pdFALSE;\r
 222         }\r
 223 }\r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 227 {\r
 228 signed char *pxNext;\r
 229 \r
 230         /* A couple of parameters that this port does not use. */\r
 231         ( void ) usStringLength;\r
 232         ( void ) pxPort;\r
 233 \r
 234         /* NOTE: This implementation does not handle the queue being full as no\r
 235         block time is used! */\r
 236 \r
 237         /* The port handle is not required as this driver only supports one UART. */\r
 238         ( void ) pxPort;\r
 239 \r
 240         /* Send each character in the string, one at a time. */\r
 241         pxNext = ( signed char * ) pcString;\r
 242         while( *pxNext )\r
 243         {\r
 244                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 245                 pxNext++;\r
 246         }\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 251 {\r
 252 signed portBASE_TYPE xReturn;\r
 253 \r
 254         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) == pdPASS )\r
 255         {\r
 256                 xReturn = pdPASS;\r
 257                 \r
 258                 /* Enable the UART Tx interrupt. */\r
 259                 FM3_MFS0_UART->SCR |= serTX_INT_ENABLE;\r
 260         }\r
 261         else\r
 262         {\r
 263                 xReturn = pdFAIL;\r
 264         }\r
 265 \r
 266         return xReturn;\r
 267 }\r
 268 /*-----------------------------------------------------------*/\r
 269 \r
 270 void vSerialClose( xComPortHandle xPort )\r
 271 {\r
 272         /* Not supported as not required by the demo application. */\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 void MFS0RX_IRQHandler( void )\r
 277 {\r
 278 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 279 char cChar;\r
 280 \r
 281         if( ( FM3_MFS0_UART->SSR & ( serORE_ERROR_BIT | serFRE_ERROR_BIT | serPE_ERROR_BIT ) ) != 0 )\r
 282         {\r
 283                 /* A PE, ORE or FRE error occurred.  Clear it. */\r
 284                 FM3_MFS0_UART->SSR |= ( 1 << 7 );\r
 285                 cChar = FM3_MFS0_UART->RDR;\r
 286         }\r
 287         else if( FM3_MFS0_UART->SSR & serRX_INT )\r
 288         {\r
 289                 /* A character has been received on the USART, send it to the Rx\r
 290                 handler task. */\r
 291                 cChar = FM3_MFS0_UART->RDR;\r
 292                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 293         }       \r
 294 \r
 295         /* If sending or receiving from a queue has caused a task to unblock, and\r
 296         the unblocked task has a priority equal to or higher than the currently\r
 297         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 298         will have automatically been set to pdTRUE within the queue send or receive\r
 299         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 300         directly to the higher priority unblocked task. */\r
 301         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 302 }\r
 303 /*-----------------------------------------------------------*/\r
 304 \r
 305 void MFS0TX_IRQHandler( void )\r
 306 {\r
 307 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 308 char cChar;\r
 309 \r
 310         if( FM3_MFS0_UART->SSR & serTX_INT )\r
 311         {\r
 312                 /* The interrupt was caused by the TX register becoming empty.  Are\r
 313                 there any more characters to transmit? */\r
 314                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 315                 {\r
 316                         /* A character was retrieved from the queue so can be sent to the\r
 317                         USART now. */\r
 318                         FM3_MFS0_UART->TDR = cChar;\r
 319                 }\r
 320                 else\r
 321                 {\r
 322                         /* Disable the Tx interrupt. */\r
 323                         FM3_MFS0_UART->SCR &= ~serTX_INT_ENABLE;\r
 324                 }               \r
 325         }       \r
 326 \r
 327         /* If sending or receiving from a queue has caused a task to unblock, and\r
 328         the unblocked task has a priority equal to or higher than the currently\r
 329         running task (the task this ISR interrupted), then xHigherPriorityTaskWoken\r
 330         will have automatically been set to pdTRUE within the queue send or receive\r
 331         function.  portEND_SWITCHING_ISR() will then ensure that this ISR returns\r
 332         directly to the higher priority unblocked task. */\r
 333         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 334 }\r
 335 \r
 336 \r
 337 \r
 338 \r
 339 \r
 340         \r