PRSEMLIB

Detailed Description

Peripheral Reflex System (PRS) Peripheral API.

This module contains functions to control the PRS peripheral of Silicon Labs 32-bit MCUs and SoCs. The PRS allows configurable, fast, and autonomous communication between peripherals on the MCU or SoC.

Macros

#define PRS_ASYNC_CHAN_COUNT   PRS_CHAN_COUNT
 
#define PRS_ASYNC_SUPPORTED   1
 
#define PRS_SYNC_CHAN_COUNT   PRS_CHAN_COUNT
 
#define PRS_USART0_RXDATA   PRS_USART0_RXDATAV
 
#define PRS_USART1_RXDATA   PRS_USART1_RXDATAV
 

Enumerations

enum  PRS_ChType_t {
  prsTypeAsync,
  prsTypeSync
}
 
enum  PRS_Edge_TypeDef {
  prsEdgeOff,
  prsEdgePos,
  prsEdgeNeg,
  prsEdgeBoth
}
 
enum  PRS_Signal_t {
  prsSignalNone = 0x0,
  prsSignalTIMER0_UF = PRS_TIMER0_UF,
  prsSignalTIMER0_OF = PRS_TIMER0_OF,
  prsSignalTIMER0_CC0 = PRS_TIMER0_CC0,
  prsSignalTIMER0_CC1 = PRS_TIMER0_CC1,
  prsSignalTIMER0_CC2 = PRS_TIMER0_CC2,
  prsSignalTIMER1_UF = PRS_TIMER1_UF,
  prsSignalTIMER1_OF = PRS_TIMER1_OF,
  prsSignalTIMER1_CC0 = PRS_TIMER1_CC0,
  prsSignalTIMER1_CC1 = PRS_TIMER1_CC1,
  prsSignalTIMER1_CC2 = PRS_TIMER1_CC2,
  prsSignalLETIMER0_CH0 = PRS_LETIMER0_CH0,
  prsSignalLETIMER0_CH1 = PRS_LETIMER0_CH1,
  prsSignalRTCC_CCV0 = PRS_RTCC_CCV0,
  prsSignalRTCC_CCV1 = PRS_RTCC_CCV1,
  prsSignalRTCC_CCV2 = PRS_RTCC_CCV2,
  prsSignalACMP0_OUT = PRS_ACMP0_OUT,
  prsSignalACMP1_OUT = PRS_ACMP1_OUT,
  prsSignalUSART0_IRTX = PRS_USART0_IRTX,
  prsSignalUSART0_TXC = PRS_USART0_TXC,
  prsSignalUSART0_RXDATA = PRS_USART0_RXDATA,
  prsSignalUSART0_RTS = PRS_USART0_RTS,
  prsSignalUSART0_TX = PRS_USART0_TX,
  prsSignalUSART0_CS = PRS_USART0_CS,
  prsSignalUSART1_TXC = PRS_USART1_TXC,
  prsSignalUSART1_RXDATA = PRS_USART1_RXDATA,
  prsSignalUSART1_RTS = PRS_USART1_RTS,
  prsSignalUSART1_TX = PRS_USART1_TX,
  prsSignalUSART1_CS = PRS_USART1_CS,
  prsSignalGPIO_PIN0 = PRS_GPIO_PIN0,
  prsSignalGPIO_PIN1 = PRS_GPIO_PIN1,
  prsSignalGPIO_PIN2 = PRS_GPIO_PIN2,
  prsSignalGPIO_PIN3 = PRS_GPIO_PIN3,
  prsSignalGPIO_PIN4 = PRS_GPIO_PIN4,
  prsSignalGPIO_PIN5 = PRS_GPIO_PIN5,
  prsSignalGPIO_PIN6 = PRS_GPIO_PIN6,
  prsSignalGPIO_PIN7 = PRS_GPIO_PIN7,
  prsSignalGPIO_PIN8 = PRS_GPIO_PIN8,
  prsSignalGPIO_PIN9 = PRS_GPIO_PIN9,
  prsSignalGPIO_PIN10 = PRS_GPIO_PIN10,
  prsSignalGPIO_PIN11 = PRS_GPIO_PIN11,
  prsSignalGPIO_PIN12 = PRS_GPIO_PIN12,
  prsSignalGPIO_PIN13 = PRS_GPIO_PIN13,
  prsSignalGPIO_PIN14 = PRS_GPIO_PIN14,
  prsSignalGPIO_PIN15 = PRS_GPIO_PIN15
}
 

