Hardware access layer for managing the Distributed Programmable Peripheral Interconnect Controller (DPPIC). More...

Macros
#define	NRF_DPPI_ENDPOINT_SETUP(task_or_event, dppi_chan)
	Macro for setting publish/subscribe register corresponding to specified event/task.

#define	NRF_DPPI_ENDPOINT_CLEAR(task_or_event)
	Macro for clearing publish/subscribe register corresponding to specified event/task.

#define	NRF_DPPI_ENDPOINT_ENABLE(task_or_event)
	Macro for enabling publish/subscribe register corresponding to specified event/task.

#define	NRF_DPPI_ENDPOINT_DISABLE(task_or_event)
	Macro for disabling publish/subscribe register corresponding to specified event/task.

#define	NRF_DPPI_HAS_APB_MAPPING 1
	Symbol indicating whether DPPI instance can be mapped to a peripheral based on common APB.

#define	NRF_DPPI_APB_MASK 0x10000UL
	Symbol specifying bitmask for mapping specific DPPIC to a respective APB it belongs to.

Enumerations
enum	nrf_dppi_channel_group_t { NRF_DPPI_CHANNEL_GROUP0 = 0 , NRF_DPPI_CHANNEL_GROUP1 = 1 , NRF_DPPI_CHANNEL_GROUP2 = 2 , NRF_DPPI_CHANNEL_GROUP3 = 3 , NRF_DPPI_CHANNEL_GROUP4 = 4 , NRF_DPPI_CHANNEL_GROUP5 = 5 }
	DPPI channel groups. More...

enum	nrf_dppi_task_t { NRF_DPPI_TASK_CHG0_EN = offsetof(NRF_DPPIC_Type, TASKS_CHG[0].EN) , NRF_DPPI_TASK_CHG0_DIS = offsetof(NRF_DPPIC_Type, TASKS_CHG[0].DIS) , NRF_DPPI_TASK_CHG1_EN = offsetof(NRF_DPPIC_Type, TASKS_CHG[1].EN) , NRF_DPPI_TASK_CHG1_DIS = offsetof(NRF_DPPIC_Type, TASKS_CHG[1].DIS) , NRF_DPPI_TASK_CHG2_EN = offsetof(NRF_DPPIC_Type, TASKS_CHG[2].EN) , NRF_DPPI_TASK_CHG2_DIS = offsetof(NRF_DPPIC_Type, TASKS_CHG[2].DIS) , NRF_DPPI_TASK_CHG3_EN = offsetof(NRF_DPPIC_Type, TASKS_CHG[3].EN) , NRF_DPPI_TASK_CHG3_DIS = offsetof(NRF_DPPIC_Type, TASKS_CHG[3].DIS) , NRF_DPPI_TASK_CHG4_EN = offsetof(NRF_DPPIC_Type, TASKS_CHG[4].EN) , NRF_DPPI_TASK_CHG4_DIS = offsetof(NRF_DPPIC_Type, TASKS_CHG[4].DIS) , NRF_DPPI_TASK_CHG5_EN = offsetof(NRF_DPPIC_Type, TASKS_CHG[5].EN) , NRF_DPPI_TASK_CHG5_DIS = offsetof(NRF_DPPIC_Type, TASKS_CHG[5].DIS) }
	DPPI tasks. More...

Functions
NRF_STATIC_INLINE uint8_t	nrf_dppi_channel_number_get (NRF_DPPIC_Type const *p_reg)
	Function for getting the total number of available channels for the given DPPIC instance.

NRF_STATIC_INLINE uint8_t	nrf_dppi_group_number_get (NRF_DPPIC_Type const *p_reg)
	Function for getting the total number of available groups for the given DPPIC instance.

NRF_STATIC_INLINE void	nrf_dppi_task_trigger (NRF_DPPIC_Type *p_reg, nrf_dppi_task_t dppi_task)
	Function for activating a DPPI task.

NRF_STATIC_INLINE uint32_t	nrf_dppi_task_address_get (NRF_DPPIC_Type const *p_reg, nrf_dppi_task_t task)
	Function for getting the address of the specified DPPI task register.

NRF_STATIC_INLINE bool	nrf_dppi_channel_check (NRF_DPPIC_Type const *p_reg, uint8_t channel)
	Function for checking the state of a specific DPPI channel.

NRF_STATIC_INLINE void	nrf_dppi_channels_enable (NRF_DPPIC_Type *p_reg, uint32_t mask)
	Function for enabling multiple DPPI channels.

