epio.h

Go to the documentation of this file.

// Copyright (C) 2026 Piers Finlayson <piers@piers.rocks>
//
// MIT License
 
#if !defined(EPIO_H)
#define EPIO_H
 
#include <stdint.h>
#include <stddef.h>
#define APIO_EMULATION  1
#include <epio_wasm.h>
#include <apio.h>
 
typedef struct epio_t epio_t;
 
typedef struct {
    uint8_t first_instr;
    uint8_t start_instr;
    uint8_t end_instr;
} epio_sm_debug_t;
 
typedef struct {
    uint32_t clkdiv;
    uint32_t execctrl;
    uint32_t shiftctrl;
    uint32_t pinctrl;
} epio_sm_reg_t;
 
typedef enum {
    EPIO_FLOAT_LOW    = 0, 
    EPIO_FLOAT_HIGH   = 1, 
    EPIO_FLOAT_RANDOM = 2, 
} epio_float_mode_t;
 
EPIO_EXPORT epio_t *epio_init(void);
 
EPIO_EXPORT void epio_free(epio_t *epio);
 
EPIO_EXPORT void epio_set_sm_debug(epio_t *epio, uint8_t block, uint8_t sm, epio_sm_debug_t *debug);
 
EPIO_EXPORT void epio_get_sm_debug(epio_t *epio, uint8_t block, uint8_t sm, epio_sm_debug_t *debug);
 
EPIO_EXPORT void epio_set_gpiobase(epio_t *epio, uint8_t block, uint32_t gpio_base);
 
EPIO_EXPORT uint32_t epio_get_gpiobase(epio_t *epio, uint8_t block);
 
EPIO_EXPORT void epio_set_sm_reg(epio_t *epio, uint8_t block, uint8_t sm, epio_sm_reg_t *reg);
 
EPIO_EXPORT void epio_get_sm_reg(epio_t *epio, uint8_t block, uint8_t sm, epio_sm_reg_t *reg);
 