Functions

__STATIC_INLINE void PRS_ChannelLevelSet (unsigned int ch, bool level)
 Set the PRS channel level for one asynchronous PRS channel.
 
__STATIC_INLINE void PRS_ChannelPulse (unsigned int ch)
 Trigger a pulse on one PRS channel.
 
__STATIC_INLINE bool PRS_ChannelValue (unsigned int ch, PRS_ChType_t type)
 Get the PRS channel value for a single channel.
 
void PRS_ConnectSignal (unsigned int ch, PRS_ChType_t type, PRS_Signal_t signal)
 Connect a PRS signal to a channel.
 
int PRS_GetFreeChannel (PRS_ChType_t type)
 Search for the first free PRS channel.
 
void PRS_GpioOutputLocation (unsigned int ch, unsigned int location)
 Send the output of a PRS channel to a GPIO pin.
 
__STATIC_INLINE uint32_t PRS_LevelGet (void)
 Get level control bit for all channels.
 
__STATIC_INLINE void PRS_LevelSet (uint32_t level, uint32_t mask)
 Set level control bit for one or more channels.
 
__STATIC_INLINE void PRS_PulseTrigger (uint32_t channels)
 Trigger a high pulse (one HFPERCLK) for one or more channels.
 
void PRS_Reset (void)
 Reset all PRS channels.
 
void PRS_SourceAsyncSignalSet (unsigned int ch, uint32_t source, uint32_t signal)
 Set the source and asynchronous signal for a channel.
 
void PRS_SourceSignalSet (unsigned int ch, uint32_t source, uint32_t signal, PRS_Edge_TypeDef edge)
 Set a source and signal for a channel.
 
__STATIC_INLINE uint32_t PRS_Values (PRS_ChType_t type)
 Get the PRS channel values for all channels.
 

Enumeration Type Documentation

PRS Channel type.

Enumerator
prsTypeAsync 

Asynchronous channel type.

prsTypeSync 

Synchronous channel type.

Definition at line 100 of file em_prs.h.

Edge detection type.

Enumerator
prsEdgeOff 

Leave signal as is.

prsEdgePos 

Generate pulses on positive edge.

prsEdgeNeg 

Generate pulses on negative edge.

prsEdgeBoth 

Generate pulses on both edges.

Definition at line 106 of file em_prs.h.

PRS Signal.

Enumerator
prsSignalTIMER0_UF 

TIMER0 underflow Signal.

prsSignalTIMER0_OF 

TIMER0 overflow Signal.

prsSignalTIMER0_CC0 

TIMER0 capture/compare channel 0 Signal.

prsSignalTIMER0_CC1 

TIMER0 capture/compare channel 1 Signal.

prsSignalTIMER0_CC2 

TIMER0 capture/compare channel 2 Signal.

prsSignalTIMER1_UF 

TIMER1 underflow Signal.

prsSignalTIMER1_OF 

TIMER1 overflow Signal.

prsSignalTIMER1_CC0 

TIMER1 capture/compare channel 0 Signal.

prsSignalTIMER1_CC1 

TIMER1 capture/compare channel 1 Signal.

prsSignalTIMER1_CC2 

TIMER1 capture/compare channel 2 Signal.

prsSignalLETIMER0_CH0 

LETIMER0 channel 0 Signal.

prsSignalLETIMER0_CH1 

LETIMER0 channel 1 Signal.

prsSignalRTCC_CCV0 

RTCC capture/compare channel 0 Signal.

prsSignalRTCC_CCV1 

RTCC capture/compare channel 1 Signal.

prsSignalRTCC_CCV2 

RTCC capture/compare channel 2 Signal.

prsSignalACMP0_OUT 

ACMP0 Signal.

prsSignalACMP1_OUT 

ACMP1 output Signal.

prsSignalUSART0_IRTX 

USART0 IR tx Signal.

prsSignalUSART0_TXC 

USART0 tx complete Signal.

prsSignalUSART0_RXDATA 

USART0 rx data available Signal.

prsSignalUSART0_RTS 

USART0 RTS Signal.

prsSignalUSART0_TX 

USART0 tx Signal.

prsSignalUSART0_CS 

USART0 chip select Signal.

