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

   1 /*\r
   2         FreeRTOS.org V5.3.1 - Copyright (C) 2003-2009 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 it\r
   7         under the terms of the GNU General Public License (version 2) as published\r
   8         by the 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.org without being obliged to provide\r
  11         the source code for any proprietary components.  Alternative commercial\r
  12         license and support terms are also available upon request.  See the \r
  13         licensing section of http://www.FreeRTOS.org for full details.\r
  14 \r
  15         FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT\r
  16         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  17         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  18         more details.\r
  19 \r
  20         You should have received a copy of the GNU General Public License along\r
  21         with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59\r
  22         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  23 \r
  24 \r
  25         ***************************************************************************\r
  26         *                                                                         *\r
  27         * Get the FreeRTOS eBook!  See http://www.FreeRTOS.org/Documentation      *\r
  28         *                                                                         *\r
  29         * This is a concise, step by step, 'hands on' guide that describes both   *\r
  30         * general multitasking concepts and FreeRTOS specifics. It presents and   *\r
  31         * explains numerous examples that are written using the FreeRTOS API.     *\r
  32         * Full source code for all the examples is provided in an accompanying    *\r
  33         * .zip file.                                                              *\r
  34         *                                                                         *\r
  35         ***************************************************************************\r
  36 \r
  37         1 tab == 4 spaces!\r
  38 \r
  39         Please ensure to read the configuration and relevant port sections of the\r
  40         online documentation.\r
  41 \r
  42         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  43         contact details.\r
  44 \r
  45         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  46         critical systems.\r
  47 \r
  48         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  49         licensing and training services.\r
  50 */\r
  51 \r
  52 /* \r
  53         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR USART0. \r
  54 \r
  55         This file contains all the serial port components that can be compiled to\r
  56         either ARM or THUMB mode.  Components that must be compiled to ARM mode are\r
  57         contained in serialISR.c.\r
  58 */\r
  59 \r
  60 /* Standard includes. */\r
  61 #include <stdlib.h>\r
  62 \r
  63 /* Scheduler includes. */\r
  64 #include "FreeRTOS.h"\r
  65 #include "queue.h"\r
  66 #include "task.h"\r
  67 \r
  68 /* Demo application includes. */\r
  69 #include "serial.h"\r
  70 #include "AT91R40008.h"\r
  71 #include "usart.h"\r
  72 #include "pio.h"\r
  73 #include "aic.h"\r
  74 \r
  75 /*-----------------------------------------------------------*/\r
  76 \r
  77 /* Constants to setup and access the UART. */\r
  78 #define portUSART0_AIC_CHANNEL  ( ( unsigned portLONG ) 2 )\r
  79 \r
  80 #define serINVALID_QUEUE                ( ( xQueueHandle ) 0 )\r
  81 #define serHANDLE                               ( ( xComPortHandle ) 1 )\r
  82 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
  83 \r
  84 /*-----------------------------------------------------------*/\r
  85 \r
  86 /* Queues used to hold received characters, and characters waiting to be\r
  87 transmitted. */\r
  88 static xQueueHandle xRxedChars; \r
  89 static xQueueHandle xCharsForTx; \r
  90 \r
  91 /*-----------------------------------------------------------*/\r
  92 \r
  93 /* \r
  94  * The queues are created in serialISR.c as they are used from the ISR.\r
  95  * Obtain references to the queues and THRE Empty flag. \r
  96  */\r
  97 extern void vSerialISRCreateQueues(  unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxRxedChars, xQueueHandle *pxCharsForTx );\r
  98 \r
  99 /*-----------------------------------------------------------*/\r
 100 \r
 101 xComPortHandle xSerialPortInitMinimal( unsigned portLONG ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 102 {\r
 103 unsigned portLONG ulSpeed;\r
 104 unsigned portLONG ulCD;\r
 105 xComPortHandle xReturn = serHANDLE;\r
 106 extern void ( vUART_ISR_Wrapper )( void );\r
 107 \r
 108         /* The queues are used in the serial ISR routine, so are created from\r
 109         serialISR.c (which is always compiled to ARM mode. */\r
 110         vSerialISRCreateQueues( uxQueueLength, &xRxedChars, &xCharsForTx );\r
 111 \r
 112         if( \r
 113                 ( xRxedChars != serINVALID_QUEUE ) && \r
 114                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 115                 ( ulWantedBaud != ( unsigned portLONG ) 0 ) \r
 116           )\r
 117         {\r
 118                 portENTER_CRITICAL();\r
 119                 {\r
 120                         /* Enable clock to USART0... */\r
 121                         AT91C_BASE_PS->PS_PCER = AT91C_PS_US0;\r
 122 \r
 123                         /* Disable all USART0 interrupt sources to begin... */\r
 124                         AT91C_BASE_US0->US_IDR = 0xFFFFFFFF;\r
 125 \r
 126                         /* Reset various status bits (just in case)... */\r
 127                         AT91C_BASE_US0->US_CR = US_RSTSTA;\r
 128 \r
 129                         AT91C_BASE_PIO->PIO_PDR = TXD0 | RXD0;  /* Enable RXD and TXD pins */\r
 130                         AT91C_BASE_US0->US_CR = US_RSTRX | US_RSTTX | US_RXDIS | US_TXDIS;\r
 131 \r
 132                         /* Clear Transmit and Receive Counters */\r
 133                         AT91C_BASE_US0->US_RCR = 0;\r
 134                         AT91C_BASE_US0->US_TCR = 0;\r
 135 \r
 136                         /* Input clock to baud rate generator is MCK */\r
 137                         ulSpeed = configCPU_CLOCK_HZ * 10;  \r
 138                         ulSpeed = ulSpeed / 16;\r
 139                         ulSpeed = ulSpeed / ulWantedBaud;\r
 140                         \r
 141                         /* compute the error */\r
 142                         ulCD  = ulSpeed / 10;\r
 143                         if ((ulSpeed - (ulCD * 10)) >= 5)\r
 144                         ulCD++;\r
 145 \r
 146                         /* Define the baud rate divisor register */\r
 147                         AT91C_BASE_US0->US_BRGR = ulCD;\r
 148 \r
 149                         /* Define the USART mode */\r
 150                         AT91C_BASE_US0->US_MR = US_CLKS_MCK | US_CHRL_8 | US_PAR_NO | US_NBSTOP_1 | US_CHMODE_NORMAL;\r
 151 \r
 152                         /* Write the Timeguard Register */\r
 153                         AT91C_BASE_US0->US_TTGR = 0;\r
 154 \r
 155                         /* Setup the interrupt for USART0.\r
 156 \r
 157                         Store interrupt handler function address in USART0 vector register... */\r
 158                         AT91C_BASE_AIC->AIC_SVR[ portUSART0_AIC_CHANNEL ] = (unsigned long)vUART_ISR_Wrapper;\r
 159                         \r
 160                         /* USART0 interrupt level-sensitive, priority 1... */\r
 161                         AT91C_BASE_AIC->AIC_SMR[ portUSART0_AIC_CHANNEL ] = AIC_SRCTYPE_INT_LEVEL_SENSITIVE | 1;\r
 162                         \r
 163                         /* Clear some pending USART0 interrupts (just in case)... */\r
 164                         AT91C_BASE_US0->US_CR = US_RSTSTA;\r
 165 \r
 166                         /* Enable USART0 interrupt sources (but not Tx for now)... */\r
 167                         AT91C_BASE_US0->US_IER = US_RXRDY;\r
 168 \r
 169                         /* Enable USART0 interrupts in the AIC... */\r
 170                         AT91C_BASE_AIC->AIC_IECR = ( 1 << portUSART0_AIC_CHANNEL );\r
 171 \r
 172                         /* Enable receiver and transmitter... */\r
 173                         AT91C_BASE_US0->US_CR = US_RXEN | US_TXEN;\r
 174                 }\r
 175                 portEXIT_CRITICAL();\r
 176         }\r
 177         else\r
 178         {\r
 179                 xReturn = ( xComPortHandle ) 0;\r
 180         }\r
 181 \r
 182         return xReturn;\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed portCHAR *pcRxedChar, portTickType xBlockTime )\r
 187 {\r
 188         /* The port handle is not required as this driver only supports UART0. */\r
 189         ( void ) pxPort;\r
 190 \r
 191         /* Get the next character from the buffer.  Return false if no characters\r
 192         are available, or arrive before xBlockTime expires. */\r
 193         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 194         {\r
 195                 return pdTRUE;\r
 196         }\r
 197         else\r
 198         {\r
 199                 return pdFALSE;\r
 200         }\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 void vSerialPutString( xComPortHandle pxPort, const signed portCHAR * const pcString, unsigned portSHORT usStringLength )\r
 205 {\r
 206 signed portCHAR *pxNext;\r
 207 \r
 208         /* NOTE: This implementation does not handle the queue being full as no\r
 209         block time is used! */\r
 210 \r
 211         /* The port handle is not required as this driver only supports UART0. */\r
 212         ( void ) pxPort;\r
 213 \r
 214         /* Send each character in the string, one at a time. */\r
 215         pxNext = ( signed portCHAR * ) pcString;\r
 216         while( *pxNext )\r
 217         {\r
 218                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 219                 pxNext++;\r
 220         }\r
 221 }\r
 222 /*-----------------------------------------------------------*/\r
 223 \r
 224 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed portCHAR cOutChar, portTickType xBlockTime )\r
 225 {\r
 226         /* Place the character in the queue of characters to be transmitted. */\r
 227         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 228         {\r
 229                 return pdFAIL;\r
 230         }\r
 231 \r
 232         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 233         queue and send it.   This does not need to be in a critical section as\r
 234         if the interrupt has already removed the character the next interrupt\r
 235         will simply turn off the Tx interrupt again. */\r
 236         AT91C_BASE_US0->US_IER = US_TXRDY;\r
 237 \r
 238         return pdPASS;\r
 239 }\r
 240 /*-----------------------------------------------------------*/\r
 241 \r
 242 void vSerialClose( xComPortHandle xPort )\r
 243 {\r
 244         /* Not supported as not required by the demo application. */\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r