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

   1 /*\r
   2     FreeRTOS V8.2.1 - Copyright (C) 2015 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     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /*\r
  71         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  72 \r
  73         *NOTE* - This file is designed to test some of the RTOS features - it is\r
  74         not intended to represent an efficient implementation!\r
  75 */\r
  76 \r
  77 /* Standard includes. */\r
  78 #include <stdlib.h>\r
  79 \r
  80 /* Scheduler includes. */\r
  81 #include "FreeRTOS.h"\r
  82 #include "queue.h"\r
  83 \r
  84 /* Demo application includes. */\r
  85 #include "serial.h"\r
  86 \r
  87 \r
  88 /* Hardware specifics. */\r
  89 #define serRX_DATA_PIN          ( 0x01 )\r
  90 #define serTX_DATA_PIN          ( 0x02 )\r
  91 #define serCLOCK_Fxx_DIV_8              0x03\r
  92 #define serUPWR         ( 0x80 )\r
  93 #define serUTXE         ( 0x40 )\r
  94 #define serURXE         ( 0x20 )\r
  95 #define serUCL          ( 0x02 )\r
  96 #define serLSB          ( 0x10 )\r
  97 \r
  98 /* Misc. */\r
  99 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
 100 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 101 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
 102 \r
 103 /*-----------------------------------------------------------*/\r
 104 \r
 105 /* Queues used to hold received characters, and characters waiting to be\r
 106 transmitted. */\r
 107 static QueueHandle_t xRxedChars;\r
 108 static QueueHandle_t xCharsForTx;\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 /* Interrupt entry point written in the assembler file serialISR.s85. */\r
 113 extern void vSerialISREntry( void );\r
 114 \r
 115 /* Flag to indicate whether or not there are characters already queued to send. */\r
 116 static volatile unsigned long ulTxInProgress = pdFALSE;\r
 117 \r
 118 /*-----------------------------------------------------------*/\r
 119 \r
 120 /*\r
 121  * See the serial2.h header file.\r
 122  */\r
 123 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 124 {\r
 125 xComPortHandle xReturn = serHANDLE;\r
 126 const unsigned long ulFuclk = ( configCPU_CLOCK_HZ / 2 ) / 8UL;\r
 127 \r
 128         /* Create the queues used to hold Rx and Tx characters. */\r
 129         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 130         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 131 \r
 132         /* If the queues were created correctly then setup the serial port\r
 133         hardware. */\r
 134         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 135         {\r
 136                 portENTER_CRITICAL();\r
 137                 {\r
 138                         /* Set the UART0 Rx and Tx pins to their alternative function. */\r
 139                         PMC3 |= ( serRX_DATA_PIN | serTX_DATA_PIN );\r
 140                         PM3 &= ~( serTX_DATA_PIN );\r
 141 \r
 142                         /* Setup clock for required baud. */                    \r
 143                         UD0CTL1 = serCLOCK_Fxx_DIV_8;\r
 144                         UD0CTL2 = ulFuclk / ( 2 * ulWantedBaud );\r
 145 \r
 146                         /* Enable, n81. */                      \r
 147                         UD0CTL0 = ( serUPWR | serUTXE | serURXE | serUCL | serLSB );\r
 148                         \r
 149                         /* Enable interrupts for both Rx and Tx. */\r
 150                         UD0TIC  = 0x07;\r
 151                         UD0RIC  = 0x07;\r
 152                         \r
 153                         ulTxInProgress = pdFALSE;\r
 154                 }\r
 155                 portEXIT_CRITICAL();\r
 156         }\r
 157         else\r
 158         {\r
 159                 xReturn = ( xComPortHandle ) 0;\r
 160         }\r
 161 \r
 162         /* This demo file only supports a single port but we have to return\r
 163         something to comply with the standard demo header file. */\r
 164         return xReturn;\r
 165 }\r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 169 {\r
 170         /* The port handle is not required as this driver only supports one port. */\r
 171         ( void ) pxPort;\r
 172 \r
 173         /* Get the next character from the buffer.  Return false if no characters\r
 174         are available, or arrive before xBlockTime expires. */\r
 175         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 176         {\r
 177                 return pdTRUE;\r
 178         }\r
 179         else\r
 180         {\r
 181                 return pdFALSE;\r
 182         }\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 187 {\r
 188 signed char *pxNext;\r
 189 \r
 190         /* A couple of parameters that this port does not use. */\r
 191         ( void ) usStringLength;\r
 192         ( void ) pxPort;\r
 193 \r
 194         /* NOTE: This implementation does not handle the queue being full as no\r
 195         block time is used! */\r
 196 \r
 197         /* The port handle is not required as this driver only supports UART0. */\r
 198         ( void ) pxPort;\r
 199 \r
 200         /* Send each character in the string, one at a time. */\r
 201         pxNext = ( signed char * ) pcString;\r
 202         while( *pxNext )\r
 203         {\r
 204                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 205                 pxNext++;\r
 206         }\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 211 {\r
 212 portBASE_TYPE xReturn = pdPASS;\r
 213 \r
 214         portENTER_CRITICAL();\r
 215         {\r
 216                 /* There are currently no characters queued up to send so write the\r
 217                 character directly to the UART. */\r
 218                 if( ulTxInProgress == pdFALSE )\r
 219                 {\r
 220                         UD0TX = cOutChar;\r
 221                         ulTxInProgress = pdTRUE;\r
 222                 }\r
 223                 else\r
 224                 {\r
 225                         /* The UART is already busy so write the character to the Tx queue.\r
 226                         The queue is drained from within the Tx interrupt. */\r
 227                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 228                         {\r
 229                                 xReturn = pdFAIL;\r
 230                         }\r
 231                 }\r
 232         }\r
 233         portEXIT_CRITICAL();\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 /* Tx interrupt handler.  This is called from the asm file wrapper. */\r
 246 void vUARTTxISRHandler( void )\r
 247 {\r
 248 char cChar;\r
 249 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 250 \r
 251         /* Are there any more characters queue to transmit? */\r
 252         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 253         {\r
 254                 /* Send the next character. */\r
 255                 UD0TX = cChar;\r
 256         }\r
 257         else\r
 258         {\r
 259                 /* The UART is no longer active. */\r
 260                 ulTxInProgress = pdFALSE;\r
 261         }\r
 262         \r
 263         /* If reading a character from the Rx queue caused a task to unblock, and\r
 264         the unblocked task has a priority higher than the currently running task,\r
 265         then xHigherPriorityTaskWoken will have been set to true and a context\r
 266         switch should occur now. */\r
 267         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 268 }\r
 269 /*-----------------------------------------------------------*/\r
 270 \r
 271 /* Rx interrupt handler.  This is called from the asm file wrapper. */\r
 272 void vUARTRxISRHandler( void )\r
 273 {\r
 274 char cChar;\r
 275 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 276 \r
 277         /* Send the received character to the Rx queue. */\r
 278         cChar = UD0RX;\r
 279         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 280         \r
 281         /* If sending a character to the Tx queue caused a task to unblock, and\r
 282         the unblocked task has a priority higher than the currently running task,\r
 283         then xHigherPriorityTaskWoken will have been set to true and a context\r
 284         switch should occur now. */\r
 285         portYIELD_FROM_ISR( xHigherPriorityTaskWoken ); \r
 286 }\r
 287 \r
 288 \r
 289 \r
 290 \r
 291         \r