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

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