70  * This function disables all channels and clears the channel groups.
75  * @brief Function for allocating a PPI channel.
76  * @details This function allocates the first unused PPI channel.
78  * @param[out] p_channel Pointer to the PPI channel that has been allocated.
80  * @retval NRFX_SUCCESS      If the channel was successfully allocated.
81  * @retval NRFX_ERROR_NO_MEM If there is no available channel to be used.
86  * @brief Function for freeing a PPI channel.
87  * @details This function also disables the chosen channel.
89  * @param[in] channel PPI channel to be freed.
91  * @retval NRFX_SUCCESS             If the channel was successfully freed.
92  * @retval NRFX_ERROR_INVALID_PARAM If the channel is not user-configurable.
94 nrfx_err_t nrfx_ppi_channel_free(nrf_ppi_channel_t channel);
97  * @brief Function for assigning task and event endpoints to the PPI channel.
99  * @param[in] channel PPI channel to be assigned endpoints.
103  * @retval NRFX_SUCCESS             If the channel was successfully assigned.
104  * @retval NRFX_ERROR_INVALID_STATE If the channel is not allocated for the user.
105  * @retval NRFX_ERROR_INVALID_PARAM If the channel is not user-configurable.
107 nrfx_err_t nrfx_ppi_channel_assign(nrf_ppi_channel_t channel, uint32_t eep, uint32_t tep);
110  * @brief Function for assigning or clearing fork endpoint to the PPI channel.
112  * @param[in] channel  PPI channel to be assigned endpoints.
115  * @retval NRFX_SUCCESS             If the channel was successfully assigned.
116  * @retval NRFX_ERROR_INVALID_STATE If the channel is not allocated for the user.
119 nrfx_err_t nrfx_ppi_channel_fork_assign(nrf_ppi_channel_t channel, uint32_t fork_tep);
122  * @brief Function for enabling a PPI channel.
124  * @param[in] channel PPI channel to be enabled.
126  * @retval NRFX_SUCCESS             If the channel was successfully enabled.
127  * @retval NRFX_ERROR_INVALID_STATE If the user-configurable channel is not allocated.
128  * @retval NRFX_ERROR_INVALID_PARAM If the channel cannot be enabled by the user.
130 nrfx_err_t nrfx_ppi_channel_enable(nrf_ppi_channel_t channel);
133  * @brief Function for disabling a PPI channel.
135  * @param[in] channel PPI channel to be disabled.
137  * @retval NRFX_SUCCESS             If the channel was successfully disabled.
138  * @retval NRFX_ERROR_INVALID_STATE If the user-configurable channel is not allocated.
139  * @retval NRFX_ERROR_INVALID_PARAM If the channel cannot be disabled by the user.
141 nrfx_err_t nrfx_ppi_channel_disable(nrf_ppi_channel_t channel);
144  * @brief Function for allocating a PPI channel group.
147  * @param[out] p_group Pointer to the PPI channel group that has been allocated.
149  * @retval NRFX_SUCCESS      If the channel group was successfully allocated.
150  * @retval NRFX_ERROR_NO_MEM If there is no available channel group to be used.
155  * @brief Function for freeing a PPI channel group.
158  * @param[in] group PPI channel group to be freed.
160  * @retval NRFX_SUCCESS             If the channel group was successfully freed.
161  * @retval NRFX_ERROR_INVALID_PARAM If the channel group is not user-configurable.
166  * @brief  Compute a channel mask for NRF_PPI registers.
168  * @param[in] channel Channel number to transform to a mask.
170  * @retval Channel mask.
172 __STATIC_INLINE uint32_t nrfx_ppi_channel_to_mask(nrf_ppi_channel_t channel)  in nrfx_ppi_channel_to_mask()  argument
174     return (1uL << (uint32_t) channel);  in nrfx_ppi_channel_to_mask()
178  * @brief Function for including multiple PPI channels in a channel group.
181  * @param[in] group        Channel group in which to include the channels.
192  * @brief Function for including a PPI channel in a channel group.
194  * @param[in] channel PPI channel to be added.
195  * @param[in] group   Channel group in which to include the channel.
197  * @retval NRFX_SUCCESS             If the channel was successfully included.
198  * @retval NRFX_ERROR_INVALID_PARAM If group is not an application group or channel is not an
199  *                                  application channel.
202 __STATIC_INLINE nrfx_err_t nrfx_ppi_channel_include_in_group(nrf_ppi_channel_t       channel,  in nrfx_ppi_channel_include_in_group()  argument
205     return nrfx_ppi_channels_include_in_group(nrfx_ppi_channel_to_mask(channel), group);  in nrfx_ppi_channel_include_in_group()
209  * @brief Function for removing multiple PPI channels from a channel group.
212  * @param[in] group        Channel group from which to remove the channels.
214  * @retval NRFX_SUCCESS             If the channel was successfully removed.
223  * @brief Function for removing a PPI channel from a channel group.
225  * @param[in] channel PPI channel to be removed.
226  * @param[in] group   Channel group from which to remove the channel.
228  * @retval NRFX_SUCCESS             If the channel was successfully removed.
229  * @retval NRFX_ERROR_INVALID_PARAM If group is not an application group or channel is not an
230  *                                  application channel.
233 __STATIC_INLINE nrfx_err_t nrfx_ppi_channel_remove_from_group(nrf_ppi_channel_t       channel,  in nrfx_ppi_channel_remove_from_group()  argument
236     return nrfx_ppi_channels_remove_from_group(nrfx_ppi_channel_to_mask(channel), group);  in nrfx_ppi_channel_remove_from_group()
240  * @brief Function for clearing a PPI channel group.
242  * @param[in] group Channel group to be cleared.
254  * @brief Function for enabling a PPI channel group.
256  * @param[in] group Channel group to be enabled.
265  * @brief Function for disabling a PPI channel group.
267  * @param[in] group Channel group to be disabled.
290  * @param[in] group PPI channel group
302  * @param[in] group PPI channel group