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

   1 /*\r
   2     FreeRTOS V9.0.0rc2 - Copyright (C) 2016 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 /* Library includes. */\r
  85 #include "usart/usart.h"\r
  86 #include "pmc/pmc.h"\r
  87 #include "irq/irq.h"\r
  88 #include "pio/pio.h"\r
  89 \r
  90 /*-----------------------------------------------------------*/\r
  91 \r
  92 /* Interrupt control macros. */\r
  93 #define serINTERRUPT_LEVEL                              ( 5 )\r
  94 #define vInterruptOn()                                  BOARD_USART_BASE->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )\r
  95 #define vInterruptOff()                                 BOARD_USART_BASE->US_IDR = AT91C_US_TXRDY\r
  96 \r
  97 /* Misc constants. */\r
  98 #define serINVALID_QUEUE                                ( ( QueueHandle_t ) 0 )\r
  99 #define serHANDLE                                               ( ( xComPortHandle ) 1 )\r
 100 #define serNO_BLOCK                                             ( ( TickType_t ) 0 )\r
 101 #define serNO_TIMEGUARD                                 ( ( unsigned long ) 0 )\r
 102 #define serNO_PERIPHERAL_B_SETUP                ( ( unsigned long ) 0 )\r
 103 \r
 104 \r
 105 /* Queues used to hold received characters, and characters waiting to be\r
 106 transmitted. */\r
 107 static QueueHandle_t xRxedChars;\r
 108 static QueueHandle_t xCharsForTx;\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 /* The interrupt service routine - called from the assembly entry point. */\r
 113 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 const Pin xUSART_Pins[] = { BOARD_PIN_USART_RXD, BOARD_PIN_USART_TXD };\r
 125 \r
 126 \r
 127         /* Create the queues used to hold Rx and Tx characters. */\r
 128         xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 129         xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );\r
 130 \r
 131         /* If the queues were created correctly then setup the serial port\r
 132         hardware. */\r
 133         if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )\r
 134         {\r
 135                 portENTER_CRITICAL();\r
 136                 {\r
 137                         /* Enable the peripheral clock in the PMC. */\r
 138                         PMC_EnablePeripheral( BOARD_ID_USART );\r
 139                 \r
 140                         /* Configure the USART. */\r
 141                         USART_Configure( BOARD_USART_BASE, AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE | AT91C_US_NBSTOP_1_BIT, ulWantedBaud, configCPU_CLOCK_HZ );\r
 142                 \r
 143                         /* Configure the interrupt.  Note the pre-emption priority is set\r
 144                         in bits [8:15] of the priority value passed as the parameter. */\r
 145                         IRQ_ConfigureIT( BOARD_ID_USART, ( configMAX_SYSCALL_INTERRUPT_PRIORITY << 8 ), vSerialISR );\r
 146                         IRQ_EnableIT( BOARD_ID_USART );\r
 147                 \r
 148                         /* Enable receiver & transmitter. */\r
 149                         USART_SetTransmitterEnabled( BOARD_USART_BASE, pdTRUE );\r
 150                         USART_SetReceiverEnabled( BOARD_USART_BASE, pdTRUE );\r
 151                         \r
 152                         /* Configure IO for USART use. */\r
 153                         PIO_Configure( xUSART_Pins, PIO_LISTSIZE( xUSART_Pins ) );\r
 154                 }\r
 155                 portEXIT_CRITICAL();\r
 156         }\r
 157         else\r
 158         {\r
 159                 xReturn = ( xComPortHandle ) 0;\r
 160         }\r
 161 \r
 162         /* This demo file only supports a single port but we have to return\r
 163         something to comply with the standard demo header file. */\r
 164         return xReturn;\r
 165 }\r
 166 /*-----------------------------------------------------------*/\r
 167 \r
 168 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )\r
 169 {\r
 170         /* The port handle is not required as this driver only supports one port. */\r
 171         ( void ) pxPort;\r
 172 \r
 173         /* Get the next character from the buffer.  Return false if no characters\r
 174         are available, or arrive before xBlockTime expires. */\r
 175         if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )\r
 176         {\r
 177                 return pdTRUE;\r
 178         }\r
 179         else\r
 180         {\r
 181                 return pdFALSE;\r
 182         }\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )\r
 187 {\r
 188 signed char *pxNext;\r
 189 \r
 190         /* A couple of parameters that this port does not use. */\r
 191         ( void ) usStringLength;\r
 192         ( void ) pxPort;\r
 193 \r
 194         /* NOTE: This implementation does not handle the queue being full as no\r
 195         block time is used! */\r
 196 \r
 197         /* The port handle is not required as this driver only supports UART0. */\r
 198         ( void ) pxPort;\r
 199 \r
 200         /* Send each character in the string, one at a time. */\r
 201         pxNext = ( signed char * ) pcString;\r
 202         while( *pxNext )\r
 203         {\r
 204                 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );\r
 205                 pxNext++;\r
 206         }\r
 207 }\r
 208 /*-----------------------------------------------------------*/\r
 209 \r
 210 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )\r
 211 {\r
 212         /* Place the character in the queue of characters to be transmitted. */\r
 213         if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )\r
 214         {\r
 215                 return pdFAIL;\r
 216         }\r
 217 \r
 218         /* Turn on the Tx interrupt so the ISR will remove the character from the\r
 219         queue and send it.   This does not need to be in a critical section as\r
 220         if the interrupt has already removed the character the next interrupt\r
 221         will simply turn off the Tx interrupt again. */\r
 222         vInterruptOn();\r
 223 \r
 224         return pdPASS;\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 void vSerialClose( xComPortHandle xPort )\r
 229 {\r
 230         /* Not supported as not required by the demo application. */\r
 231 }\r
 232 /*-----------------------------------------------------------*/\r
 233 \r
 234 void vSerialISR( void )\r
 235 {\r
 236 unsigned long ulStatus;\r
 237 signed char cChar;\r
 238 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;\r
 239 \r
 240         /* What caused the interrupt? */\r
 241         ulStatus = BOARD_USART_BASE->US_CSR &= BOARD_USART_BASE->US_IMR;\r
 242 \r
 243         if( ulStatus & AT91C_US_TXRDY )\r
 244         {\r
 245                 /* The interrupt was caused by the THR becoming empty.  Are there any\r
 246                 more characters to transmit? */\r
 247                 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )\r
 248                 {\r
 249                         /* A character was retrieved from the queue so can be sent to the\r
 250                         THR now. */\r
 251                         BOARD_USART_BASE->US_THR = cChar;\r
 252                 }\r
 253                 else\r
 254                 {\r
 255                         /* Queue empty, nothing to send so turn off the Tx interrupt. */\r
 256                         vInterruptOff();\r
 257                 }               \r
 258         }\r
 259 \r
 260         if( ulStatus & AT91C_US_RXRDY )\r
 261         {\r
 262                 /* The interrupt was caused by a character being received.  Grab the\r
 263                 character from the RHR and place it in the queue or received\r
 264                 characters. */\r
 265                 cChar = BOARD_USART_BASE->US_RHR;\r
 266                 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );\r
 267         }\r
 268 \r
 269         /* If a task was woken by either a character being received or a character\r
 270         being transmitted then we may need to switch to another task. */\r
 271         portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );\r
 272 }\r
 273 \r
 274 \r
 275 \r
 276 \r
 277         \r