NRF_STATIC_INLINE void	nrf_dppi_channels_disable (NRF_DPPIC_Type *p_reg, uint32_t mask)
	Function for disabling multiple DPPI channels.

NRF_STATIC_INLINE void	nrf_dppi_channels_disable_all (NRF_DPPIC_Type *p_reg)
	Function for disabling all DPPI channels.

NRF_STATIC_INLINE void	nrf_dppi_subscribe_set (NRF_DPPIC_Type *p_reg, nrf_dppi_task_t task, uint8_t channel)
	Function for setting the subscribe configuration for a given DPPI task.

NRF_STATIC_INLINE void	nrf_dppi_subscribe_clear (NRF_DPPIC_Type *p_reg, nrf_dppi_task_t task)
	Function for clearing the subscribe configuration for a given DPPI task.

NRF_STATIC_INLINE uint32_t	nrf_dppi_subscribe_get (NRF_DPPIC_Type const *p_reg, nrf_dppi_task_t task)
	Function for getting the subscribe configuration for a given DPPI task.

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

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

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

NRF_STATIC_INLINE void	nrf_dppi_group_clear (NRF_DPPIC_Type *p_reg, nrf_dppi_channel_group_t group)
	Function for removing all DPPI channels from a channel group.

NRF_STATIC_INLINE void	nrf_dppi_group_enable (NRF_DPPIC_Type *p_reg, nrf_dppi_channel_group_t group)
	Function for enabling a channel group.

NRF_STATIC_INLINE void	nrf_dppi_group_disable (NRF_DPPIC_Type *p_reg, nrf_dppi_channel_group_t group)
	Function for disabling a channel group.

NRF_STATIC_INLINE nrf_dppi_task_t	nrf_dppi_group_enable_task_get (uint8_t index)
	Function for getting the ENABLE task associated with the specified channel group.

NRF_STATIC_INLINE nrf_dppi_task_t	nrf_dppi_group_disable_task_get (uint8_t index)
	Function for getting the DISABLE task associated with the specified channel group.

Detailed Description

Hardware access layer for managing the Distributed Programmable Peripheral Interconnect Controller (DPPIC).

Macro Definition Documentation

◆ NRF_DPPI_ENDPOINT_CLEAR

#define NRF_DPPI_ENDPOINT_CLEAR ( task_or_event )

Value:

(*((volatile uint32_t *)(task_or_event + NRF_SUBSCRIBE_PUBLISH_OFFSET(task_or_event))) = 0)

Macro for clearing publish/subscribe register corresponding to specified event/task.

Parameters

[in] task_or_event Address of the event or task for which publish/subscribe register is to be cleared.

◆ NRF_DPPI_ENDPOINT_DISABLE

#define NRF_DPPI_ENDPOINT_DISABLE ( task_or_event )

Value:

(*((volatile uint32_t *)(task_or_event + NRF_SUBSCRIBE_PUBLISH_OFFSET(task_or_event))) &= \

~NRF_SUBSCRIBE_PUBLISH_ENABLE)

Macro for disabling publish/subscribe register corresponding to specified event/task.

Parameters

[in] task_or_event Address of the event or task for which publish/subscribe register is to be used.

◆ NRF_DPPI_ENDPOINT_ENABLE

#define NRF_DPPI_ENDPOINT_ENABLE ( task_or_event )

Value:

(*((volatile uint32_t *)(task_or_event + NRF_SUBSCRIBE_PUBLISH_OFFSET(task_or_event))) |= \

NRF_SUBSCRIBE_PUBLISH_ENABLE)

Macro for enabling publish/subscribe register corresponding to specified event/task.

Parameters

[in] task_or_event Address of the event or task for which publish/subscribe register is to be used.

◆ NRF_DPPI_ENDPOINT_SETUP

#define NRF_DPPI_ENDPOINT_SETUP	(		task_or_event,
			dppi_chan )

Value:

(*((volatile uint32_t *)(task_or_event + NRF_SUBSCRIBE_PUBLISH_OFFSET(task_or_event))) = \

((uint32_t)dppi_chan | NRF_SUBSCRIBE_PUBLISH_ENABLE))

Macro for setting publish/subscribe register corresponding to specified event/task.

Parameters

[in]	task_or_event	Address of the event or task for which publish/subscribe register is to be set.
[in]	dppi_chan	DPPIC channel number.

