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

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