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

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