EUSART - Extended USART#
Extended Universal Synchronous/Asynchronous Receiver/Transmitter.
Introduction#
This module contains functions to control the Enhanced Universal Synchronous / Asynchronous Receiver / Transmitter controller(s) (EUSART) peripheral of Silicon Labs' 32-bit MCUs and SoCs. EUSART can be used as a UART and can, therefore, be connected to an external transceiver to communicate with another host using the serial link.
It supports full duplex asynchronous UART communication as well as RS-485, SPI, MicroWire, and 3-wire. It can also interface with ISO7816 Smart-Cards, and IrDA devices.
EUSART has a wide selection of operating modes, frame formats, and baud rates. All features are supported through the API of this module.
This module does not support DMA configuration. UARTDRV and SPIDRV drivers provide full support for DMA and more.
Example#
EUSART Async TX example:
{
EUSART_UartInit_TypeDef init = EUSART_UART_INIT_DEFAULT_HF;
// Configure the clocks.
CMU_ClockSelectSet(cmuClock_EUSART0CLK, cmuSelect_EM01GRPCCLK);
CMU_ClockEnable(cmuClock_EUSART0CLK, true);
// Initialize the EUSART
EUSART_UartInitHf(EUSART0, &init);
EUSART_Tx(EUSART0, data);
}
EUSART Sync SPI Transaction example:
{
EUSART_SpiInit_TypeDef init_master = EUSART_SPI_MASTER_INIT_DEFAULT_HF;
// Configure the clocks.
CMU_ClockSelectSet(cmuClock_EM01GRPCCLK, cmuSelect_HFRCODPLL);
CMU_ClockEnable(cmuClock_EUSART1, true);
CMU_ClockEnable(cmuClock_GPIO, true);
//Configure the SPI ports
GPIO_PinModeSet(sclk_port, sclk_pin, gpioModePushPull, 0);
GPIO_PinModeSet(mosi_port, mosi_pin, gpioModePushPull, 0);
GPIO_PinModeSet(mosi_port, miso_pin, gpioModeInput, 0);
// Connect EUSART to ports
GPIO->EUSARTROUTE[EUSART_NUM(EUSART1)].TXROUTE = (mosi_port << _GPIO_EUSART_TXROUTE_PORT_SHIFT)
| (mosi_pin << _GPIO_EUSART_TXROUTE_PIN_SHIFT);
GPIO->EUSARTROUTE[EUSART_NUM(EUSART1)].RXROUTE = (miso_port << _GPIO_EUSART_RXROUTE_PORT_SHIFT)
| (miso_pin << _GPIO_EUSART_RXROUTE_PIN_SHIFT);
GPIO->EUSARTROUTE[EUSART_NUM(EUSART1)].SCLKROUTE = (sclk_port << _GPIO_EUSART_SCLKROUTE_PORT_SHIFT)
| (sclk_pin << _GPIO_EUSART_SCLKROUTE_PIN_SHIFT);
GPIO->EUSARTROUTE[EUSART_NUM(EUSART1)].ROUTEEN = GPIO_EUSART_ROUTEEN_TXPEN | GPIO_EUSART_ROUTEEN_SCLKPEN;
// Initialize the EUSART
EUSART_SpiInit(EUSART1, &init_master);
EUSART_Spi_TxRx(EUSART1, data);
}
EM2 guidelines for non EM2-Capable instances#
Note
EUSART instances located in the PD1 power domain are non EM2-capable. The EUSART_EM2_CAPABLE() and EUSART_NOT_EM2_CAPABLE() macros can be used to determine whether or not a EUSART instance is EM2-Capable.
Follow theses steps when entering in EM2:
Wait for the current transaction to complete with TXCIF interrupt
Disable TX and RX using TXDIS and RXDIS cmd
Poll for EUSARTn_SYNCBUSY.TXDIS and EUSARTn_SYNCBUSY.RXDIS to go low
Wait for EUSARTn_STATUS.TXENS and EUSARTn_STATUS.RXENS to go low
Disable SCLKPEN and CSPEN in GPIO if they were previously enabled
Enter EM2
On wakeup from EM2, EUSART transmitter/receiver and relevant GPIO (SCLKPEN and CSPEN) must be re-enabled. For example:
{
// Enable TX and RX
EUSART_Enable(EUSART0, eusartEnable);
BUS_RegMaskedWrite(&GPIO->EUSARTROUTE[EUSART_NUM(EUSART0)].ROUTEEN,
_GPIO_EUSART_ROUTEEN_TXPEN_MASK | _GPIO_EUSART_ROUTEEN_SCLKPEN_MASK,
GPIO_EUSART_ROUTEEN_TXPEN | GPIO_EUSART_ROUTEEN_SCLKPEN);
}
Modules#
Enumerations#
Enable selection.
Data bit selection.
Parity selection.
Stop bits selection.
Oversampling selection, used for asynchronous operation.
HW flow control config.
Loopback enable.
Majority vote enable.
Block reception enable.
TX output tristate enable.
IrDA filter enable.
Pulse width selection for IrDA mode.
PRS trigger enable.
IO polarity selection.
Typedefs#
PRS Channel type.
Functions#
Initialize EUSART when used in UART mode with the high frequency clock.
Initialize EUSART when used in UART mode with the low frequency clock.
Initialize EUSART when used in IrDA mode with the high or low frequency clock.
Configure EUSART to its reset state.
Enable/disable EUSART receiver and/or transmitter.
Receive one 8 bit frame, (or part of 9 bit frame).
Receive one 8-16 bit frame with extended information.
Transmit one frame.
Transmit one 8-9 bit frame with extended control.
Configure the baudrate (or as close as possible to a specified baudrate).
Get the current baudrate.
Enable/Disable reception operation until the configured start frame is received.
Enable/Disable the tristating of the transmitter output.
Initialize the automatic enabling of transmissions and/or reception using the PRS as a trigger.
Get EUSART STATUS register.
Clear one or more pending EUSART interrupts.
Disable one or more EUSART interrupts.
Enable one or more EUSART interrupts.
Get pending EUSART interrupt flags.
Get enabled and pending EUSART interrupt flags.
Set one or more pending EUSART interrupts from SW.
Macros#
Default configuration for EUSART initialization structure in UART mode with high-frequency clock.
Default start frame configuration, i.e. feature disabled.
Default configuration for EUSART advanced initialization structure.
Default configuration for EUSART initialization structure in UART mode with low-frequency clock.
Default configuration for EUSART initialization structure in IrDA mode with high-frequency clock.
Default configuration for EUSART initialization structure in IrDA mode with low-frequency clock.
Enumeration Documentation#
EUSART_Enable_TypeDef#
EUSART_Enable_TypeDef
Enable selection.
Enumerator | |
---|---|
eusartDisable | Disable the peripheral. |
eusartEnableRx | Enable receiver only, transmitter disabled. |
eusartEnableTx | Enable transmitter only, receiver disabled. |
eusartEnable | Enable both receiver and transmitter. |
147
of file platform/emlib/inc/em_eusart.h
EUSART_Databits_TypeDef#
EUSART_Databits_TypeDef
Data bit selection.
Enumerator | |
---|---|
eusartDataBits7 | 7 data bits. |
eusartDataBits8 | 8 data bits. |
eusartDataBits9 | 9 data bits. |
162
of file platform/emlib/inc/em_eusart.h
EUSART_Parity_TypeDef#
EUSART_Parity_TypeDef
Parity selection.
Enumerator | |
---|---|
eusartNoParity | No parity. |
eusartEvenParity | Even parity. |
eusartOddParity | Odd parity. |
178
of file platform/emlib/inc/em_eusart.h
EUSART_Stopbits_TypeDef#
EUSART_Stopbits_TypeDef
Stop bits selection.
Enumerator | |
---|---|
eusartStopbits0p5 | 0.5 stop bits. |
eusartStopbits1p5 | 1.5 stop bits. |
eusartStopbits1 | 1 stop bits. |
eusartStopbits2 | 2 stop bits. |
185
of file platform/emlib/inc/em_eusart.h
EUSART_OVS_TypeDef#
EUSART_OVS_TypeDef
Oversampling selection, used for asynchronous operation.
Enumerator | |
---|---|
eusartOVS16 | 16x oversampling (normal). |
eusartOVS8 | 8x oversampling. |
eusartOVS6 | 6x oversampling. |
eusartOVS4 | 4x oversampling. |
eusartOVS0 | Oversampling disabled. |
193
of file platform/emlib/inc/em_eusart.h
EUSART_HwFlowControl_TypeDef#
EUSART_HwFlowControl_TypeDef
HW flow control config.
Enumerator | |
---|---|
eusartHwFlowControlNone | No HW Flow Control. |
eusartHwFlowControlCts | CTS HW Flow Control. |
eusartHwFlowControlRts | RTS HW Flow Control. |
eusartHwFlowControlCtsAndRts | CTS and RTS HW Flow Control. |
202
of file platform/emlib/inc/em_eusart.h
EUSART_LoopbackEnable_TypeDef#
EUSART_LoopbackEnable_TypeDef
Loopback enable.
Enumerator | |
---|---|
eusartLoopbackEnable | Enable loopback. |
eusartLoopbackDisable | Disable loopback. |
210
of file platform/emlib/inc/em_eusart.h
EUSART_MajorityVote_TypeDef#
EUSART_MajorityVote_TypeDef
Majority vote enable.
Enumerator | |
---|---|
eusartMajorityVoteEnable | Enable majority vote for 16x, 8x and 6x oversampling modes. |
eusartMajorityVoteDisable | Disable majority vote for 16x, 8x and 6x oversampling modes. |
216
of file platform/emlib/inc/em_eusart.h
EUSART_BlockRx_TypeDef#
EUSART_BlockRx_TypeDef
Block reception enable.
Enumerator | |
---|---|
eusartBlockRxEnable | Block reception enable, resulting in all incoming frames being discarded. |
eusartBlockRxDisable | Block reception disable, resulting in all incoming frames being loaded into the RX FIFO. |
222
of file platform/emlib/inc/em_eusart.h
EUSART_TristateTx_TypeDef#
EUSART_TristateTx_TypeDef
TX output tristate enable.
Enumerator | |
---|---|
eusartTristateTxEnable | Tristates the transmitter output. |
eusartTristateTxDisable | Disables tristating of the transmitter output. |
228
of file platform/emlib/inc/em_eusart.h
EUSART_IrDARxFilterEnable_TypeDef#
EUSART_IrDARxFilterEnable_TypeDef
IrDA filter enable.
Enumerator | |
---|---|
eusartIrDARxFilterEnable | Enable filter on demodulator. |
eusartIrDARxFilterDisable | Disable filter on demodulator. |
234
of file platform/emlib/inc/em_eusart.h
EUSART_IrDAPulseWidth_Typedef#
EUSART_IrDAPulseWidth_Typedef
Pulse width selection for IrDA mode.
Enumerator | |
---|---|
eusartIrDAPulseWidthOne | IrDA pulse width is 1/16 for OVS=X16 and 1/8 for OVS=X8. |
eusartIrDAPulseWidthTwo | IrDA pulse width is 2/16 for OVS=X16 and 2/8 for OVS=X8. |
eusartIrDAPulseWidthThree | IrDA pulse width is 3/16 for OVS=X16 and 3/8 for OVS=X8. |
eusartIrDAPulseWidthFour | IrDA pulse width is 4/16 for OVS=X16 and 4/8 for OVS=X8. |
240
of file platform/emlib/inc/em_eusart.h
EUSART_PrsTriggerEnable_TypeDef#
EUSART_PrsTriggerEnable_TypeDef
PRS trigger enable.
Enumerator | |
---|---|
eusartPrsTriggerDisable | Disable trigger on both receiver and transmitter. |
eusartPrsTriggerEnableRx | Enable receive trigger only, transmit disabled. |
eusartPrsTriggerEnableTx | Enable transmit trigger only, receive disabled. |
eusartPrsTriggerEnableRxTx | Enable trigger on both receive and transmit. |
255
of file platform/emlib/inc/em_eusart.h
EUSART_InvertIO_TypeDef#
EUSART_InvertIO_TypeDef
IO polarity selection.
Enumerator | |
---|---|
eusartInvertIODisable | Disable inversion on both RX and TX signals. |
eusartInvertRxEnable | Invert RX signal, before receiver. |
eusartInvertTxEnable | Invert TX signal, after transmitter. |
eusartInvertIOEnable | Enable trigger on both receive and transmit. |
273
of file platform/emlib/inc/em_eusart.h
Typedef Documentation#
EUSART_PrsChannel_TypeDef#
typedef uint8_t EUSART_PrsChannel_TypeDef
PRS Channel type.
270
of file platform/emlib/inc/em_eusart.h
Function Documentation#
EUSART_UartInitHf#
void EUSART_UartInitHf (EUSART_TypeDef * eusart, const EUSART_UartInit_TypeDef * init)
Initialize EUSART when used in UART mode with the high frequency clock.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | init | A pointer to the initialization structure. |
Initialize EUSART when used in UART mode with the high frequency clock.
845
of file platform/emlib/inc/em_eusart.h
EUSART_UartInitLf#
void EUSART_UartInitLf (EUSART_TypeDef * eusart, const EUSART_UartInit_TypeDef * init)
Initialize EUSART when used in UART mode with the low frequency clock.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | init | A pointer to the initialization structure. |
Initialize EUSART when used in UART mode with the low frequency clock.
Note
(1) When EUSART oversampling is set to eusartOVS0 (Disable), the peripheral clock frequency must be at least three times higher than the chosen baud rate. In LF, max input clock is 32768 (LFXO or LFRCO), thus 32768 / 3 ~ 9600 baudrate.
853
of file platform/emlib/inc/em_eusart.h
EUSART_IrDAInit#
void EUSART_IrDAInit (EUSART_TypeDef * eusart, const EUSART_IrDAInit_TypeDef * irdaInit)
Initialize EUSART when used in IrDA mode with the high or low frequency clock.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | irdaInit | A pointer to the initialization structure. |
Initialize EUSART when used in IrDA mode with the high or low frequency clock.
862
of file platform/emlib/inc/em_eusart.h
EUSART_Reset#
void EUSART_Reset (EUSART_TypeDef * eusart)
Configure EUSART to its reset state.
N/A | eusart | Pointer to the EUSART peripheral register block. |
Configure EUSART to its reset state.
893
of file platform/emlib/inc/em_eusart.h
EUSART_Enable#
void EUSART_Enable (EUSART_TypeDef * eusart, EUSART_Enable_TypeDef enable)
Enable/disable EUSART receiver and/or transmitter.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | enable | Select the status for the receiver and transmitter. |
Enable/disable EUSART receiver and/or transmitter.
901
of file platform/emlib/inc/em_eusart.h
EUSART_Rx#
uint8_t EUSART_Rx (EUSART_TypeDef * eusart)
Receive one 8 bit frame, (or part of 9 bit frame).
N/A | eusart | Pointer to the EUSART peripheral register block. |
Note
This function is normally used to receive one frame when operating with frame length of 8 bits. See EUSART_RxExt() for reception of 9 bit frames. Notice that possible parity/stop bits are not considered a part of the specified frame bit length.
This function will stall if buffer is empty until data is received.
Returns
Data received.
Receive one 8 bit frame, (or part of 9 bit frame).
Note
(1) Handles the case where the RX Fifo Watermark has been set to N frames, and when N is greater than one. Attempt to read a frame from the RX Fifo. If the read is unsuccessful (i.e. no frames in the RX fifo), the RXFU interrupt flag is set. If the flag is set, wait to read again until the RXFL status flag is set, indicating there are N frames in the RX Fifo, where N is equal to the RX watermark level. Once there are N frames in the Fifo, read and return one frame. For consecutive N-1 reads there will be data available in the Fifo. Therefore, the RXUF interrupt will not be triggered eliminating delays between reads and sending N data frames in "bursts".
916
of file platform/emlib/inc/em_eusart.h
EUSART_RxExt#
uint16_t EUSART_RxExt (EUSART_TypeDef * eusart)
Receive one 8-16 bit frame with extended information.
N/A | eusart | Pointer to the EUSART peripheral register block. |
Note
This function is normally used to receive one frame and additional RX status information.
This function will stall if buffer is empty until data is received.
Returns
Data received and receive status.
Receive one 8-16 bit frame with extended information.
929
of file platform/emlib/inc/em_eusart.h
EUSART_Tx#
void EUSART_Tx (EUSART_TypeDef * eusart, uint8_t data)
Transmit one frame.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | data | Data to transmit. |
Note
Depending on the frame length configuration, 8 (least significant) bits from
data
are transmitted. If the frame length is 9, 8 bits are transmitted fromdata
. See EUSART_TxExt() for transmitting 9 bit frame with full control of all 9 bits.This function will stall if the 4 frame FIFO is full, until the buffer becomes available.
Transmit one frame.
944
of file platform/emlib/inc/em_eusart.h
EUSART_TxExt#
void EUSART_TxExt (EUSART_TypeDef * eusart, uint16_t data)
Transmit one 8-9 bit frame with extended control.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | data | Data to transmit. |
Note
Possible parity/stop bits in asynchronous mode are not considered part of a specified frame bit length.
This function will stall if buffer is full until the buffer becomes available.
Transmit one 8-9 bit frame with extended control.
957
of file platform/emlib/inc/em_eusart.h
EUSART_BaudrateSet#
void EUSART_BaudrateSet (EUSART_TypeDef * eusart, uint32_t refFreq, uint32_t baudrate)
Configure the baudrate (or as close as possible to a specified baudrate).
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | refFreq | The EUSART reference clock frequency in Hz that will be used. If set to 0, the currently configured peripheral clock is used. |
N/A | baudrate | A baudrate to try to achieve. |
Configure the baudrate (or as close as possible to a specified baudrate).
Note
(1) When the oversampling is disabled, the peripheral clock frequency must be at least three times higher than the chosen baud rate.
1013
of file platform/emlib/inc/em_eusart.h
EUSART_BaudrateGet#
uint32_t EUSART_BaudrateGet (EUSART_TypeDef * eusart)
Get the current baudrate.
N/A | eusart | Pointer to the EUSART peripheral register block. |
Returns
The current baudrate.
Get the current baudrate.
1024
of file platform/emlib/inc/em_eusart.h
EUSART_RxBlock#
void EUSART_RxBlock (EUSART_TypeDef * eusart, EUSART_BlockRx_TypeDef enable)
Enable/Disable reception operation until the configured start frame is received.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | enable | Select the receiver blocking status. |
Enable/Disable reception operation until the configured start frame is received.
1033
of file platform/emlib/inc/em_eusart.h
EUSART_TxTristateSet#
void EUSART_TxTristateSet (EUSART_TypeDef * eusart, EUSART_TristateTx_TypeDef enable)
Enable/Disable the tristating of the transmitter output.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | enable | Select the transmitter tristate status. |
Enable/Disable the tristating of the transmitter output.
1042
of file platform/emlib/inc/em_eusart.h
EUSART_PrsTriggerEnable#
void EUSART_PrsTriggerEnable (EUSART_TypeDef * eusart, const EUSART_PrsTriggerInit_TypeDef * init)
Initialize the automatic enabling of transmissions and/or reception using the PRS as a trigger.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | init | Pointer to the initialization structure. |
Note
Initialize EUSART with sl_eusart_initHf() or sl_eusart_initLf() before enabling the PRS trigger.
Initialize the automatic enabling of transmissions and/or reception using the PRS as a trigger.
1055
of file platform/emlib/inc/em_eusart.h
EUSART_StatusGet#
uint32_t EUSART_StatusGet (EUSART_TypeDef * eusart)
Get EUSART STATUS register.
N/A | eusart | Pointer to the EUSART peripheral register block. |
Returns
STATUS register value.
1065
of file platform/emlib/inc/em_eusart.h
EUSART_IntClear#
void EUSART_IntClear (EUSART_TypeDef * eusart, uint32_t flags)
Clear one or more pending EUSART interrupts.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | flags | Pending EUSART interrupt source to clear. Use a bitwise logic OR combination of valid interrupt flags for EUSART module (EUSART_IF_nnn). |
1079
of file platform/emlib/inc/em_eusart.h
EUSART_IntDisable#
void EUSART_IntDisable (EUSART_TypeDef * eusart, uint32_t flags)
Disable one or more EUSART interrupts.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | flags | Pending EUSART interrupt source to clear. Use a bitwise logic OR combination of valid interrupt flags for EUSART module (EUSART_IF_nnn). |
1093
of file platform/emlib/inc/em_eusart.h
EUSART_IntEnable#
void EUSART_IntEnable (EUSART_TypeDef * eusart, uint32_t flags)
Enable one or more EUSART interrupts.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | flags | Pending EUSART interrupt source to clear. Use a bitwise logic OR combination of valid interrupt flags for EUSART module (EUSART_IF_nnn). |
1107
of file platform/emlib/inc/em_eusart.h
EUSART_IntGet#
uint32_t EUSART_IntGet (EUSART_TypeDef * eusart)
Get pending EUSART interrupt flags.
N/A | eusart | Pointer to the EUSART peripheral register block. |
Returns
Pending EUSART interrupt sources.
1119
of file platform/emlib/inc/em_eusart.h
EUSART_IntGetEnabled#
uint32_t EUSART_IntGetEnabled (EUSART_TypeDef * eusart)
Get enabled and pending EUSART interrupt flags.
N/A | eusart | Pointer to the EUSART peripheral register block. |
Useful for handling more interrupt sources in the same interrupt handler.
Returns
Pending and enabled EUSART interrupt sources.
1132
of file platform/emlib/inc/em_eusart.h
EUSART_IntSet#
void EUSART_IntSet (EUSART_TypeDef * eusart, uint32_t flags)
Set one or more pending EUSART interrupts from SW.
N/A | eusart | Pointer to the EUSART peripheral register block. |
N/A | flags | Interrupt source(s) to set to pending. Use a bitwise logic OR combination of valid interrupt flags for EUSART module (EUSART_IF_nnn). |
1153
of file platform/emlib/inc/em_eusart.h
Macro Definition Documentation#
EUSART_UART_INIT_DEFAULT_HF#
#define EUSART_UART_INIT_DEFAULT_HFValue:
Default configuration for EUSART initialization structure in UART mode with high-frequency clock.
634
of file platform/emlib/inc/em_eusart.h
EUSART_DEFAULT_START_FRAME#
#define EUSART_DEFAULT_START_FRAMEValue:
0x00u
Default start frame configuration, i.e. feature disabled.
649
of file platform/emlib/inc/em_eusart.h
EUSART_ADVANCED_INIT_DEFAULT#
#define EUSART_ADVANCED_INIT_DEFAULTValue:
Default configuration for EUSART advanced initialization structure.
652
of file platform/emlib/inc/em_eusart.h
EUSART_UART_INIT_DEFAULT_LF#
#define EUSART_UART_INIT_DEFAULT_LFValue:
Default configuration for EUSART initialization structure in UART mode with low-frequency clock.
670
of file platform/emlib/inc/em_eusart.h
EUSART_IRDA_INIT_DEFAULT_HF#
#define EUSART_IRDA_INIT_DEFAULT_HFValue:
Default configuration for EUSART initialization structure in IrDA mode with high-frequency clock.
685
of file platform/emlib/inc/em_eusart.h
EUSART_IRDA_INIT_DEFAULT_LF#
#define EUSART_IRDA_INIT_DEFAULT_LFValue:
Default configuration for EUSART initialization structure in IrDA mode with low-frequency clock.
694
of file platform/emlib/inc/em_eusart.h