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

   1 /*\r
   2     FreeRTOS V7.4.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not itcan be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /*\r
  76         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  77 */\r
  78 \r
  79 /* Library includes. */\r
  80 #include "uart.h"\r
  81 #include "gpio.h"\r
  82 #include "eic.h"\r
  83 \r
  84 /* Scheduler includes. */\r
  85 #include "FreeRTOS.h"\r
  86 #include "queue.h"\r
  87 \r
  88 /* Demo application includes. */\r
  89 #include "serial.h"\r
  90 \r
  91 #define UART0_Rx_Pin                                    ( 0x0001<< 8 )\r
  92 #define UART0_Tx_Pin                                    ( 0x0001<< 9 )\r
  93 \r
  94 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  95 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  96 \r
  97 /* Macros to turn on and off the Tx empty interrupt. */\r
  98 #define serINTERRUPT_ON()                               UART0->IER |= UART_TxHalfEmpty\r
  99 #define serINTERRUPT_OFF()                              UART0->IER &= ~UART_TxHalfEmpty\r
 100 \r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 /* Queues used to hold received characters, and characters waiting to be\r
 104 transmitted. */\r
 105 static xQueueHandle xRxedChars;\r
 106 static xQueueHandle xCharsForTx;\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
 111 extern void vSerialISREntry( void );\r
 112 \r
 113 /* The interrupt service routine - called from the assembly entry point. */\r
 114 __arm void vSerialISR( void );\r
 115 \r
 116 /*-----------------------------------------------------------*/\r
 117 \r
 118 /*\r
 119  * See the serial2.h header file.\r
 120  */\r
 121 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 122 {\r
 123 xComPortHandle xReturn;\r
 124         \r
 125         /* Create the queues used to hold Rx and Tx characters. */\r
 126         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 127         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 128 \r
 129         /* If the queues were created correctly then setup the serial port\r
 130         hardware. */\r
 131         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 132         {\r
 133                 portENTER_CRITICAL();\r
 134                 {\r
 135                         /* Setup the UART port pins. */\r
 136                         GPIO_Config( GPIO0, UART0_Tx_Pin, GPIO_AF_PP );\r
 137                         GPIO_Config( GPIO0, UART0_Rx_Pin, GPIO_IN_TRI_CMOS );\r
 138 \r
 139                         /* Configure the UART. */\r
 140                         UART_OnOffConfig( UART0, ENABLE );\r
 141                         UART_FifoConfig( UART0, DISABLE );\r
 142                         UART_FifoReset( UART0, UART_RxFIFO );\r
 143                         UART_FifoReset( UART0, UART_TxFIFO );\r
 144                         UART_LoopBackConfig(UART0, DISABLE );\r
 145                         UART_Config( UART0, ulWantedBaud, UART_NO_PARITY, UART_1_StopBits, UARTM_8D );\r
 146                         UART_RxConfig( UART0, ENABLE );\r
 147 \r
 148                         /* Configure the IEC for the UART interrupts. */\r
 149                         EIC_IRQChannelPriorityConfig( UART0_IRQChannel, 1 );\r
 150                         EIC_IRQChannelConfig( UART0_IRQChannel, ENABLE );\r
 151                         EIC_IRQConfig( ENABLE );\r
 152                         UART_ItConfig( UART0, UART_RxBufFull, ENABLE );\r
 153                 }\r
 154                 portEXIT_CRITICAL();\r
 155         }\r
 156         else\r
 157         {\r
 158                 xReturn = ( xComPortHandle ) 0;\r
 159         }\r
 160 \r
 161         /* This demo file only supports a single port but we have to return\r
 162         something to comply with the standard demo header file. */\r
 163         return xReturn;\r
 164 }\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 168 {\r
 169         /* The port handle is not required as this driver only supports one port. */\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* Get the next character from the buffer.  Return false if no characters\r
 173         are available, or arrive before xBlockTime expires. */\r
 174         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 175         {\r
 176                 return pdTRUE;\r
 177         }\r
 178         else\r
 179         {\r
 180                 return pdFALSE;\r
 181         }\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 186 {\r
 187 signed char *pxNext;\r
 188 \r
 189         /* A couple of parameters that this port does not use. */\r
 190         ( void ) usStringLength;\r
 191         ( void ) pxPort;\r
 192 \r
 193         /* NOTE: This implementation does not handle the queue being full as no\r
 194         block time is used! */\r
 195 \r
 196         /* The port handle is not required as this driver only supports UART0. */\r
 197         ( void ) pxPort;\r
 198 \r
 199         /* Send each character in the string, one at a time. */\r
 200         pxNext = ( signed char * ) pcString;\r
 201         while( *pxNext )\r
 202         {\r
 203                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 204                 pxNext++;\r
 205         }\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 210 {\r
 211         /* Place the character in the queue of characters to be transmitted. */\r
 212         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 213         {\r
 214                 return pdFAIL;\r
 215         }\r
 216 \r
 217         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 218         queue and send it.   This does not need to be in a critical section as\r
 219         if the interrupt has already removed the character the next interrupt\r
 220         will simply turn off the Tx interrupt again. */\r
 221         serINTERRUPT_ON();\r
 222 \r
 223         return pdPASS;\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 void vSerialClose( xComPortHandle xPort )\r
 228 {\r
 229         /* Not supported as not required by the demo application. */\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 234 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 235 within serialISR.s79 which in turn calls this function.  See the port\r
 236 documentation on the FreeRTOS.org website for more information. */\r
 237 __arm void vSerialISR( void )\r
 238 {\r
 239 unsigned short usStatus;\r
 240 signed char cChar;\r
 241 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 242 \r
 243         /* What caused the interrupt? */\r
 244         usStatus = UART_FlagStatus( UART0 );\r
 245 \r
 246         if( usStatus & UART_TxHalfEmpty )\r
 247         {\r
 248                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 249                 more characters to transmit? */\r
 250                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 251                 {\r
 252                         /* A character was retrieved from the queue so can be sent to the\r
 253                         THR now. */\r
 254                         UART0->TxBUFR = cChar;\r
 255                 }\r
 256                 else\r
 257                 {\r
 258                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 259                         serINTERRUPT_OFF();\r
 260                 }               \r
 261         }\r
 262 \r
 263         if( usStatus &  UART_RxBufFull )\r
 264         {\r
 265                 /* The interrupt was caused by a character being received.  Grab the\r
 266                 character from the RHR and place it in the queue of received\r
 267                 characters. */\r
 268                 cChar = UART0->RxBUFR;\r
 269                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 270         }\r
 271 \r
 272         /* If a task was woken by either a character being received or a character\r
 273         being transmitted then we may need to switch to another task. */\r
 274         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 275 \r
 276         /* End the interrupt in the EIC. */\r
 277         portCLEAR_EIC();\r
 278 }\r
 279 \r
 280 \r
 281 \r
 282 \r
 283 \r
 284         \r