nrfx 3.3
Functions
DPPI HALY

Hardware access layer with cache and barrier support for managing the DPPI peripheral. More...

Functions

NRFY_STATIC_INLINE void nrfy_dppi_channels_set (NRF_DPPIC_Type *p_reg, uint32_t mask, bool enable)
 Function for enabling or disabling multiple DPPI channels.
 
NRFY_STATIC_INLINE uint8_t nrfy_dppi_channel_number_get (NRF_DPPIC_Type const *p_reg)
 
NRFY_STATIC_INLINE uint8_t nrfy_dppi_group_number_get (NRF_DPPIC_Type const *p_reg)
 
NRFY_STATIC_INLINE void nrfy_dppi_task_trigger (NRF_DPPIC_Type *p_reg, nrf_dppi_task_t dppi_task)
 
NRFY_STATIC_INLINE uint32_t nrfy_dppi_task_address_get (NRF_DPPIC_Type const *p_reg, nrf_dppi_task_t task)
 
NRFY_STATIC_INLINE bool nrfy_dppi_channel_check (NRF_DPPIC_Type const *p_reg, uint8_t channel)
 
NRFY_STATIC_INLINE void nrfy_dppi_channels_enable (NRF_DPPIC_Type *p_reg, uint32_t mask)
 
NRFY_STATIC_INLINE void nrfy_dppi_channels_disable (NRF_DPPIC_Type *p_reg, uint32_t mask)
 
NRFY_STATIC_INLINE void nrfy_dppi_channels_disable_all (NRF_DPPIC_Type *p_reg)
 
NRFY_STATIC_INLINE void nrfy_dppi_subscribe_set (NRF_DPPIC_Type *p_reg, nrf_dppi_task_t task, uint8_t channel)
 
NRFY_STATIC_INLINE void nrfy_dppi_subscribe_clear (NRF_DPPIC_Type *p_reg, nrf_dppi_task_t task)
 
NRFY_STATIC_INLINE void nrfy_dppi_channels_group_set (NRF_DPPIC_Type *p_reg, uint32_t channel_mask, nrf_dppi_channel_group_t channel_group)
 
NRFY_STATIC_INLINE void nrfy_dppi_channels_include_in_group (NRF_DPPIC_Type *p_reg, uint32_t channel_mask, nrf_dppi_channel_group_t channel_group)
 
NRFY_STATIC_INLINE void nrfy_dppi_channels_remove_from_group (NRF_DPPIC_Type *p_reg, uint32_t channel_mask, nrf_dppi_channel_group_t channel_group)
 
NRFY_STATIC_INLINE void nrfy_dppi_group_clear (NRF_DPPIC_Type *p_reg, nrf_dppi_channel_group_t group)
 
NRFY_STATIC_INLINE void nrfy_dppi_group_enable (NRF_DPPIC_Type *p_reg, nrf_dppi_channel_group_t group)
 
NRFY_STATIC_INLINE void nrfy_dppi_group_disable (NRF_DPPIC_Type *p_reg, nrf_dppi_channel_group_t group)
 
NRFY_STATIC_INLINE nrf_dppi_task_t nrfy_dppi_group_enable_task_get (uint8_t index)
 
NRFY_STATIC_INLINE nrf_dppi_task_t nrfy_dppi_group_disable_task_get (uint8_t index)
 

Detailed Description

Hardware access layer with cache and barrier support for managing the DPPI peripheral.

Function Documentation

◆ nrfy_dppi_channel_check()

NRFY_STATIC_INLINE bool nrfy_dppi_channel_check ( NRF_DPPIC_Type const *  p_reg,
uint8_t  channel 
)
See also
nrf_dppi_channel_check Function for checking the state of a specific DPPI channel.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]channelChannel to be checked.
Return values
trueThe channel is enabled.
falseThe channel is not enabled.

◆ nrfy_dppi_channel_number_get()

