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

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