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

   1 /*\r
   2     FreeRTOS V8.2.3 - Copyright (C) 2015 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     This file is part of the FreeRTOS distribution.\r
   8 \r
   9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  10     the terms of the GNU General Public License (version 2) as published by the\r
  11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
  12 \r
  13     ***************************************************************************\r
  14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  16     >>!   obliged to provide the source code for proprietary components     !<<\r
  17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  18     ***************************************************************************\r
  19 \r
  20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  23     link: http://www.freertos.org/a00114.html\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    FreeRTOS provides completely free yet professionally developed,    *\r
  28      *    robust, strictly quality controlled, supported, and cross          *\r
  29      *    platform software that is more than just the market leader, it     *\r
  30      *    is the industry's de facto standard.                               *\r
  31      *                                                                       *\r
  32      *    Help yourself get started quickly while simultaneously helping     *\r
  33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  34      *    tutorial book, reference manual, or both:                          *\r
  35      *    http://www.FreeRTOS.org/Documentation                              *\r
  36      *                                                                       *\r
  37     ***************************************************************************\r
  38 \r
  39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
  40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
  41     defined configASSERT()?\r
  42 \r
  43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
  44     embedded software for free we request you assist our global community by\r
  45     participating in the support forum.\r
  46 \r
  47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
  48     be as productive as possible as early as possible.  Now you can receive\r
  49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
  50     Ltd, and the world's leading authority on the world's leading RTOS.\r
  51 \r
  52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  55 \r
  56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  58 \r
  59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
  60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  61     licenses offer ticketed support, indemnification and commercial middleware.\r
  62 \r
  63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  64     engineered and independently SIL3 certified version for use in safety and\r
  65     mission critical applications that require provable dependability.\r
  66 \r
  67     1 tab == 4 spaces!\r
  68 */\r
  69 \r
  70 /* \r
  71         BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0. \r
  72 */\r
  73 \r
  74 /* Standard includes. */ \r
  75 #include <stdlib.h>\r
  76 \r
  77 /* Scheduler includes. */\r
  78 #include "FreeRTOS.h"\r
  79 #include "queue.h"\r
  80 \r
  81 /* Demo application includes. */\r
  82 #include "serial.h"\r
  83 \r
  84 /*-----------------------------------------------------------*/\r
  85 \r
  86 /* Location of the COM0 registers. */\r
  87 #define serCOM0                                                 ( ( AT91PS_USART ) AT91C_BASE_US0 )\r
  88 \r
  89 /* Interrupt control macros. */\r
  90 #define serINTERRUPT_LEVEL                              ( 5 )\r
  91 #define vInterruptOn()                                  AT91F_US_EnableIt( serCOM0, AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  92 #define vInterruptOff()                                 AT91F_US_DisableIt( serCOM0, AT91C_US_TXRDY )\r
  93 \r
  94 /* Misc constants. */\r
  95 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  96 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
  97 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
  98 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
  99 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
 100 \r
 101 \r
 102 /* Queues used to hold received characters, and characters waiting to be\r
 103 transmitted. */\r
 104 static QueueHandle_t xRxedChars; \r
 105 static QueueHandle_t xCharsForTx; \r
 106 \r
 107 /*-----------------------------------------------------------*/\r
 108 \r
 109 /* Interrupt entry point written in the assembler file serialISR.s79. */\r
 110 extern void vSerialISREntry( void );\r
 111 \r
 112 /* The interrupt service routine - called from the assembly entry point. */\r
 113 __arm void vSerialISR( void );\r
 114 \r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 /*\r
 118  * See the serial2.h header file.\r
 119  */\r
 120 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )\r
 121 {\r
 122 xComPortHandle xReturn = serHANDLE;\r
 123 extern void ( vUART_ISR )( void );\r
 124 \r
 125         /* Create the queues used to hold Rx and Tx characters. */\r
 126         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 127         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 128 \r
 129         /* If the queues were created correctly then setup the serial port \r
 130         hardware. */\r
 131         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 132         {\r
 133                 portENTER_CRITICAL();\r
 134                 {\r
 135                         /* Enable the USART clock. */\r
 136                         AT91F_PMC_EnablePeriphClock( AT91C_BASE_PMC, 1 << AT91C_ID_US0 );\r
 137 \r
 138                         AT91F_PIO_CfgPeriph( AT91C_BASE_PIOA, ( ( unsigned long ) AT91C_PA5_RXD0 ) | ( ( unsigned long ) AT91C_PA6_TXD0 ), serNO_PERIPHERAL_B_SETUP );\r
 139 \r
 140                         /* Set the required protocol. */\r
 141                         AT91F_US_Configure( serCOM0, configCPU_CLOCK_HZ, AT91C_US_ASYNC_MODE, ulWantedBaud, serNO_TIMEGUARD );\r
 142 \r
 143                         /* Enable Rx and Tx. */\r
 144                         serCOM0->US_CR = AT91C_US_RXEN | AT91C_US_TXEN;\r
 145 \r
 146                         /* Enable the Rx interrupts.  The Tx interrupts are not enabled\r
 147                         until there are characters to be transmitted. */\r
 148                 AT91F_US_EnableIt( serCOM0, AT91C_US_RXRDY );\r
 149 \r
 150                         /* Enable the interrupts in the AIC. */\r
 151                         AT91F_AIC_ConfigureIt( AT91C_BASE_AIC, AT91C_ID_US0, serINTERRUPT_LEVEL, AT91C_AIC_SRCTYPE_INT_LEVEL_SENSITIVE, ( void (*)( void ) ) vSerialISREntry );\r
 152                         AT91F_AIC_EnableIt( AT91C_BASE_AIC, AT91C_ID_US0 );\r
 153                 }\r
 154                 portEXIT_CRITICAL();\r
 155         }\r
 156         else\r
 157         {\r
 158                 xReturn = ( xComPortHandle ) 0;\r
 159         }\r
 160 \r
 161         /* This demo file only supports a single port but we have to return \r
 162         something to comply with the standard demo header file. */\r
 163         return xReturn;\r
 164 }\r
 165 /*-----------------------------------------------------------*/\r
 166 \r
 167 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 168 {\r
 169         /* The port handle is not required as this driver only supports one port. */\r
 170         ( void ) pxPort;\r
 171 \r
 172         /* Get the next character from the buffer.  Return false if no characters\r
 173         are available, or arrive before xBlockTime expires. */\r
 174         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 175         {\r
 176                 return pdTRUE;\r
 177         }\r
 178         else\r
 179         {\r
 180                 return pdFALSE;\r
 181         }\r
 182 }\r
 183 /*-----------------------------------------------------------*/\r
 184 \r
 185 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 186 {\r
 187 signed char *pxNext;\r
 188 \r
 189         /* A couple of parameters that this port does not use. */\r
 190         ( void ) usStringLength;\r
 191         ( void ) pxPort;\r
 192 \r
 193         /* NOTE: This implementation does not handle the queue being full as no\r
 194         block time is used! */\r
 195 \r
 196         /* The port handle is not required as this driver only supports UART0. */\r
 197         ( void ) pxPort;\r
 198 \r
 199         /* Send each character in the string, one at a time. */\r
 200         pxNext = ( signed char * ) pcString;\r
 201         while( *pxNext )\r
 202         {\r
 203                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 204                 pxNext++;\r
 205         }\r
 206 }\r
 207 /*-----------------------------------------------------------*/\r
 208 \r
 209 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 210 {\r
 211         /* Place the character in the queue of characters to be transmitted. */\r
 212         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 213         {\r
 214                 return pdFAIL;\r
 215         }\r
 216 \r
 217         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 218         queue and send it.   This does not need to be in a critical section as\r
 219         if the interrupt has already removed the character the next interrupt\r
 220         will simply turn off the Tx interrupt again. */\r
 221         vInterruptOn();\r
 222 \r
 223         return pdPASS;\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 void vSerialClose( xComPortHandle xPort )\r
 228 {\r
 229         /* Not supported as not required by the demo application. */\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 /* Serial port ISR.  This can cause a context switch so is not defined as a\r
 234 standard ISR using the __irq keyword.  Instead a wrapper function is defined\r
 235 within serialISR.s79 which in turn calls this function.  See the port\r
 236 documentation on the FreeRTOS.org website for more information. */\r
 237 __arm void vSerialISR( void )\r
 238 {\r
 239 unsigned long ulStatus;\r
 240 signed char cChar;\r
 241 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 242 \r
 243         /* What caused the interrupt? */\r
 244         ulStatus = serCOM0->US_CSR &= serCOM0->US_IMR;\r
 245 \r
 246         if( ulStatus & AT91C_US_TXRDY )\r
 247         {\r
 248                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 249                 more characters to transmit? */\r
 250                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 251                 {\r
 252                         /* A character was retrieved from the queue so can be sent to the\r
 253                         THR now. */\r
 254                         serCOM0->US_THR = cChar;\r
 255                 }\r
 256                 else\r
 257                 {\r
 258                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 259                         vInterruptOff();\r
 260                 }               \r
 261         }\r
 262 \r
 263         if( ulStatus & AT91C_US_RXRDY )\r
 264         {\r
 265                 /* The interrupt was caused by a character being received.  Grab the\r
 266                 character from the RHR and place it in the queue or received \r
 267                 characters. */\r
 268                 cChar = serCOM0->US_RHR;\r
 269                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 270         }\r
 271 \r
 272         /* If a task was woken by either a character being received or a character \r
 273         being transmitted then we may need to switch to another task. */\r
 274         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 275 \r
 276         /* End the interrupt in the AIC. */\r
 277         AT91C_BASE_AIC->AIC_EOICR = 0;\r
 278 }\r
 279 \r
 280 \r
 281 \r
 282 \r
 283         \r