ppi_seq.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_DRIVERS_PPI_SEQ_PPI_SEQ_H
#define NRF_DRIVERS_PPI_SEQ_PPI_SEQ_H
 
#include <string.h>
#include <nrfx_timer.h>
#include <nrfx_grtc.h>
#include <helpers/nrfx_gppi.h>
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_PPI_SEQ_MAX_PPI_HANDLES
#define CONFIG_PPI_SEQ_MAX_PPI_HANDLES 8
#endif
 
/* Forward declaration. */
struct ppi_seq_config;
 
struct ppi_seq {
        const struct ppi_seq_config *config;
 
        nrfx_timer_t timer;
 
        nrfx_gppi_handle_t ppi_pool[CONFIG_PPI_SEQ_MAX_PPI_HANDLES];
 
        atomic_t repeat;
 
        uint16_t batch_cnt;
 
        uint8_t grtc_chan;
 
        uint8_t ppi_cnt;
};
 
typedef void (*ppi_seq_cb_t)(struct ppi_seq *ppi_seq, bool last);
 
enum ppi_seq_notifier_type {
        PPI_SEQ_NOTIFIER_SYS_TIMER,
 
        PPI_SEQ_NOTIFIER_NRFX_TIMER,
};
 
struct ppi_seq_notifier_sys_timer {
        struct k_timer timer;
 
        uint16_t offset;
 
        uint64_t timestamp;
 
        uint32_t period;
};
 
struct ppi_seq_notifier_nrfx_timer {
        nrfx_timer_t timer;
 
        uint32_t end_seq_event;
 
        /* Number of additional main operations in a cycle. For example if there
         * are 2 SPI transfers in each cycle then it should be set to 1.
         */
        uint16_t extra_main_ops;
};
 
struct ppi_seq_notifier {
        enum ppi_seq_notifier_type type;
        union {
                struct ppi_seq_notifier_sys_timer sys_timer;
 
                struct ppi_seq_notifier_nrfx_timer nrfx_timer;
        };
};
 
struct ppi_seq_extra_op {
        uint32_t task;
 
        uint32_t offset;
};
 
struct ppi_seq_config {
        struct ppi_seq_notifier *notifier;
 
        NRF_TIMER_Type *timer_reg;
 
#ifdef RTC_PRESENT
        NRF_RTC_Type *rtc_reg;
#endif
 
        ppi_seq_cb_t callback;
 
        uint32_t task;
 
        const struct ppi_seq_extra_op *extra_ops;
 
        size_t extra_ops_count;
 
        bool skip_gppi;
};
 
int ppi_seq_init(struct ppi_seq *seq, const struct ppi_seq_config *config);
 
void ppi_seq_uninit(struct ppi_seq *seq);
 
int ppi_seq_start(struct ppi_seq *seq, size_t period, size_t batch_cnt, int repeat);
 
int ppi_seq_stop(struct ppi_seq *seq, bool immediate);
 
void ppi_seq_rtc_irq_handler(struct ppi_seq *seq);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_DRIVERS_PPI_SEQ_PPI_SEQ_H */