2 * FreeRTOS Kernel V10.1.1
\r
3 * Copyright (C) 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
25 * 1 tab == 4 spaces!
\r
29 BASIC INTERRUPT DRIVEN SERIAL PORT DRIVER FOR UART0.
\r
32 /* Standard includes. */
\r
35 /* Scheduler includes. */
\r
36 #include "FreeRTOS.h"
\r
39 /* Demo application includes. */
\r
42 /* Library includes. */
\r
43 #include "usart/usart.h"
\r
44 #include "pmc/pmc.h"
\r
45 #include "irq/irq.h"
\r
46 #include "pio/pio.h"
\r
48 /*-----------------------------------------------------------*/
\r
50 /* Interrupt control macros. */
\r
51 #define serINTERRUPT_LEVEL ( 5 )
\r
52 #define vInterruptOn() BOARD_USART_BASE->US_IER = ( AT91C_US_TXRDY | AT91C_US_RXRDY )
\r
53 #define vInterruptOff() BOARD_USART_BASE->US_IDR = AT91C_US_TXRDY
\r
55 /* Misc constants. */
\r
56 #define serINVALID_QUEUE ( ( QueueHandle_t ) 0 )
\r
57 #define serHANDLE ( ( xComPortHandle ) 1 )
\r
58 #define serNO_BLOCK ( ( TickType_t ) 0 )
\r
59 #define serNO_TIMEGUARD ( ( unsigned long ) 0 )
\r
60 #define serNO_PERIPHERAL_B_SETUP ( ( unsigned long ) 0 )
\r
63 /* Queues used to hold received characters, and characters waiting to be
\r
65 static QueueHandle_t xRxedChars;
\r
66 static QueueHandle_t xCharsForTx;
\r
68 /*-----------------------------------------------------------*/
\r
70 /* The interrupt service routine - called from the assembly entry point. */
\r
71 void vSerialISR( void );
\r
73 /*-----------------------------------------------------------*/
\r
76 * See the serial2.h header file.
\r
78 xComPortHandle xSerialPortInitMinimal( unsigned long ulWantedBaud, unsigned portBASE_TYPE uxQueueLength )
\r
80 xComPortHandle xReturn = serHANDLE;
\r
81 extern void ( vUART_ISR )( void );
\r
82 const Pin xUSART_Pins[] = { BOARD_PIN_USART_RXD, BOARD_PIN_USART_TXD };
\r
85 /* Create the queues used to hold Rx and Tx characters. */
\r
86 xRxedChars = xQueueCreate( uxQueueLength, ( unsigned portBASE_TYPE ) sizeof( signed char ) );
\r
87 xCharsForTx = xQueueCreate( uxQueueLength + 1, ( unsigned portBASE_TYPE ) sizeof( signed char ) );
\r
89 /* If the queues were created correctly then setup the serial port
\r
91 if( ( xRxedChars != serINVALID_QUEUE ) && ( xCharsForTx != serINVALID_QUEUE ) )
\r
93 portENTER_CRITICAL();
\r
95 /* Enable the peripheral clock in the PMC. */
\r
96 PMC_EnablePeripheral( BOARD_ID_USART );
\r
98 /* Configure the USART. */
\r
99 USART_Configure( BOARD_USART_BASE, AT91C_US_CHRL_8_BITS | AT91C_US_PAR_NONE | AT91C_US_NBSTOP_1_BIT, ulWantedBaud, configCPU_CLOCK_HZ );
\r
101 /* Configure the interrupt. Note the pre-emption priority is set
\r
102 in bits [8:15] of the priority value passed as the parameter. */
\r
103 IRQ_ConfigureIT( BOARD_ID_USART, ( configMAX_SYSCALL_INTERRUPT_PRIORITY << 8 ), vSerialISR );
\r
104 IRQ_EnableIT( BOARD_ID_USART );
\r
106 /* Enable receiver & transmitter. */
\r
107 USART_SetTransmitterEnabled( BOARD_USART_BASE, pdTRUE );
\r
108 USART_SetReceiverEnabled( BOARD_USART_BASE, pdTRUE );
\r
110 /* Configure IO for USART use. */
\r
111 PIO_Configure( xUSART_Pins, PIO_LISTSIZE( xUSART_Pins ) );
\r
113 portEXIT_CRITICAL();
\r
117 xReturn = ( xComPortHandle ) 0;
\r
120 /* This demo file only supports a single port but we have to return
\r
121 something to comply with the standard demo header file. */
\r
124 /*-----------------------------------------------------------*/
\r
126 signed portBASE_TYPE xSerialGetChar( xComPortHandle pxPort, signed char *pcRxedChar, TickType_t xBlockTime )
\r
128 /* The port handle is not required as this driver only supports one port. */
\r
131 /* Get the next character from the buffer. Return false if no characters
\r
132 are available, or arrive before xBlockTime expires. */
\r
133 if( xQueueReceive( xRxedChars, pcRxedChar, xBlockTime ) )
\r
142 /*-----------------------------------------------------------*/
\r
144 void vSerialPutString( xComPortHandle pxPort, const signed char * const pcString, unsigned short usStringLength )
\r
146 signed char *pxNext;
\r
148 /* A couple of parameters that this port does not use. */
\r
149 ( void ) usStringLength;
\r
152 /* NOTE: This implementation does not handle the queue being full as no
\r
153 block time is used! */
\r
155 /* The port handle is not required as this driver only supports UART0. */
\r
158 /* Send each character in the string, one at a time. */
\r
159 pxNext = ( signed char * ) pcString;
\r
162 xSerialPutChar( pxPort, *pxNext, serNO_BLOCK );
\r
166 /*-----------------------------------------------------------*/
\r
168 signed portBASE_TYPE xSerialPutChar( xComPortHandle pxPort, signed char cOutChar, TickType_t xBlockTime )
\r
170 /* Place the character in the queue of characters to be transmitted. */
\r
171 if( xQueueSend( xCharsForTx, &cOutChar, xBlockTime ) != pdPASS )
\r
176 /* Turn on the Tx interrupt so the ISR will remove the character from the
\r
177 queue and send it. This does not need to be in a critical section as
\r
178 if the interrupt has already removed the character the next interrupt
\r
179 will simply turn off the Tx interrupt again. */
\r
184 /*-----------------------------------------------------------*/
\r
186 void vSerialClose( xComPortHandle xPort )
\r
188 /* Not supported as not required by the demo application. */
\r
190 /*-----------------------------------------------------------*/
\r
192 void vSerialISR( void )
\r
194 unsigned long ulStatus;
\r
196 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
198 /* What caused the interrupt? */
\r
199 ulStatus = BOARD_USART_BASE->US_CSR &= BOARD_USART_BASE->US_IMR;
\r
201 if( ulStatus & AT91C_US_TXRDY )
\r
203 /* The interrupt was caused by the THR becoming empty. Are there any
\r
204 more characters to transmit? */
\r
205 if( xQueueReceiveFromISR( xCharsForTx, &cChar, &xHigherPriorityTaskWoken ) == pdTRUE )
\r
207 /* A character was retrieved from the queue so can be sent to the
\r
209 BOARD_USART_BASE->US_THR = cChar;
\r
213 /* Queue empty, nothing to send so turn off the Tx interrupt. */
\r
218 if( ulStatus & AT91C_US_RXRDY )
\r
220 /* The interrupt was caused by a character being received. Grab the
\r
221 character from the RHR and place it in the queue or received
\r
223 cChar = BOARD_USART_BASE->US_RHR;
\r
224 xQueueSendFromISR( xRxedChars, &cChar, &xHigherPriorityTaskWoken );
\r
227 /* If a task was woken by either a character being received or a character
\r
228 being transmitted then we may need to switch to another task. */
\r
229 portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );
\r