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

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