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

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