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

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