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

   1 /*\r
   2         FreeRTOS V5.4.2 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 /*\r
  49         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.\r
  50 */\r
  51 \r
  52 /* Library includes. */\r
  53 #include "uart.h"\r
  54 #include "gpio.h"\r
  55 #include "eic.h"\r
  56 \r
  57 /* Scheduler includes. */\r
  58 #include "FreeRTOS.h"\r
  59 #include "queue.h"\r
  60 \r
  61 /* Demo application includes. */\r
  62 #include "serial.h"\r
  63 \r
  64 #define UART0_Rx_Pin                                    ( 0x0001<< 8 )\r
  65 #define UART0_Tx_Pin                                    ( 0x0001<< 9 )\r
  66 \r
  67 #define serINVALID_QUEUE                                ( ( xQueueHandle ) 0 )\r
  68 #define serNO_BLOCK                                             ( ( portTickType ) 0 )\r
  69 \r
  70 /* Macros to turn on and off the Tx empty interrupt. */\r
  71 #define serINTERRUPT_ON()                               UART0->IER |= UART_TxHalfEmpty\r
  72 #define serINTERRUPT_OFF()                              UART0->IER &= ~UART_TxHalfEmpty\r
  73 \r
  74 /*-----------------------------------------------------------*/\r
  75 \r
  76 /* Queues used to hold received characters, and characters waiting to be\r
  77 transmitted. */\r
  78 static xQueueHandle xRxedChars;\r
  79 static xQueueHandle xCharsForTx;\r
  80 \r
  81 /*-----------------------------------------------------------*/\r
  82 \r
  83 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
  84 extern void vSerialISREntry( void );\r
  85 \r
  86 /* The interrupt service routine - called from the assembly entry point. */\r
  87 __arm void vSerialISR( void );\r
  88 \r
  89 /*-----------------------------------------------------------*/\r
  90 \r
  91 /*\r
  92  * See the serial2.h header file.\r
  93  */\r
  94 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
  95 {\r
  96 xComPortHandle xReturn;\r
  97         \r
  98         /* Create the queues used to hold Rx and Tx characters. */\r
  99         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 100         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed portCHAR ) );\r
 101 \r
 102         /* If the queues were created correctly then setup the serial port\r
 103         hardware. */\r
 104         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 105         {\r
 106                 portENTER_CRITICAL();\r
 107                 {\r
 108                         /* Setup the UART port pins. */\r
 109                         GPIO_Config( GPIO0, UART0_Tx_Pin, GPIO_AF_PP );\r
 110                         GPIO_Config( GPIO0, UART0_Rx_Pin, GPIO_IN_TRI_CMOS );\r
 111 \r
 112                         /* Configure the UART. */\r
 113                         UART_OnOffConfig( UART0, ENABLE );\r
 114                         UART_FifoConfig( UART0, DISABLE );\r
 115                         UART_FifoReset( UART0, UART_RxFIFO );\r
 116                         UART_FifoReset( UART0, UART_TxFIFO );\r
 117                         UART_LoopBackConfig(UART0, DISABLE );\r
 118                         UART_Config( UART0, ulWantedBaud, UART_NO_PARITY, UART_1_StopBits, UARTM_8D );\r
 119                         UART_RxConfig( UART0, ENABLE );\r
 120 \r
 121                         /* Configure the IEC for the UART interrupts. */\r
 122                         EIC_IRQChannelPriorityConfig( UART0_IRQChannel, 1 );\r
 123                         EIC_IRQChannelConfig( UART0_IRQChannel, ENABLE );\r
 124                         EIC_IRQConfig( ENABLE );\r
 125                         UART_ItConfig( UART0, UART_RxBufFull, ENABLE );\r
 126                 }\r
 127                 portEXIT_CRITICAL();\r
 128         }\r
 129         else\r
 130         {\r
 131                 xReturn = ( xComPortHandle ) 0;\r
 132         }\r
 133 \r
 134         /* This demo file only supports a single port but we have to return\r
 135         something to comply with the standard demo header file. */\r
 136         return xReturn;\r
 137 }\r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 141 {\r
 142         /* The port handle is not required as this driver only supports one port. */\r
 143         ( void ) pxPort;\r
 144 \r
 145         /* Get the next character from the buffer.  Return false if no characters\r
 146         are available, or arrive before xBlockTime expires. */\r
 147         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 148         {\r
 149                 return pdTRUE;\r
 150         }\r
 151         else\r
 152         {\r
 153                 return pdFALSE;\r
 154         }\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 159 {\r
 160 signed portCHAR *pxNext;\r
 161 \r
 162         /* A couple of parameters that this port does not use. */\r
 163         ( void ) usStringLength;\r
 164         ( void ) pxPort;\r
 165 \r
 166         /* NOTE: This implementation does not handle the queue being full as no\r
 167         block time is used! */\r
 168 \r
 169         /* The port handle is not required as this driver only supports UART0. */\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* Send each character in the string, one at a time. */\r
 173         pxNext = ( signed portCHAR * ) pcString;\r
 174         while( *pxNext )\r
 175         {\r
 176                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 177                 pxNext++;\r
 178         }\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 183 {\r
 184         /* Place the character in the queue of characters to be transmitted. */\r
 185         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 186         {\r
 187                 return pdFAIL;\r
 188         }\r
 189 \r
 190         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 191         queue and send it.   This does not need to be in a critical section as\r
 192         if the interrupt has already removed the character the next interrupt\r
 193         will simply turn off the Tx interrupt again. */\r
 194         serINTERRUPT_ON();\r
 195 \r
 196         return pdPASS;\r
 197 }\r
 198 /*-----------------------------------------------------------*/\r
 199 \r
 200 void vSerialClose( xComPortHandle xPort )\r
 201 {\r
 202         /* Not supported as not required by the demo application. */\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 207 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 208 within serialISR.s79 which in turn calls this function.  See the port\r
 209 documentation on the FreeRTOS.org website for more information. */\r
 210 __arm void vSerialISR( void )\r
 211 {\r
 212 unsigned portSHORT usStatus;\r
 213 signed portCHAR cChar;\r
 214 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 215 \r
 216         /* What caused the interrupt? */\r
 217         usStatus = UART_FlagStatus( UART0 );\r
 218 \r
 219         if( usStatus & UART_TxHalfEmpty )\r
 220         {\r
 221                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 222                 more characters to transmit? */\r
 223                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 224                 {\r
 225                         /* A character was retrieved from the queue so can be sent to the\r
 226                         THR now. */\r
 227                         UART0->TxBUFR = cChar;\r
 228                 }\r
 229                 else\r
 230                 {\r
 231                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 232                         serINTERRUPT_OFF();\r
 233                 }               \r
 234         }\r
 235 \r
 236         if( usStatus &  UART_RxBufFull )\r
 237         {\r
 238                 /* The interrupt was caused by a character being received.  Grab the\r
 239                 character from the RHR and place it in the queue of received\r
 240                 characters. */\r
 241                 cChar = UART0->RxBUFR;\r
 242                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 243         }\r
 244 \r
 245         /* If a task was woken by either a character being received or a character\r
 246         being transmitted then we may need to switch to another task. */\r
 247         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 248 \r
 249         /* End the interrupt in the EIC. */\r
 250         portCLEAR_EIC();\r
 251 }\r
 252 \r
 253 \r
 254 \r
 255 \r
 256 \r
 257         \r