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

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