NRFY_STATIC_INLINE uint8_t nrfy_dppi_channel_number_get ( NRF_DPPIC_Type const *  p_reg)
See also
nrf_dppi_channel_number_get Function for getting the total number of available channels for the given DPPIC instance.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Number of available channels.

◆ nrfy_dppi_channels_disable()

NRFY_STATIC_INLINE void nrfy_dppi_channels_disable ( NRF_DPPIC_Type *  p_reg,
uint32_t  mask 
)
See also
nrf_dppi_channels_disable Function for disabling multiple DPPI channels.

The bits in mask value correspond to particular channels. It means that writing 1 to bit 0 disables channel 0, writing 1 to bit 1 disables channel 1 etc.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskChannel mask.

◆ nrfy_dppi_channels_disable_all()

NRFY_STATIC_INLINE void nrfy_dppi_channels_disable_all ( NRF_DPPIC_Type *  p_reg)
See also
nrf_dppi_channels_disable_all Function for disabling all DPPI channels.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrfy_dppi_channels_enable()

NRFY_STATIC_INLINE void nrfy_dppi_channels_enable ( NRF_DPPIC_Type *  p_reg,
uint32_t  mask 
)
See also
nrf_dppi_channels_enable Function for enabling multiple DPPI channels.

The bits in mask value correspond to particular channels. It means that writing 1 to bit 0 enables channel 0, writing 1 to bit 1 enables channel 1 etc.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskChannel mask.

◆ nrfy_dppi_channels_group_set()

NRFY_STATIC_INLINE void nrfy_dppi_channels_group_set ( NRF_DPPIC_Type *  p_reg,
uint32_t  channel_mask,
nrf_dppi_channel_group_t  channel_group 
)
See also
nrf_dppi_channels_group_set Function for setting multiple DPPI channels in a channel group.

This function assigns all specified channels to the group. The bits in channel_mask value correspond to particular channels. It means that writing 1 to bit 0 includes channel 0, writing 1 to bit 1 includes channel 1, and so on.

Warning
All channels included previously will be overwritten.
Channel group configuration can be modified only if subscriptions for tasks associated with this group are disabled.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]channel_maskChannels to be assigned in the group.
[in]channel_groupChannel group.

◆ nrfy_dppi_channels_include_in_group()

NRFY_STATIC_INLINE void nrfy_dppi_channels_include_in_group ( NRF_DPPIC_Type *  p_reg,
uint32_t  channel_mask,
nrf_dppi_channel_group_t  channel_group 
)
See also
nrf_dppi_channels_include_in_group Function for including multiple DPPI channels in a channel group.

This function adds all specified channels to the group. The bits in channel_mask value correspond to particular channels. It means that writing 1 to bit 0 includes channel 0, writing 1 to bit 1 includes channel 1 etc.

Warning
Channel group configuration can be modified only if subscriptions for tasks associated with this group are disabled.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]channel_maskChannels to be included in the group.
[in]channel_groupChannel group.

◆ nrfy_dppi_channels_remove_from_group()

NRFY_STATIC_INLINE void nrfy_dppi_channels_remove_from_group ( NRF_DPPIC_Type *  p_reg,
uint32_t  channel_mask,
nrf_dppi_channel_group_t  channel_group 
)
See also
nrf_dppi_channels_remove_from_group Function for removing multiple DPPI channels from a channel group.

This function removes all specified channels from the group. The bits in channel_mask value correspond to particular channels. It means that writing 1 to bit 0 removes channel 0, writing 1 to bit 1 removes channel 1 etc.

Warning
Channel group configuration can be modified only if subscriptions for tasks associated with this group are disabled.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]channel_maskChannels to be removed from the group.
[in]channel_groupChannel group.

◆ nrfy_dppi_channels_set()

NRFY_STATIC_INLINE void nrfy_dppi_channels_set ( NRF_DPPIC_Type *  p_reg,
uint32_t  mask,
bool  enable 
)

Function for enabling or disabling multiple DPPI channels.