prsSignalUSART1_TXC 

USART1 tx complete Signal.

prsSignalUSART1_RXDATA 

USART1 rx data available Signal.

prsSignalUSART1_RTS 

USART1 RTS Signal.

prsSignalUSART1_TX 

USART1 tx Signal.

prsSignalUSART1_CS 

USART1 chip select Signal.

prsSignalGPIO_PIN0 

GPIO Pin 0 Signal.

prsSignalGPIO_PIN1 

GPIO Pin 1 Signal.

prsSignalGPIO_PIN2 

GPIO Pin 2 Signal.

prsSignalGPIO_PIN3 

GPIO Pin 3 Signal.

prsSignalGPIO_PIN4 

GPIO Pin 4 Signal.

prsSignalGPIO_PIN5 

GPIO Pin 5 Signal.

prsSignalGPIO_PIN6 

GPIO Pin 6 Signal.

prsSignalGPIO_PIN7 

GPIO Pin 7 Signal.

prsSignalGPIO_PIN8 

GPIO Pin 8 Signal.

prsSignalGPIO_PIN9 

GPIO Pin 9 Signal.

prsSignalGPIO_PIN10 

GPIO Pin 10 Signal.

prsSignalGPIO_PIN11 

GPIO Pin 11 Signal.

prsSignalGPIO_PIN12 

GPIO Pin 12 Signal.

prsSignalGPIO_PIN13 

GPIO Pin 13 Signal.

prsSignalGPIO_PIN14 

GPIO Pin 14 Signal.

prsSignalGPIO_PIN15 

GPIO Pin 15 Signal.

Definition at line 136 of file em_prs.h.

Function Documentation

__STATIC_INLINE void PRS_ChannelLevelSet ( unsigned int  ch,
bool  level 
)

Set the PRS channel level for one asynchronous PRS channel.

Parameters
[in]chPRS channel number.
[in]leveltrue to set the level high (1) and false to set the level low (0).

Definition at line 429 of file em_prs.h.

References PRS_LevelSet().

__STATIC_INLINE void PRS_ChannelPulse ( unsigned int  ch)

Trigger a pulse on one PRS channel.

Parameters
[in]chPRS channel number.

Definition at line 441 of file em_prs.h.

References PRS_PulseTrigger().

__STATIC_INLINE bool PRS_ChannelValue ( unsigned int  ch,
PRS_ChType_t  type 
)

Get the PRS channel value for a single channel.

Parameters
[in]chPRS channel number.
[in]typePRS channel type. This can be either prsTypeAsync or prsTypeSync.
Returns
The current PRS channel output value. This is either 0 or 1.

Definition at line 390 of file em_prs.h.

References PRS_Values().

void PRS_ConnectSignal ( unsigned int  ch,
PRS_ChType_t  type,
PRS_Signal_t  signal 
)

Connect a PRS signal to a channel.

This function will make the PRS signal available on the specific channel. Only a single PRS signal can be connected to any given channel.

Parameters
[in]chPRS channel number.
[in]typePRS channel type. This can be either prsTypeAsync or prsTypeSync.
[in]signalThis is the PRS signal that should be placed on the channel.

Definition at line 384 of file em_prs.c.

References _PRS_CH_CTRL_SIGSEL_MASK, _PRS_CH_CTRL_SOURCESEL_MASK, PRS, PRS_CH_CTRL_ASYNC, PRS_CH_CTRL_EDSEL_OFF, and prsTypeAsync.

Referenced by PRS_SourceAsyncSignalSet().

int PRS_GetFreeChannel ( PRS_ChType_t  type)

Search for the first free PRS channel.

Parameters
[in]typePRS channel type. This can be either prsTypeAsync or prsTypeSync.
Returns
Channel number >= 0 if an unused PRS channel was found. If no free PRS channel was found then -1 is returned.

Definition at line 317 of file em_prs.c.

References prsTypeAsync.

void PRS_GpioOutputLocation ( unsigned int  ch,
unsigned int  location 
)

Send the output of a PRS channel to a GPIO pin.

This function is used to send the output of a PRS channel to a GPIO pin. Note that there are certain restrictions to where a PRS channel can be routed. Consult the datasheet of the device to see if a channel can be routed to the requested GPIO pin.

Parameters
[in]chPRS channel number.
[in]locPRS routing location.

Definition at line 284 of file em_prs.c.

