spi.h

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_SPI_H
#define OVE_SPI_H
 
#include "ove/types.h"
#include "ove_config.h"
#include "ove/storage.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ── Enums ───────────────────────────────────────────────────────── */
 
typedef enum {
    OVE_SPI_MODE_0 = 0, 
    OVE_SPI_MODE_1 = 1, 
    OVE_SPI_MODE_2 = 2, 
    OVE_SPI_MODE_3 = 3, 
} ove_spi_mode_t;
 
typedef enum {
    OVE_SPI_MSB_FIRST = 0, 
    OVE_SPI_LSB_FIRST = 1, 
} ove_spi_bit_order_t;
 
/* ── Configuration ───────────────────────────────────────────────── */
 
struct ove_spi_cfg {
    unsigned int        instance;  
    uint32_t            clock_hz;  
    ove_spi_mode_t      mode;      
    ove_spi_bit_order_t bit_order; 
    uint8_t             word_size; 
};
 
struct ove_spi_cs {
    unsigned int gpio_port; 
    unsigned int gpio_pin;  
    int          active_low;
};
 
struct ove_spi_xfer {
    const void *tx;  
    void       *rx;  
    size_t      len; 
};
 
#ifdef CONFIG_OVE_SPI
 
/* ── Lifecycle ───────────────────────────────────────────────────── */
 
int  ove_spi_init(ove_spi_t *spi, ove_spi_storage_t *storage,
          const struct ove_spi_cfg *cfg);
void ove_spi_deinit(ove_spi_t spi);
 
#ifdef OVE_HEAP_SPI
int  ove_spi_create(ove_spi_t *spi, const struct ove_spi_cfg *cfg);
void ove_spi_destroy(ove_spi_t spi);
#elif !defined(__ZIG_CIMPORT__)
#define ove_spi_create(pspi, cfg) \
    ({ static ove_spi_storage_t _ove_stor_; \
       ove_spi_init((pspi), &_ove_stor_, (cfg)); })
#define ove_spi_destroy(spi) ove_spi_deinit(spi)
#endif
 
/* ── Operations ──────────────────────────────────────────────────── */
 
int  ove_spi_transfer(ove_spi_t spi, const struct ove_spi_cs *cs,
              const void *tx, void *rx, size_t len,
              uint32_t timeout_ms);
 
int  ove_spi_write(ove_spi_t spi, const struct ove_spi_cs *cs,
           const void *data, size_t len, uint32_t timeout_ms);
 
int  ove_spi_read(ove_spi_t spi, const struct ove_spi_cs *cs,
          void *buf, size_t len, uint32_t timeout_ms);
 
int  ove_spi_transfer_seq(ove_spi_t spi, const struct ove_spi_cs *cs,
              const struct ove_spi_xfer *xfers,
              unsigned int num_xfers,
              uint32_t timeout_ms);
 
#else /* !CONFIG_OVE_SPI */
 
static inline int  ove_spi_create(ove_spi_t *s, const struct ove_spi_cfg *c) { (void)s; (void)c; return OVE_ERR_NOT_SUPPORTED; }
static inline void ove_spi_destroy(ove_spi_t s) { (void)s; }
static inline int  ove_spi_transfer(ove_spi_t s, const struct ove_spi_cs *cs, const void *tx, void *rx, size_t l, uint32_t t) { (void)s; (void)cs; (void)tx; (void)rx; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_spi_write(ove_spi_t s, const struct ove_spi_cs *cs, const void *d, size_t l, uint32_t t) { (void)s; (void)cs; (void)d; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_spi_read(ove_spi_t s, const struct ove_spi_cs *cs, void *b, size_t l, uint32_t t) { (void)s; (void)cs; (void)b; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_spi_transfer_seq(ove_spi_t s, const struct ove_spi_cs *cs, const struct ove_spi_xfer *x, unsigned int n, uint32_t t) { (void)s; (void)cs; (void)x; (void)n; (void)t; return OVE_ERR_NOT_SUPPORTED; }
 
#endif /* CONFIG_OVE_SPI */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_SPI_H */