The bits in mask value correspond to particular channels. It means that writing 1 to bit 0 enables or disables channel 0, writing 1 to bit 1 enables or disables channel 1 etc.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskChannel mask.
[in]enableTrue if specified channels are to be enabled, false otherwise.

◆ nrfy_dppi_group_clear()

NRFY_STATIC_INLINE void nrfy_dppi_group_clear ( NRF_DPPIC_Type *  p_reg,
nrf_dppi_channel_group_t  group 
)
See also
nrf_dppi_group_clear Function for removing all DPPI channels from a channel group.
Warning
Channel group configuration can be modified only if subscriptions for tasks associated with this group are disabled.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]groupChannel group.

◆ nrfy_dppi_group_disable()

NRFY_STATIC_INLINE void nrfy_dppi_group_disable ( NRF_DPPIC_Type *  p_reg,
nrf_dppi_channel_group_t  group 
)
See also
nrf_dppi_group_disable Function for disabling a channel group.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]groupChannel group.

◆ nrfy_dppi_group_disable_task_get()

NRFY_STATIC_INLINE nrf_dppi_task_t nrfy_dppi_group_disable_task_get ( uint8_t  index)
See also
nrf_dppi_group_disable_task_get Function for getting the DISABLE task associated with the specified channel group.
Parameters
[in]indexChannel group index.
Returns
Requested DISABLE task.

◆ nrfy_dppi_group_enable()

NRFY_STATIC_INLINE void nrfy_dppi_group_enable ( NRF_DPPIC_Type *  p_reg,
nrf_dppi_channel_group_t  group 
)
See also
nrf_dppi_group_enable Function for enabling a channel group.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]groupChannel group.

◆ nrfy_dppi_group_enable_task_get()

NRFY_STATIC_INLINE nrf_dppi_task_t nrfy_dppi_group_enable_task_get ( uint8_t  index)
See also
nrf_dppi_group_enable_task_get Function for getting the ENABLE task associated with the specified channel group.
Parameters
[in]indexChannel group index.
Returns
Requested ENABLE task.

◆ nrfy_dppi_group_number_get()

NRFY_STATIC_INLINE uint8_t nrfy_dppi_group_number_get ( NRF_DPPIC_Type const *  p_reg)
See also
nrf_dppi_group_number_get Function for getting the total number of available groups for the given DPPIC instance.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Number of available groups.

◆ nrfy_dppi_subscribe_clear()

NRFY_STATIC_INLINE void nrfy_dppi_subscribe_clear ( NRF_DPPIC_Type *  p_reg,
nrf_dppi_task_t  task 
)
See also
nrf_dppi_subscribe_clear Function for clearing the subscribe configuration for a given DPPI task.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask for which to clear the configuration.

◆ nrfy_dppi_subscribe_set()

NRFY_STATIC_INLINE void nrfy_dppi_subscribe_set ( NRF_DPPIC_Type *  p_reg,
nrf_dppi_task_t  task,
uint8_t  channel 
)
See also
nrf_dppi_subscribe_set Function for setting the subscribe configuration for a given DPPI task.
Warning
After setting the subscription for a given task, channel group configuration associated with this task cannot be modified until nrf_dppi_subscribe_clear is used.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask for which to set the configuration.
[in]channelChannel through which to subscribe events.

◆ nrfy_dppi_task_address_get()

NRFY_STATIC_INLINE uint32_t nrfy_dppi_task_address_get ( NRF_DPPIC_Type const *  p_reg,
nrf_dppi_task_t  task 
)
See also
nrf_dppi_task_address_get Function for getting the address of the specified DPPI task register.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskRequested task.
Returns
Address of the specified task register.

◆ nrfy_dppi_task_trigger()

NRFY_STATIC_INLINE void nrfy_dppi_task_trigger ( NRF_DPPIC_Type *  p_reg,
nrf_dppi_task_t  dppi_task 
)
See also
nrf_dppi_task_trigger Function for activating a DPPI task.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]dppi_taskTask to be activated.

Documentation feedback | Developer Zone | Subscribe | Updated