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

   1 /*\r
   2     FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32 \r
  33     >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to\r
  34     distribute a combined work that includes FreeRTOS without being obliged to\r
  35     provide the source code for proprietary components outside of the FreeRTOS\r
  36     kernel.\r
  37 \r
  38     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  39     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  40     FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\r
  41     details. You should have received a copy of the GNU General Public License\r
  42     and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
  43     viewed here: http://www.freertos.org/a00114.html and also obtained by\r
  44     writing to Real Time Engineers Ltd., contact details for whom are available\r
  45     on the FreeRTOS WEB site.\r
  46 \r
  47     1 tab == 4 spaces!\r
  48 \r
  49     ***************************************************************************\r
  50      *                                                                       *\r
  51      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  52      *    not run, what could be wrong?"                                     *\r
  53      *                                                                       *\r
  54      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  55      *                                                                       *\r
  56     ***************************************************************************\r
  57 \r
  58 \r
  59     http://www.FreeRTOS.org - Documentation, books, training, latest versions, \r
  60     license and Real Time Engineers Ltd. contact details.\r
  61 \r
  62     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  63     including FreeRTOS+Trace - an indispensable productivity tool, and our new\r
  64     fully thread aware and reentrant UDP/IP stack.\r
  65 \r
  66     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
  67     Integrity Systems, who sell the code with commercial support, \r
  68     indemnification and middleware, under the OpenRTOS brand.\r
  69     \r
  70     http://www.SafeRTOS.com - High Integrity Systems also provide a safety \r
  71     engineered and independently SIL3 certified version for use in safety and \r
  72     mission critical applications that require provable dependability.\r
  73 */\r
  74 \r
  75 /* \r
  76         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR USART0. \r
  77 \r
  78         This file contains all the serial port components that can be compiled to\r
  79         either ARM or THUMB mode.  Components that must be compiled to ARM mode are\r
  80         contained in serialISR.c.\r
  81 */\r
  82 \r
  83 /* Standard includes. */\r
  84 #include <stdlib.h>\r
  85 \r
  86 /* Scheduler includes. */\r
  87 #include "FreeRTOS.h"\r
  88 #include "queue.h"\r
  89 #include "task.h"\r
  90 \r
  91 /* Demo application includes. */\r
  92 #include "serial.h"\r
  93 #include "AT91R40008.h"\r
  94 #include "usart.h"\r
  95 #include "pio.h"\r
  96 #include "aic.h"\r
  97 \r
  98 /*-----------------------------------------------------------*/\r
  99 \r
 100 /* Constants to setup and access the UART. */\r
 101 #define portUSART0_AIC_CHANNEL  ( ( unsigned long ) 2 )\r
 102 \r
 103 #define serINVALID_QUEUE                ( ( xQueueHandle ) 0 )\r
 104 #define serHANDLE                               ( ( xComPortHandle ) 1 )\r
 105 #define serNO_BLOCK                             ( ( portTickType ) 0 )\r
 106 \r
 107 /*-----------------------------------------------------------*/\r
 108 \r
 109 /* Queues used to hold received characters, and characters waiting to be\r
 110 transmitted. */\r
 111 static xQueueHandle xRxedChars; \r
 112 static xQueueHandle xCharsForTx; \r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 /* \r
 117  * The queues are created in serialISR.c as they are used from the ISR.\r
 118  * Obtain references to the queues and THRE Empty flag. \r
 119  */\r
 120 extern void vSerialISRCreateQueues(  unsigned portBASE_TYPE uxQueueLength, xQueueHandle *pxRxedChars, xQueueHandle *pxCharsForTx );\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 125 {\r
 126 unsigned long ulSpeed;\r
 127 unsigned long ulCD;\r
 128 xComPortHandle xReturn = serHANDLE;\r
 129 extern void ( vUART_ISR_Wrapper )( void );\r
 130 \r
 131         /* The queues are used in the serial ISR routine, so are created from\r
 132         serialISR.c (which is always compiled to ARM mode. */\r
 133         vSerialISRCreateQueues( uxQueueLength, &xRxedChars, &xCharsForTx );\r
 134 \r
 135         if( \r
 136                 ( xRxedChars != serINVALID_QUEUE ) && \r
 137                 ( xCharsForTx != serINVALID_QUEUE ) && \r
 138                 ( ulWantedBaud != ( unsigned long ) 0 ) \r
 139           )\r
 140         {\r
 141                 portENTER_CRITICAL();\r
 142                 {\r
 143                         /* Enable clock to USART0... */\r
 144                         AT91C_BASE_PS->PS_PCER = AT91C_PS_US0;\r
 145 \r
 146                         /* Disable all USART0 interrupt sources to begin... */\r
 147                         AT91C_BASE_US0->US_IDR = 0xFFFFFFFF;\r
 148 \r
 149                         /* Reset various status bits (just in case)... */\r
 150                         AT91C_BASE_US0->US_CR = US_RSTSTA;\r
 151 \r
 152                         AT91C_BASE_PIO->PIO_PDR = TXD0 | RXD0;  /* Enable RXD and TXD pins */\r
 153                         AT91C_BASE_US0->US_CR = US_RSTRX | US_RSTTX | US_RXDIS | US_TXDIS;\r
 154 \r
 155                         /* Clear Transmit and Receive Counters */\r
 156                         AT91C_BASE_US0->US_RCR = 0;\r
 157                         AT91C_BASE_US0->US_TCR = 0;\r
 158 \r
 159                         /* Input clock to baud rate generator is MCK */\r
 160                         ulSpeed = configCPU_CLOCK_HZ * 10;  \r
 161                         ulSpeed = ulSpeed / 16;\r
 162                         ulSpeed = ulSpeed / ulWantedBaud;\r
 163                         \r
 164                         /* compute the error */\r
 165                         ulCD  = ulSpeed / 10;\r
 166                         if ((ulSpeed - (ulCD * 10)) >= 5)\r
 167                         ulCD++;\r
 168 \r
 169                         /* Define the baud rate divisor register */\r
 170                         AT91C_BASE_US0->US_BRGR = ulCD;\r
 171 \r
 172                         /* Define the USART mode */\r
 173                         AT91C_BASE_US0->US_MR = US_CLKS_MCK | US_CHRL_8 | US_PAR_NO | US_NBSTOP_1 | US_CHMODE_NORMAL;\r
 174 \r
 175                         /* Write the Timeguard Register */\r
 176                         AT91C_BASE_US0->US_TTGR = 0;\r
 177 \r
 178                         /* Setup the interrupt for USART0.\r
 179 \r
 180                         Store interrupt handler function address in USART0 vector register... */\r
 181                         AT91C_BASE_AIC->AIC_SVR[ portUSART0_AIC_CHANNEL ] = (unsigned long)vUART_ISR_Wrapper;\r
 182                         \r
 183                         /* USART0 interrupt level-sensitive, priority 1... */\r
 184                         AT91C_BASE_AIC->AIC_SMR[ portUSART0_AIC_CHANNEL ] = AIC_SRCTYPE_INT_LEVEL_SENSITIVE | 1;\r
 185                         \r
 186                         /* Clear some pending USART0 interrupts (just in case)... */\r
 187                         AT91C_BASE_US0->US_CR = US_RSTSTA;\r
 188 \r
 189                         /* Enable USART0 interrupt sources (but not Tx for now)... */\r
 190                         AT91C_BASE_US0->US_IER = US_RXRDY;\r
 191 \r
 192                         /* Enable USART0 interrupts in the AIC... */\r
 193                         AT91C_BASE_AIC->AIC_IECR = ( 1 << portUSART0_AIC_CHANNEL );\r
 194 \r
 195                         /* Enable receiver and transmitter... */\r
 196                         AT91C_BASE_US0->US_CR = US_RXEN | US_TXEN;\r
 197                 }\r
 198                 portEXIT_CRITICAL();\r
 199         }\r
 200         else\r
 201         {\r
 202                 xReturn = ( xComPortHandle ) 0;\r
 203         }\r
 204 \r
 205         return xReturn;\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, portTickType xBlockTime )\r
 210 {\r
 211         /* The port handle is not required as this driver only supports UART0. */\r
 212         ( void ) pxPort;\r
 213 \r
 214         /* Get the next character from the buffer.  Return false if no characters\r
 215         are available, or arrive before xBlockTime expires. */\r
 216         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 217         {\r
 218                 return pdTRUE;\r
 219         }\r
 220         else\r
 221         {\r
 222                 return pdFALSE;\r
 223         }\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 228 {\r
 229 signed char *pxNext;\r
 230 \r
 231         /* NOTE: This implementation does not handle the queue being full as no\r
 232         block time is used! */\r
 233 \r
 234         /* The port handle is not required as this driver only supports UART0. */\r
 235         ( void ) pxPort;\r
 236         ( void ) usStringLength;\r
 237 \r
 238         /* Send each character in the string, one at a time. */\r
 239         pxNext = ( signed char * ) pcString;\r
 240         while( *pxNext )\r
 241         {\r
 242                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 243                 pxNext++;\r
 244         }\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, portTickType xBlockTime )\r
 249 {\r
 250         ( void ) pxPort;\r
 251 \r
 252         /* Place the character in the queue of characters to be transmitted. */\r
 253         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 254         {\r
 255                 return pdFAIL;\r
 256         }\r
 257 \r
 258         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 259         queue and send it.   This does not need to be in a critical section as\r
 260         if the interrupt has already removed the character the next interrupt\r
 261         will simply turn off the Tx interrupt again. */\r
 262         AT91C_BASE_US0->US_IER = US_TXRDY;\r
 263 \r
 264         return pdPASS;\r
 265 }\r
 266 /*-----------------------------------------------------------*/\r
 267 \r
 268 void vSerialClose( xComPortHandle xPort )\r
 269 {\r
 270         /* Not supported as not required by the demo application. */\r
 271         ( void ) xPort;\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r