References PRS, and PRS_CHAN_COUNT.

__STATIC_INLINE uint32_t PRS_LevelGet ( void  )

Get level control bit for all channels.

Returns
The current software level configuration.

Definition at line 341 of file em_prs.h.

References PRS.

__STATIC_INLINE void PRS_LevelSet ( uint32_t  level,
uint32_t  mask 
)

Set level control bit for one or more channels.

The level value for a channel is XORed with both the pulse possibly issued by PRS_PulseTrigger() and the PRS input signal selected for the channel(s).

Parameters
[in]levelLevel to use for channels indicated by mask. Use logical OR combination of PRS_SWLEVEL_CHnLEVEL defines for channels to set high level, otherwise 0.
[in]maskMask indicating which channels to set level for. Use logical OR combination of PRS_SWLEVEL_CHnLEVEL defines.

Definition at line 325 of file em_prs.h.

References PRS.

Referenced by PRS_ChannelLevelSet().

__STATIC_INLINE void PRS_PulseTrigger ( uint32_t  channels)

Trigger a high pulse (one HFPERCLK) for one or more channels.

Setting a bit for a channel causes the bit in the register to remain high for one HFPERCLK cycle. Pulse is XORed with both the corresponding bit in PRS SWLEVEL register and the PRS input signal selected for the channel(s).

Parameters
[in]channelsLogical ORed combination of channels to trigger a pulse for. Use PRS_SWPULSE_CHnPULSE defines.

Definition at line 410 of file em_prs.h.

References _PRS_SWPULSE_MASK, and PRS.

Referenced by PRS_ChannelPulse().

void PRS_Reset ( void  )

Reset all PRS channels.

This function will reset all the PRS channel configuration.

Definition at line 346 of file em_prs.c.

References _PRS_CH_CTRL_RESETVALUE, PRS, and PRS_CHAN_COUNT.

void PRS_SourceAsyncSignalSet ( unsigned int  ch,
uint32_t  source,
uint32_t  signal 
)

Set the source and asynchronous signal for a channel.

Asynchronous reflexes are not clocked on HFPERCLK and can be used even in EM2/EM3. There is a limitation to reflexes operating in asynchronous mode in that they can only be used by a subset of the reflex consumers. See the PRS chapter in the reference manual for the complete list of supported asynchronous signals and consumers.

Note
This function is not supported on EFM32GxxxFyyy parts. In asynchronous mode, the edge detector only works in EM0 and should not be used. The EDSEL parameter in PRS_CHx_CTRL register is set to 0 (OFF) by default.
Parameters
[in]chA channel to define the source and asynchronous signal for.
[in]sourceA source to select for the channel. Use one of PRS_CH_CTRL_SOURCESEL_x defines.
[in]signalAn asynchronous signal (for selected source) to use. Use one of the PRS_CH_CTRL_SIGSEL_x defines that support asynchronous operation.

Definition at line 259 of file em_prs.c.

References PRS_ConnectSignal(), and prsTypeAsync.

Referenced by adcDeInit(), ezradio_hal_GpioInit(), MIC_deInit(), and MIC_init().

void PRS_SourceSignalSet ( unsigned int  ch,
uint32_t  source,
uint32_t  signal,
PRS_Edge_TypeDef  edge 
)

Set a source and signal for a channel.

Parameters
[in]chA channel to define the signal and source for.
[in]sourceA source to select for the channel. Use one of PRS_CH_CTRL_SOURCESEL_x defines.
[in]signalA signal (for selected source) to use. Use one of PRS_CH_CTRL_SIGSEL_x defines.
[in]edgeAn edge (for selected source/signal) to generate the pulse for.

Definition at line 212 of file em_prs.c.

References _PRS_CH_CTRL_EDSEL_SHIFT, _PRS_CH_CTRL_SIGSEL_MASK, _PRS_CH_CTRL_SOURCESEL_MASK, PRS, and PRS_CHAN_COUNT.

__STATIC_INLINE uint32_t PRS_Values ( PRS_ChType_t  type)

Get the PRS channel values for all channels.

Parameters
[in]typePRS channel type. This can be either prsTypeAsync or prsTypeSync.
Returns
The current PRS channel output values for all channels as a bitset.

Definition at line 362 of file em_prs.h.

References PRS, and prsTypeAsync.

Referenced by PRS_ChannelValue().