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

   1 /*\r
   2         FreeRTOS.org V5.1.2 - Copyright (C) 2003-2009 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\r
  29     * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  30         *                                                                         *\r
  31         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  32         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  33         * explains numerous examples that are written using the FreeRTOS API.     *\r
  34         * Full source code for all the examples is provided in an accompanying    *\r
  35         * .zip file.                                                              *\r
  36     *                                                                         *\r
  37     ***************************************************************************\r
  38     ***************************************************************************\r
  39 \r
  40         Please ensure to read the configuration and relevant port sections of the\r
  41         online documentation.\r
  42 \r
  43         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  44         contact details.\r
  45 \r
  46         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  47         critical systems.\r
  48 \r
  49         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  50         licensing and training services.\r
  51 */\r
  52 \r
  53 /*\r
  54         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  55 \r
  56         *NOTE* - This file is designed to test some of the RTOS features - it is\r
  57         not intended to represent an efficient implementation!\r
  58 */\r
  59 \r
  60 /* Standard includes. */\r
  61 #include <stdlib.h>\r
  62 \r
  63 /* Scheduler includes. */\r
  64 #include "FreeRTOS.h"\r
  65 #include "queue.h"\r
  66 \r
  67 /* Demo application includes. */\r
  68 #include "serial.h"\r
  69 \r
  70 \r
  71 /* Hardware specifics. */\r
  72 #define serRX_DATA_PIN          ( 0x01 )\r
  73 #define serTX_DATA_PIN          ( 0x02 )\r
  74 #define serCLOCK_Fxx_DIV_8              0x03\r
  75 #define serUPWR         ( 0x80 )\r
  76 #define serUTXE         ( 0x40 )\r
  77 #define serURXE         ( 0x20 )\r
  78 #define serUCL          ( 0x02 )\r
  79 #define serLSB          ( 0x10 )\r
  80 \r
  81 /* Misc. */\r
  82 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  83 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  84 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  85 \r
  86 /*-----------------------------------------------------------*/\r
  87 \r
  88 /* Queues used to hold received characters, and characters waiting to be\r
  89 transmitted. */\r
  90 static xQueueHandle xRxedChars;\r
  91 static xQueueHandle xCharsForTx;\r
  92 \r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95 /* Interrupt entry point written in the assembler file serialISR.s85. */\r
  96 extern void vSerialISREntry( void );\r
  97 \r
  98 /* Flag to indicate whether or not there are characters already queued to send. */\r
  99 static volatile unsigned long ulTxInProgress = pdFALSE;\r
 100 \r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 /*\r
 104  * See the serial2.h header file.\r
 105  */\r
 106 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 107 {\r
 108 xComPortHandle xReturn = serHANDLE;\r
 109 const unsigned portLONG ulFuclk = ( configCPU_CLOCK_HZ / 2 ) / 8UL;\r
 110 \r
 111         /* Create the queues used to hold Rx and Tx characters. */\r
 112         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 113         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 114 \r
 115         /* If the queues were created correctly then setup the serial port\r
 116         hardware. */\r
 117         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 118         {\r
 119                 portENTER_CRITICAL();\r
 120                 {\r
 121                         /* Set the UART0 Rx and Tx pins to their alternative function. */\r
 122                         PMC3 |= ( serRX_DATA_PIN | serTX_DATA_PIN );\r
 123                         PM3 &= ~( serTX_DATA_PIN );\r
 124 \r
 125                         /* Setup clock for required baud. */                    \r
 126                         UD0CTL1 = serCLOCK_Fxx_DIV_8;\r
 127                         UD0CTL2 = ulFuclk / ( 2 * ulWantedBaud );\r
 128 \r
 129                         /* Enable, n81. */                      \r
 130                         UD0CTL0 = ( serUPWR | serUTXE | serURXE | serUCL | serLSB );\r
 131                         \r
 132                         /* Enable interrupts for both Rx and Tx. */\r
 133                         UD0TIC  = 0x07;\r
 134                         UD0RIC  = 0x07;\r
 135                         \r
 136                         ulTxInProgress = pdFALSE;\r
 137                 }\r
 138                 portEXIT_CRITICAL();\r
 139         }\r
 140         else\r
 141         {\r
 142                 xReturn = ( xComPortHandle ) 0;\r
 143         }\r
 144 \r
 145         /* This demo file only supports a single port but we have to return\r
 146         something to comply with the standard demo header file. */\r
 147         return xReturn;\r
 148 }\r
 149 /*-----------------------------------------------------------*/\r
 150 \r
 151 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 152 {\r
 153         /* The port handle is not required as this driver only supports one port. */\r
 154         ( void ) pxPort;\r
 155 \r
 156         /* Get the next character from the buffer.  Return false if no characters\r
 157         are available, or arrive before xBlockTime expires. */\r
 158         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 159         {\r
 160                 return pdTRUE;\r
 161         }\r
 162         else\r
 163         {\r
 164                 return pdFALSE;\r
 165         }\r
 166 }\r
 167 /*-----------------------------------------------------------*/\r
 168 \r
 169 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 170 {\r
 171 signed portCHAR *pxNext;\r
 172 \r
 173         /* A couple of parameters that this port does not use. */\r
 174         ( void ) usStringLength;\r
 175         ( void ) pxPort;\r
 176 \r
 177         /* NOTE: This implementation does not handle the queue being full as no\r
 178         block time is used! */\r
 179 \r
 180         /* The port handle is not required as this driver only supports UART0. */\r
 181         ( void ) pxPort;\r
 182 \r
 183         /* Send each character in the string, one at a time. */\r
 184         pxNext = ( signed portCHAR * ) pcString;\r
 185         while( *pxNext )\r
 186         {\r
 187                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 188                 pxNext++;\r
 189         }\r
 190 }\r
 191 /*-----------------------------------------------------------*/\r
 192 \r
 193 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 194 {\r
 195 portBASE_TYPE xReturn = pdPASS;\r
 196 \r
 197         portENTER_CRITICAL();\r
 198         {\r
 199                 /* There are currently no characters queued up to send so write the\r
 200                 character directly to the UART. */\r
 201                 if( ulTxInProgress == pdFALSE )\r
 202                 {\r
 203                         UD0TX = cOutChar;\r
 204                         ulTxInProgress = pdTRUE;\r
 205                 }\r
 206                 else\r
 207                 {\r
 208                         /* The UART is already busy so write the character to the Tx queue.\r
 209                         The queue is drained from within the Tx interrupt. */\r
 210                         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 211                         {\r
 212                                 xReturn = pdFAIL;\r
 213                         }\r
 214                 }\r
 215         }\r
 216         portEXIT_CRITICAL();\r
 217         \r
 218         return xReturn;\r
 219 }\r
 220 /*-----------------------------------------------------------*/\r
 221 \r
 222 void vSerialClose( xComPortHandle xPort )\r
 223 {\r
 224         /* Not supported as not required by the demo application. */\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 /* Tx interrupt handler.  This is called from the asm file wrapper. */\r
 229 void vUARTTxISRHandler( void )\r
 230 {\r
 231 char cChar;\r
 232 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 233 \r
 234         /* Are there any more characters queue to transmit? */\r
 235         if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 236         {\r
 237                 /* Send the next character. */\r
 238                 UD0TX = cChar;\r
 239         }\r
 240         else\r
 241         {\r
 242                 /* The UART is no longer active. */\r
 243                 ulTxInProgress = pdFALSE;\r
 244         }\r
 245         \r
 246         /* If reading a character from the Rx queue caused a task to unblock, and\r
 247         the unblocked task has a priority higher than the currently running task,\r
 248         then xHigherPriorityTaskWoken will have been set to true and a context\r
 249         switch should occur now. */\r
 250         portYIELD_FROM_ISR( xHigherPriorityTaskWoken );\r
 251 }\r
 252 /*-----------------------------------------------------------*/\r
 253 \r
 254 /* Rx interrupt handler.  This is called from the asm file wrapper. */\r
 255 void vUARTRxISRHandler( void )\r
 256 {\r
 257 portCHAR cChar;\r
 258 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 259 \r
 260         /* Send the received character to the Rx queue. */\r
 261         cChar = UD0RX;\r
 262         xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 263         \r
 264         /* If sending a character to the Tx queue caused a task to unblock, and\r
 265         the unblocked task has a priority higher than the currently running task,\r
 266         then xHigherPriorityTaskWoken will have been set to true and a context\r
 267         switch should occur now. */\r
 268         portYIELD_FROM_ISR( xHigherPriorityTaskWoken ); \r
 269 }\r
 270 \r
 271 \r
 272 \r
 273 \r
 274         \r