EPIO_EXPORT void epio_enable_sm(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_is_sm_enabled(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT void epio_disable_sm(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT void epio_set_instr(epio_t *epio, uint8_t block, uint8_t instr_num, uint16_t instr);
 
EPIO_EXPORT uint16_t epio_get_instr(epio_t *epio, uint8_t block, uint8_t instr_num);
 
EPIO_EXPORT void epio_force_sm_instr(epio_t *epio, uint8_t block, uint8_t sm, uint16_t instr);
 
EPIO_EXPORT void epio_step_cycles(epio_t *epio, uint32_t cycles);
 
EPIO_EXPORT uint64_t epio_get_cycle_count(epio_t *epio);
 
EPIO_EXPORT void epio_reset_cycle_count(epio_t *epio);
 
EPIO_EXPORT int32_t epio_wait_tx_fifo(epio_t *epio, uint8_t block, uint8_t sm, int32_t count);
 
EPIO_EXPORT uint8_t epio_tx_fifo_depth(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_rx_fifo_depth(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_pop_rx_fifo(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_pop_tx_fifo(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT void epio_push_tx_fifo(epio_t *epio, uint8_t block, uint8_t sm, uint32_t value);
 
EPIO_EXPORT void epio_push_rx_fifo(epio_t *epio, uint8_t block, uint8_t sm, uint32_t value);
 
EPIO_EXPORT void epio_drive_gpios_ext(epio_t *epio, uint64_t gpios, uint64_t level);
 
void epio_set_gpio_input_inverted(epio_t *epio, uint8_t pin, uint8_t inverted);
 
uint8_t epio_get_gpio_input_inverted(epio_t *epio, uint8_t pin);
 
void epio_set_gpio_output_control(epio_t *epio, uint8_t pin, uint8_t block);
 
void epio_clear_gpio_output_control(epio_t *epio, uint8_t pin, uint8_t block);
 
uint8_t epio_block_can_control_gpio_output(epio_t *epio, uint8_t block, uint8_t pin);
 
uint64_t epio_get_gpio_output_control(epio_t *epio, uint8_t block);
 
EPIO_EXPORT uint8_t epio_get_gpio_input(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_init_gpios(epio_t *epio);
 
EPIO_EXPORT void epio_set_gpio_force_input_low(epio_t *epio, uint8_t pin, uint8_t force_low);
 
EPIO_EXPORT void epio_set_gpio_force_input_high(epio_t *epio, uint8_t pin, uint8_t force_high);
 
EPIO_EXPORT uint8_t epio_get_gpio_force_input_low(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT uint8_t epio_get_gpio_force_input_high(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_gpio_input(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_gpio_output(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_gpio_input_level(epio_t *epio, uint8_t pin, uint8_t level);
 
EPIO_EXPORT void epio_set_gpio_output_level(epio_t *epio, uint8_t pin, uint8_t level);
 
EPIO_EXPORT uint64_t epio_read_pin_states(epio_t *epio);
 
EPIO_EXPORT uint64_t epio_read_driven_pins(epio_t *epio);
 
EPIO_EXPORT uint64_t epio_read_pull_up_pins(epio_t *epio);
 
EPIO_EXPORT uint64_t epio_read_pull_down_pins(epio_t *epio);
 
EPIO_EXPORT void epio_set_gpio_pull_up(epio_t *epio, uint8_t pin, uint8_t enable);
 
EPIO_EXPORT void epio_set_gpio_pull_down(epio_t *epio, uint8_t pin, uint8_t enable);
 
EPIO_EXPORT void epio_set_gpio_pull_none(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT uint8_t epio_get_gpio_pull_up(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT uint8_t epio_get_gpio_pull_down(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_gpio_input_only(epio_t *epio, uint8_t pin, uint8_t input_only);
 
EPIO_EXPORT uint8_t epio_get_gpio_input_only(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_gpio_drive(epio_t *epio, uint8_t pin, uint8_t strength);
 
EPIO_EXPORT uint8_t epio_get_gpio_drive(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_gpio_slew_fast(epio_t *epio, uint8_t pin, uint8_t fast);
 
EPIO_EXPORT uint8_t epio_get_gpio_slew_fast(epio_t *epio, uint8_t pin);
 
EPIO_EXPORT void epio_set_float_mode(epio_t *epio, epio_float_mode_t mode);
 
EPIO_EXPORT void epio_set_float_seed(epio_t *epio, uint32_t seed);
 
EPIO_EXPORT void epio_dma_setup_read_pio_chain(
    epio_t *epio,
    uint8_t dma_chan,
    uint8_t read_block,
    uint8_t read_sm,
    uint8_t read_cycles,
    uint8_t write_block,
    uint8_t write_sm,
    uint8_t write_cycles,
    uint8_t bit_mode
);
 
EPIO_EXPORT void epio_dma_setup_capture_pio_ring(
    epio_t *epio,
    uint8_t dma_chan,
    uint8_t src_block,
    uint8_t src_sm,
    uint8_t src_cycles,
    uint32_t ring_base,
    uint8_t ring_size_log2,
    uint8_t bit_mode
);
 
EPIO_EXPORT uint8_t **epio_dma_capture_write_slot(epio_t *epio, uint8_t dma_chan);
 
EPIO_EXPORT uint8_t *epio_get_sram_ptr(epio_t *epio);
 
EPIO_EXPORT uint8_t epio_sram_read_byte(epio_t *epio, uint32_t addr);
 
EPIO_EXPORT void epio_sram_set(epio_t *epio, uint32_t addr, uint8_t *data, size_t len);
 
EPIO_EXPORT uint16_t epio_sram_read_halfword(epio_t *epio, uint32_t addr);
 
EPIO_EXPORT uint32_t epio_sram_read_word(epio_t *epio, uint32_t addr);
 
EPIO_EXPORT void epio_sram_write_byte(epio_t *epio, uint32_t addr, uint8_t value);
 
EPIO_EXPORT void epio_sram_write_halfword(epio_t *epio, uint32_t addr, uint16_t value);
 
EPIO_EXPORT void epio_sram_write_word(epio_t *epio, uint32_t addr, uint32_t value);
 
EPIO_EXPORT uint8_t epio_peek_sm_pc(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_peek_sm_x(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_peek_sm_y(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_peek_sm_isr(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_peek_sm_osr(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_peek_sm_isr_count(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_peek_sm_osr_count(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_peek_sm_osr_empty(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_peek_sm_stalled(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_peek_sm_delay(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint8_t epio_peek_sm_exec_pending(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint16_t epio_peek_sm_exec_instr(epio_t *epio, uint8_t block, uint8_t sm);
 
EPIO_EXPORT uint32_t epio_peek_block_irq(epio_t *epio, uint8_t block);
 
EPIO_EXPORT uint8_t epio_peek_block_irq_num(epio_t *epio, uint8_t block, uint8_t irq_num);
 
EPIO_EXPORT uint32_t epio_peek_rx_fifo(epio_t *epio, uint8_t block, uint8_t sm, uint8_t entry);
 
EPIO_EXPORT uint32_t epio_peek_tx_fifo(epio_t *epio, uint8_t block, uint8_t sm, uint8_t entry);
 
EPIO_EXPORT void epio_set_block_irq(epio_t *epio, uint8_t block, uint8_t irq_num);
 
EPIO_EXPORT void epio_clear_block_irq(epio_t *epio, uint8_t block, uint8_t irq_num);
 
EPIO_EXPORT epio_t *epio_from_apio(void);
 
EPIO_EXPORT void epio_update_from_apio(epio_t *epio);
 
EPIO_EXPORT int epio_disassemble_sm(epio_t *epio, uint8_t block, uint8_t sm, char *buffer, size_t buffer_size);
 
#define NUM_GPIOS 48
_Static_assert(NUM_GPIOS <= 64, "NUM_GPIOS must be <= 64 to fit in uint64_t");
_Static_assert(NUM_GPIOS == APIO_MAX_GPIOS, "NUM_GPIOS must match APIO_MAX_GPIOS");
 
#define NUM_PIO_BLOCKS          3
 
#define NUM_SMS_PER_BLOCK       4
 
#define MAX_FIFO_DEPTH          4
 
#define NUM_DMA_CHANNELS        16
 
#define NUM_IRQS_PER_BLOCK      8
 
#define NUM_INSTRS_PER_BLOCK    32
 
#endif // EPIO_H