nRF5 SDK v17.1.0
Functions

Distributed Programmable Peripheral Interconnect (DPPI) allocator. More...

Functions

void nrfx_dppi_free (void)
 Function for freeing all allocated channels and groups.
 
nrfx_err_t nrfx_dppi_channel_alloc (uint8_t *p_channel)
 Function for allocating a DPPI channel. More...
 
nrfx_err_t nrfx_dppi_channel_free (uint8_t channel)
 Function for freeing a DPPI channel. More...
 
nrfx_err_t nrfx_dppi_channel_enable (uint8_t channel)
 Function for enabling a DPPI channel. More...
 
nrfx_err_t nrfx_dppi_channel_disable (uint8_t channel)
 Function for disabling a DPPI channel. More...
 
nrfx_err_t nrfx_dppi_group_alloc (nrf_dppi_channel_group_t *p_group)
 Function for allocating a DPPI channel group. More...
 
nrfx_err_t nrfx_dppi_group_free (nrf_dppi_channel_group_t group)
 Function for freeing a DPPI channel group. More...
 
nrfx_err_t nrfx_dppi_channel_include_in_group (uint8_t channel, nrf_dppi_channel_group_t group)
 Function for including a DPPI channel in a channel group. More...
 
nrfx_err_t nrfx_dppi_channel_remove_from_group (uint8_t channel, nrf_dppi_channel_group_t group)
 Function for removing a DPPI channel from a channel group. More...
 
nrfx_err_t nrfx_dppi_group_clear (nrf_dppi_channel_group_t group)
 Function for clearing a DPPI channel group. More...
 
nrfx_err_t nrfx_dppi_group_enable (nrf_dppi_channel_group_t group)
 Function for enabling a DPPI channel group. More...
 
nrfx_err_t nrfx_dppi_group_disable (nrf_dppi_channel_group_t group)
 Function for disabling a DPPI channel group. More...
 

Detailed Description

Distributed Programmable Peripheral Interconnect (DPPI) allocator.

Function Documentation

nrfx_err_t nrfx_dppi_channel_alloc ( uint8_t *  p_channel)

Function for allocating a DPPI channel.

This function allocates the first unused DPPI channel.

Parameters
[out]p_channelPointer to the DPPI channel number that has been allocated.
Return values
NRFX_SUCCESSThe channel was successfully allocated.
NRFX_ERROR_NO_MEMThere is no available channel to be used.
nrfx_err_t nrfx_dppi_channel_disable ( uint8_t  channel)

Function for disabling a DPPI channel.

Parameters
[in]channelDPPI channel to be disabled.
Return values
NRFX_SUCCESSThe channel was successfully disabled.
NRFX_ERROR_INVALID_PARAMThe specified channel is not allocated.
nrfx_err_t nrfx_dppi_channel_enable ( uint8_t  channel)

Function for enabling a DPPI channel.

Parameters
[in]channelDPPI channel to be enabled.
Return values
NRFX_SUCCESSThe channel was successfully enabled.
NRFX_ERROR_INVALID_PARAMThe specified channel is not allocated.
nrfx_err_t nrfx_dppi_channel_free ( uint8_t  channel)

Function for freeing a DPPI channel.

This function also disables the chosen channel.

Parameters
[in]channelDPPI channel to be freed.
Return values
NRFX_SUCCESSThe channel was successfully freed.
NRFX_ERROR_INVALID_PARAMThe specified channel is not allocated.
nrfx_err_t nrfx_dppi_channel_include_in_group ( uint8_t  channel,
nrf_dppi_channel_group_t  group 
)

Function for including a DPPI channel in a channel group.

Parameters
[in]channelDPPI channel to be added.
[in]groupChannel group in which to include the channel.
Return values
NRFX_SUCCESSThe channel was successfully included.
NRFX_ERROR_INVALID_PARAMThe specified group or channel is not allocated.
nrfx_err_t nrfx_dppi_channel_remove_from_group ( uint8_t  channel,
nrf_dppi_channel_group_t  group 
)

Function for removing a DPPI channel from a channel group.

Parameters
[in]channelDPPI channel to be removed.
[in]groupChannel group from which to remove the channel.
Return values
NRFX_SUCCESSThe channel was successfully removed.
NRFX_ERROR_INVALID_PARAMThe specified group or channel is not allocated.
nrfx_err_t nrfx_dppi_group_alloc ( nrf_dppi_channel_group_t p_group)

Function for allocating a DPPI channel group.

This function allocates the first unused DPPI group.

Parameters
[out]p_groupPointer to the DPPI channel group that has been allocated.
Return values
NRFX_SUCCESSThe channel group was successfully allocated.
NRFX_ERROR_NO_MEMThere is no available channel group to be used.
nrfx_err_t nrfx_dppi_group_clear ( nrf_dppi_channel_group_t  group)

Function for clearing a DPPI channel group.

Parameters
[in]groupChannel group to be cleared.
Return values
NRFX_SUCCESSThe group was successfully cleared.
NRFX_ERROR_INVALID_PARAMThe specified group is not allocated.
nrfx_err_t nrfx_dppi_group_disable ( nrf_dppi_channel_group_t  group)

Function for disabling a DPPI channel group.

Parameters
[in]groupChannel group to be disabled.
Return values
NRFX_SUCCESSThe group was successfully disabled.
NRFX_ERROR_INVALID_PARAMThe specified group is not allocated.
nrfx_err_t nrfx_dppi_group_enable ( nrf_dppi_channel_group_t  group)

Function for enabling a DPPI channel group.

Parameters
[in]groupChannel group to be enabled.
Return values
NRFX_SUCCESSThe group was successfully enabled.
NRFX_ERROR_INVALID_PARAMThe specified group is not allocated.
nrfx_err_t nrfx_dppi_group_free ( nrf_dppi_channel_group_t  group)

Function for freeing a DPPI channel group.

This function also disables the chosen group.

Parameters
[in]groupDPPI channel group to be freed.
Return values
NRFX_SUCCESSThe channel group was successfully freed.
NRFX_ERROR_INVALID_PARAMThe specified group is not allocated.

Documentation feedback | Developer Zone | Subscribe | Updated