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

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