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

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