Enumeration Type Documentation

◆ nrf_dppi_channel_group_t

enum nrf_dppi_channel_group_t

DPPI channel groups.

Enumerator
NRF_DPPI_CHANNEL_GROUP0	Channel group 0.
NRF_DPPI_CHANNEL_GROUP1	Channel group 1.
NRF_DPPI_CHANNEL_GROUP2	Channel group 2.
NRF_DPPI_CHANNEL_GROUP3	Channel group 3.
NRF_DPPI_CHANNEL_GROUP4	Channel group 4.
NRF_DPPI_CHANNEL_GROUP5	Channel group 5.

◆ nrf_dppi_task_t

enum nrf_dppi_task_t

DPPI tasks.

Enumerator
NRF_DPPI_TASK_CHG0_EN	Enable channel group 0.
NRF_DPPI_TASK_CHG0_DIS	Disable channel group 0.
NRF_DPPI_TASK_CHG1_EN	Enable channel group 1.
NRF_DPPI_TASK_CHG1_DIS	Disable channel group 1.
NRF_DPPI_TASK_CHG2_EN	Enable channel group 2.
NRF_DPPI_TASK_CHG2_DIS	Disable channel group 2.
NRF_DPPI_TASK_CHG3_EN	Enable channel group 3.
NRF_DPPI_TASK_CHG3_DIS	Disable channel group 3.
NRF_DPPI_TASK_CHG4_EN	Enable channel group 4.
NRF_DPPI_TASK_CHG4_DIS	Disable channel group 4.
NRF_DPPI_TASK_CHG5_EN	Enable channel group 5.
NRF_DPPI_TASK_CHG5_DIS	Disable channel group 5.

Function Documentation

◆ nrf_dppi_channel_check()

NRF_STATIC_INLINE bool nrf_dppi_channel_check	(	NRF_DPPIC_Type const *	p_reg,
		uint8_t	channel )

Function for checking the state of a specific DPPI channel.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	channel	Channel to be checked.

Return values

true	The channel is enabled.
false	The channel is not enabled.

◆ nrf_dppi_channel_number_get()

NRF_STATIC_INLINE uint8_t nrf_dppi_channel_number_get ( NRF_DPPIC_Type const * p_reg )

Function for getting the total number of available channels for the given DPPIC instance.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Returns: Number of available channels.

◆ nrf_dppi_channels_disable()

NRF_STATIC_INLINE void nrf_dppi_channels_disable	(	NRF_DPPIC_Type *	p_reg,
		uint32_t	mask )

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_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Channel mask.

◆ nrf_dppi_channels_disable_all()

NRF_STATIC_INLINE void nrf_dppi_channels_disable_all ( NRF_DPPIC_Type * p_reg )

Function for disabling all DPPI channels.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

◆ nrf_dppi_channels_enable()

NRF_STATIC_INLINE void nrf_dppi_channels_enable	(	NRF_DPPIC_Type *	p_reg,
		uint32_t	mask )

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_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Channel mask.

◆ nrf_dppi_channels_group_set()

NRF_STATIC_INLINE void nrf_dppi_channels_group_set	(	NRF_DPPIC_Type *	p_reg,
		uint32_t	channel_mask,
		nrf_dppi_channel_group_t	channel_group )

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_reg	Pointer to the structure of registers of the peripheral.
[in]	channel_mask	Channels to be assigned in the group.
[in]	channel_group	Channel group.

◆ nrf_dppi_channels_include_in_group()

