esp_sdr_ring.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

 
#ifndef ESP_SDR_ESP_SDR_RING_H_
#define ESP_SDR_ESP_SDR_RING_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <esp_sdr/esp_sdr.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define ESP_SDR_RING_RATE_HZ 16000000U

#define ESP_SDR_RING_DECIM_MIN 64U
#define ESP_SDR_RING_DECIM_MAX 1024U

#define ESP_SDR_RING_FULL_SCALE 16384

#define ESP_SDR_RING_DECIM_BOX4       4U
#define ESP_SDR_RING_BOX4_FULL_SCALE  8192

#define ESP_SDR_RING_DECIM_RAW        1U
#define ESP_SDR_RING_RAW_FULL_SCALE   32768
#define ESP_SDR_RING_RAW_HISTORY      64U

typedef void (*esp_sdr_ring_sink_t)(void *user, const int16_t *i, const int16_t *q, size_t n,
                                    uint64_t index);
 
struct esp_sdr_ring_cfg {
        unsigned int decim;
        bool shift_fs4;
        esp_sdr_ring_sink_t sink;
        void *user;
        bool subsample;
        uint32_t unit_pairs;
        bool spare_bank;
        bool spare_bank_app;
};

#define ESP_SDR_RING_UNIT_DEFAULT 12288U
#define ESP_SDR_RING_UNIT_MIN     1024U

enum esp_sdr_ring_status {
        ESP_SDR_RING_OK = 0,
        ESP_SDR_RING_LATE,
        ESP_SDR_RING_AGE,
        ESP_SDR_RING_START,
        ESP_SDR_RING_END,
        ESP_SDR_RING_LENGTH,
};
 
struct esp_sdr_ring_stats {
        uint64_t pairs, samples;
        uint64_t elapsed_us;
        uint32_t units, abandoned, lost_pairs;
        uint32_t late_max;
        uint32_t slice_max, cycles_x100;
        uint32_t gain_refreshed;
        uint32_t stalls;
        uint32_t irq_windows;
        uint32_t irq_lines;
        enum esp_sdr_ring_status status;
        uint32_t detail;
};

int esp_sdr_ring_run(const struct esp_sdr_ring_cfg *cfg, struct esp_sdr_ring_stats *stats);

bool esp_sdr_ring_wmac_hold(void);

void esp_sdr_ring_wmac_release(bool was_enabled);
 
struct esp_sdr_ring_bench_result {
        uint32_t pairs, samples;
        /*
         * Filter cycles per input pair x 100: all, and unpack, stage 1, stage 2, sink. Raw mode:
         * unpack, the sink, nothing, the history kept for the sink.
         */
        uint32_t cycles_x100, stage_x100[4];
};

int esp_sdr_ring_bench(const struct esp_sdr_ring_cfg *cfg, unsigned int units,
                       struct esp_sdr_ring_bench_result *res);

void esp_sdr_ring_stop(void);

bool esp_sdr_ring_active(void);

bool esp_sdr_ring_now(uint64_t *pair);


typedef void (*esp_sdr_ring_gen_t)(void *user, uint32_t *dst, uint64_t index, uint32_t n);

uint32_t *esp_sdr_ring_burst_buf(size_t *words);

int esp_sdr_ring_burst_arm(uint64_t end_pair, uint64_t limit_pair, esp_sdr_ring_gen_t gen,
                           void *user, uint32_t from, uint32_t words);

bool esp_sdr_ring_burst_fire(uint64_t at_pair);

void esp_sdr_ring_burst_cancel(void);

bool esp_sdr_ring_burst_busy(void);

struct esp_sdr_ring_burst_stats {
        uint32_t fired, cancelled, timeouts, skipped;
        uint32_t late, late_tx;
        uint32_t arm_late;
        int32_t fire_last_pairs, fire_min_pairs, fire_max_pairs;
        int32_t stop_last_pairs, ready_last_pairs, seen_last_pairs, rx_back_last_pairs;
        uint32_t dac_last_cyc;
        int32_t ready_max_pairs, seen_max_pairs;
        uint32_t window_max_cyc;
        uint32_t gen_left_max;
};
 
void esp_sdr_ring_burst_get_stats(struct esp_sdr_ring_burst_stats *stats);


 
#ifdef __cplusplus
}
#endif
 
#endif /* ESP_SDR_ESP_SDR_RING_H_ */