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

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /*\r
  68         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  69 */\r
  70 \r
  71 /* Library includes. */\r
  72 #include "uart.h"\r
  73 #include "gpio.h"\r
  74 #include "eic.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 #define UART0_Rx_Pin                                    ( 0x0001<< 8 )\r
  84 #define UART0_Tx_Pin                                    ( 0x0001<< 9 )\r
  85 \r
  86 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  87 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  88 \r
  89 /* Macros to turn on and off the Tx empty interrupt. */\r
  90 #define serINTERRUPT_ON()                               UART0->IER |= UART_TxHalfEmpty\r
  91 #define serINTERRUPT_OFF()                              UART0->IER &= ~UART_TxHalfEmpty\r
  92 \r
  93 /*-----------------------------------------------------------*/\r
  94 \r
  95 /* Queues used to hold received characters, and characters waiting to be\r
  96 transmitted. */\r
  97 static xQueueHandle xRxedChars;\r
  98 static xQueueHandle xCharsForTx;\r
  99 \r
 100 /*-----------------------------------------------------------*/\r
 101 \r
 102 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
 103 extern void vSerialISREntry( void );\r
 104 \r
 105 /* The interrupt service routine - called from the assembly entry point. */\r
 106 __arm void vSerialISR( void );\r
 107 \r
 108 /*-----------------------------------------------------------*/\r
 109 \r
 110 /*\r
 111  * See the serial2.h header file.\r
 112  */\r
 113 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 114 {\r
 115 xComPortHandle xReturn;\r
 116         \r
 117         /* Create the queues used to hold Rx and Tx characters. */\r
 118         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 119         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 120 \r
 121         /* If the queues were created correctly then setup the serial port\r
 122         hardware. */\r
 123         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 124         {\r
 125                 portENTER_CRITICAL();\r
 126                 {\r
 127                         /* Setup the UART port pins. */\r
 128                         GPIO_Config( GPIO0, UART0_Tx_Pin, GPIO_AF_PP );\r
 129                         GPIO_Config( GPIO0, UART0_Rx_Pin, GPIO_IN_TRI_CMOS );\r
 130 \r
 131                         /* Configure the UART. */\r
 132                         UART_OnOffConfig( UART0, ENABLE );\r
 133                         UART_FifoConfig( UART0, DISABLE );\r
 134                         UART_FifoReset( UART0, UART_RxFIFO );\r
 135                         UART_FifoReset( UART0, UART_TxFIFO );\r
 136                         UART_LoopBackConfig(UART0, DISABLE );\r
 137                         UART_Config( UART0, ulWantedBaud, UART_NO_PARITY, UART_1_StopBits, UARTM_8D );\r
 138                         UART_RxConfig( UART0, ENABLE );\r
 139 \r
 140                         /* Configure the IEC for the UART interrupts. */\r
 141                         EIC_IRQChannelPriorityConfig( UART0_IRQChannel, 1 );\r
 142                         EIC_IRQChannelConfig( UART0_IRQChannel, ENABLE );\r
 143                         EIC_IRQConfig( ENABLE );\r
 144                         UART_ItConfig( UART0, UART_RxBufFull, ENABLE );\r
 145                 }\r
 146                 portEXIT_CRITICAL();\r
 147         }\r
 148         else\r
 149         {\r
 150                 xReturn = ( xComPortHandle ) 0;\r
 151         }\r
 152 \r
 153         /* This demo file only supports a single port but we have to return\r
 154         something to comply with the standard demo header file. */\r
 155         return xReturn;\r
 156 }\r
 157 /*-----------------------------------------------------------*/\r
 158 \r
 159 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 160 {\r
 161         /* The port handle is not required as this driver only supports one port. */\r
 162         ( void ) pxPort;\r
 163 \r
 164         /* Get the next character from the buffer.  Return false if no characters\r
 165         are available, or arrive before xBlockTime expires. */\r
 166         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 167         {\r
 168                 return pdTRUE;\r
 169         }\r
 170         else\r
 171         {\r
 172                 return pdFALSE;\r
 173         }\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 178 {\r
 179 signed char *pxNext;\r
 180 \r
 181         /* A couple of parameters that this port does not use. */\r
 182         ( void ) usStringLength;\r
 183         ( void ) pxPort;\r
 184 \r
 185         /* NOTE: This implementation does not handle the queue being full as no\r
 186         block time is used! */\r
 187 \r
 188         /* The port handle is not required as this driver only supports UART0. */\r
 189         ( void ) pxPort;\r
 190 \r
 191         /* Send each character in the string, one at a time. */\r
 192         pxNext = ( signed char * ) pcString;\r
 193         while( *pxNext )\r
 194         {\r
 195                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 196                 pxNext++;\r
 197         }\r
 198 }\r
 199 /*-----------------------------------------------------------*/\r
 200 \r
 201 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 202 {\r
 203         /* Place the character in the queue of characters to be transmitted. */\r
 204         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 205         {\r
 206                 return pdFAIL;\r
 207         }\r
 208 \r
 209         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 210         queue and send it.   This does not need to be in a critical section as\r
 211         if the interrupt has already removed the character the next interrupt\r
 212         will simply turn off the Tx interrupt again. */\r
 213         serINTERRUPT_ON();\r
 214 \r
 215         return pdPASS;\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 void vSerialClose( xComPortHandle xPort )\r
 220 {\r
 221         /* Not supported as not required by the demo application. */\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 226 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 227 within serialISR.s79 which in turn calls this function.  See the port\r
 228 documentation on the FreeRTOS.org website for more information. */\r
 229 __arm void vSerialISR( void )\r
 230 {\r
 231 unsigned short usStatus;\r
 232 signed char cChar;\r
 233 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 234 \r
 235         /* What caused the interrupt? */\r
 236         usStatus = UART_FlagStatus( UART0 );\r
 237 \r
 238         if( usStatus & UART_TxHalfEmpty )\r
 239         {\r
 240                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 241                 more characters to transmit? */\r
 242                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 243                 {\r
 244                         /* A character was retrieved from the queue so can be sent to the\r
 245                         THR now. */\r
 246                         UART0->TxBUFR = cChar;\r
 247                 }\r
 248                 else\r
 249                 {\r
 250                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 251                         serINTERRUPT_OFF();\r
 252                 }               \r
 253         }\r
 254 \r
 255         if( usStatus &  UART_RxBufFull )\r
 256         {\r
 257                 /* The interrupt was caused by a character being received.  Grab the\r
 258                 character from the RHR and place it in the queue of received\r
 259                 characters. */\r
 260                 cChar = UART0->RxBUFR;\r
 261                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 262         }\r
 263 \r
 264         /* If a task was woken by either a character being received or a character\r
 265         being transmitted then we may need to switch to another task. */\r
 266         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 267 \r
 268         /* End the interrupt in the EIC. */\r
 269         portCLEAR_EIC();\r
 270 }\r
 271 \r
 272 \r
 273 \r
 274 \r
 275 \r
 276         \r