NRF_STATIC_INLINE void nrf_dppi_channels_include_in_group	(	NRF_DPPIC_Type *	p_reg,
		uint32_t	channel_mask,
		nrf_dppi_channel_group_t	channel_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_reg	Pointer to the structure of registers of the peripheral.
[in]	channel_mask	Channels to be included in the group.
[in]	channel_group	Channel group.

◆ nrf_dppi_channels_remove_from_group()

NRF_STATIC_INLINE void nrf_dppi_channels_remove_from_group	(	NRF_DPPIC_Type *	p_reg,
		uint32_t	channel_mask,
		nrf_dppi_channel_group_t	channel_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_reg	Pointer to the structure of registers of the peripheral.
[in]	channel_mask	Channels to be removed from the group.
[in]	channel_group	Channel group.

◆ nrf_dppi_group_clear()

NRF_STATIC_INLINE void nrf_dppi_group_clear	(	NRF_DPPIC_Type *	p_reg,
		nrf_dppi_channel_group_t	group )

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_reg	Pointer to the structure of registers of the peripheral.
[in]	group	Channel group.

◆ nrf_dppi_group_disable()

NRF_STATIC_INLINE void nrf_dppi_group_disable	(	NRF_DPPIC_Type *	p_reg,
		nrf_dppi_channel_group_t	group )

Function for disabling a channel group.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	group	Channel group.

◆ nrf_dppi_group_disable_task_get()

NRF_STATIC_INLINE nrf_dppi_task_t nrf_dppi_group_disable_task_get ( uint8_t index )

Function for getting the DISABLE task associated with the specified channel group.

Parameters

[in] index Channel group index.

Returns: Requested DISABLE task.

◆ nrf_dppi_group_enable()

NRF_STATIC_INLINE void nrf_dppi_group_enable	(	NRF_DPPIC_Type *	p_reg,
		nrf_dppi_channel_group_t	group )

Function for enabling a channel group.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	group	Channel group.

◆ nrf_dppi_group_enable_task_get()

NRF_STATIC_INLINE nrf_dppi_task_t nrf_dppi_group_enable_task_get ( uint8_t index )

Function for getting the ENABLE task associated with the specified channel group.

Parameters

[in] index Channel group index.

Returns: Requested ENABLE task.

◆ nrf_dppi_group_number_get()

NRF_STATIC_INLINE uint8_t nrf_dppi_group_number_get ( NRF_DPPIC_Type const * p_reg )

Function for getting the total number of available groups for the given DPPIC instance.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Returns: Number of available groups.

◆ nrf_dppi_subscribe_clear()

NRF_STATIC_INLINE void nrf_dppi_subscribe_clear	(	NRF_DPPIC_Type *	p_reg,
		nrf_dppi_task_t	task )

Function for clearing the subscribe configuration for a given DPPI task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to clear the configuration.

◆ nrf_dppi_subscribe_get()

NRF_STATIC_INLINE uint32_t nrf_dppi_subscribe_get	(	NRF_DPPIC_Type const *	p_reg,
		nrf_dppi_task_t	task )

Function for getting the subscribe configuration for a given DPPI task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to read the configuration.

Returns: DPPI subscribe configuration.

◆ nrf_dppi_subscribe_set()

NRF_STATIC_INLINE void nrf_dppi_subscribe_set	(	NRF_DPPIC_Type *	p_reg,
		nrf_dppi_task_t	task,
		uint8_t	channel )

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_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to set the configuration.
[in]	channel	Channel through which to subscribe events.

◆ nrf_dppi_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_dppi_task_address_get	(	NRF_DPPIC_Type const *	p_reg,
		nrf_dppi_task_t	task )

Function for getting the address of the specified DPPI task register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Requested task.

Returns: Address of the specified task register.

◆ nrf_dppi_task_trigger()

NRF_STATIC_INLINE void nrf_dppi_task_trigger	(	NRF_DPPIC_Type *	p_reg,
		nrf_dppi_task_t	dppi_task )

Function for activating a DPPI task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	dppi_task	Task to be activated.

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ NRF_DPPI_ENDPOINT_CLEAR

◆ NRF_DPPI_ENDPOINT_DISABLE

◆ NRF_DPPI_ENDPOINT_ENABLE

◆ NRF_DPPI_ENDPOINT_SETUP

Enumeration Type Documentation

◆ nrf_dppi_channel_group_t

◆ nrf_dppi_task_t

Function Documentation

◆ nrf_dppi_channel_check()

◆ nrf_dppi_channel_number_get()

◆ nrf_dppi_channels_disable()

◆ nrf_dppi_channels_disable_all()

◆ nrf_dppi_channels_enable()

◆ nrf_dppi_channels_group_set()

◆ nrf_dppi_channels_include_in_group()

◆ nrf_dppi_channels_remove_from_group()

◆ nrf_dppi_group_clear()

◆ nrf_dppi_group_disable()

◆ nrf_dppi_group_disable_task_get()

◆ nrf_dppi_group_enable()

◆ nrf_dppi_group_enable_task_get()

◆ nrf_dppi_group_number_get()

◆ nrf_dppi_subscribe_clear()

◆ nrf_dppi_subscribe_get()

◆ nrf_dppi_subscribe_set()

◆ nrf_dppi_task_address_get()

◆ nrf_dppi_task_trigger()