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

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