git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/NEC_V850ES_IAR/serial/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 file is designed to test some of the RTOS features - it is\r
 100         not intended to represent an efficient implementation!\r
 101 */\r
 102 \r
 103 /* Standard includes. */\r
 104 #include <stdlib.h>\r
 105 \r
 106 /* Scheduler includes. */\r
 107 #include "FreeRTOS.h"\r
 108 #include "queue.h"\r
 109 \r
 110 /* Demo application includes. */\r
 111 #include "serial.h"\r
 112 \r
 113 \r
 114 /* Hardware specifics. */\r
 115 #define serRX_DATA_PIN          ( 0x01 )\r
 116 #define serTX_DATA_PIN          ( 0x02 )\r
 117 #define serCLOCK_Fxx_DIV_8              0x03\r
 118 #define serUPWR         ( 0x80 )\r
 119 #define serUTXE         ( 0x40 )\r
 120 #define serURXE         ( 0x20 )\r
 121 #define serUCL          ( 0x02 )\r
 122 #define serLSB          ( 0x10 )\r
 123 \r
 124 /* Misc. */\r
 125 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
 126 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 127 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
 128 \r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* Queues used to hold received characters, and characters waiting to be\r
 132 transmitted. */\r
 133 static QueueHandle_t xRxedChars;\r
 134 static QueueHandle_t xCharsForTx;\r
 135 \r
 136 /*-----------------------------------------------------------*/\r
 137 \r
 138 /* Interrupt entry point written in the assembler file serialISR.s85. */\r
 139 extern void vSerialISREntry( void );\r
 140 \r
 141 /* Flag to indicate whether or not there are characters already queued to send. */\r
 142 static volatile unsigned long ulTxInProgress = pdFALSE;\r
 143 \r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 /*\r
 147  * See the serial2.h header file.\r
 148  */\r
 149 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 150 {\r
 151 xComPortHandle xReturn = serHANDLE;\r
 152 const unsigned long ulFuclk = ( configCPU_CLOCK_HZ / 2 ) / 8UL;\r
 153 \r
 154         /* Create the queues used to hold Rx and Tx characters. */\r
 155         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 156         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 157 \r
 158         /* If the queues were created correctly then setup the serial port\r
 159         hardware. */\r
 160         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 161         {\r
 162                 portENTER_CRITICAL();\r
 163                 {\r
 164                         /* Set the UART0 Rx and Tx pins to their alternative function. */\r
 165                         PMC3 |= ( serRX_DATA_PIN | serTX_DATA_PIN );\r
 166                         PM3 &= ~( serTX_DATA_PIN );\r
 167 \r
 168                         /* Setup clock for required baud. */                    \r
 169                         UD0CTL1 = serCLOCK_Fxx_DIV_8;\r
 170                         UD0CTL2 = ulFuclk / ( 2 * ulWantedBaud );\r
 171 \r
 172                         /* Enable, n81. */                      \r
 173                         UD0CTL0 = ( serUPWR | serUTXE | serURXE | serUCL | serLSB );\r
 174                         \r
 175                         /* Enable interrupts for both Rx and Tx. */\r
 176                         UD0TIC  = 0x07;\r
 177                         UD0RIC  = 0x07;\r
 178                         \r
 179                         ulTxInProgress = pdFALSE;\r
 180                 }\r
 181                 portEXIT_CRITICAL();\r
 182         }\r
 183         else\r
 184         {\r
 185                 xReturn = ( xComPortHandle ) 0;\r
 186         }\r
 187 \r
 188         /* This demo file only supports a single port but we have to return\r
 189         something to comply with the standard demo header file. */\r
 190         return xReturn;\r
 191 }\r
 192 /*-----------------------------------------------------------*/\r
 193 \r
 194 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 195 {\r
 196         /* The port handle is not required as this driver only supports one port. */\r
 197         ( void ) pxPort;\r
 198 \r
 199         /* Get the next character from the buffer.  Return false if no characters\r
 200         are available, or arrive before xBlockTime expires. */\r
 201         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 202         {\r
 203                 return pdTRUE;\r
 204         }\r
 205         else\r
 206         {\r
 207                 return pdFALSE;\r
 208         }\r
 209 }\r
 210 /*-----------------------------------------------------------*/\r
 211 \r
 212 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 213 {\r
 214 signed char *pxNext;\r
 215 \r
 216         /* A couple of parameters that this port does not use. */\r
 217         ( void ) usStringLength;\r
 218         ( void ) pxPort;\r
 219 \r
 220         /* NOTE: This implementation does not handle the queue being full as no\r
 221         block time is used! */\r
 222 \r
 223         /* The port handle is not required as this driver only supports UART0. */\r
 224         ( void ) pxPort;\r
 225 \r
 226         /* Send each character in the string, one at a time. */\r
 227         pxNext = ( signed char * ) pcString;\r
 228         while( *pxNext )\r
 229         {\r
 230                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 231                 pxNext++;\r
 232         }\r
 233 }\r
 234 /*-----------------------------------------------------------*/\r
 235 \r
 236 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 237 {\r
 238 portBASE_TYPE xReturn = pdPASS;\r
 239 \r
 240         portENTER_CRITICAL();\r
 241         {\r
 242                 /* There are currently no characters queued up to send so write the\r
 243                 character directly to the UART. */\r
 244                 if( ulTxInProgress == pdFALSE )\r
 245                 {\r
 246                         UD0TX = cOutChar;\r
 247                         ulTxInProgress = pdTRUE;\r
 248                 }\r
 249                 else\r
 250                 {\r
 251                         /* The UART is already busy so write the character to the Tx queue.\r
 252                         The queue is drained from within the Tx interrupt. */\r
 253                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 254                         {\r
 255                                 xReturn = pdFAIL;\r
 256                         }\r
 257                 }\r
 258         }\r
 259         portEXIT_CRITICAL();\r
 260         \r
 261         return xReturn;\r
 262 }\r
 263 /*-----------------------------------------------------------*/\r
 264 \r
 265 void vSerialClose( xComPortHandle xPort )\r
 266 {\r
 267         /* Not supported as not required by the demo application. */\r
 268 }\r
 269 /*-----------------------------------------------------------*/\r
 270 \r
 271 /* Tx interrupt handler.  This is called from the asm file wrapper. */\r
 272 void vUARTTxISRHandler( void )\r
 273 {\r
 274 char cChar;\r
 275 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 276 \r
 277         /* Are there any more characters queue to transmit? */\r
 278         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 279         {\r
 280                 /* Send the next character. */\r
 281                 UD0TX = cChar;\r
 282         }\r
 283         else\r
 284         {\r
 285                 /* The UART is no longer active. */\r
 286                 ulTxInProgress = pdFALSE;\r
 287         }\r
 288         \r
 289         /* If reading a character from the Rx queue caused a task to unblock, and\r
 290         the unblocked task has a priority higher than the currently running task,\r
 291         then xHigherPriorityTaskWoken will have been set to true and a context\r
 292         switch should occur now. */\r
 293         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 294 }\r
 295 /*-----------------------------------------------------------*/\r
 296 \r
 297 /* Rx interrupt handler.  This is called from the asm file wrapper. */\r
 298 void vUARTRxISRHandler( void )\r
 299 {\r
 300 char cChar;\r
 301 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 302 \r
 303         /* Send the received character to the Rx queue. */\r
 304         cChar = UD0RX;\r
 305         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 306         \r
 307         /* If sending a character to the Tx queue caused a task to unblock, and\r
 308         the unblocked task has a priority higher than the currently running task,\r
 309         then xHigherPriorityTaskWoken will have been set to true and a context\r
 310         switch should occur now. */\r
 311         portYIELD_FROM_ISR( xHigherPriorityTaskWoken ); \r
 312 }\r
 313 \r
 314 \r
 315 \r
 316 \r
 317         \r