i2c.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_I2C_H
#define OVE_I2C_H
 
#include "ove/types.h"
#include "ove_config.h"
#include "ove/storage.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ── Enums ───────────────────────────────────────────────────────── */
 
typedef enum {
    OVE_I2C_SPEED_STANDARD  = 0, 
    OVE_I2C_SPEED_FAST      = 1, 
    OVE_I2C_SPEED_FAST_PLUS = 2, 
} ove_i2c_speed_t;
 
/* ── Configuration ───────────────────────────────────────────────── */
 
struct ove_i2c_cfg {
    unsigned int    instance; 
    ove_i2c_speed_t speed;    
};
 
#ifdef CONFIG_OVE_I2C
 
/* ── Lifecycle ───────────────────────────────────────────────────── */
 
int  ove_i2c_init(ove_i2c_t *i2c, ove_i2c_storage_t *storage,
          const struct ove_i2c_cfg *cfg);
 
void ove_i2c_deinit(ove_i2c_t i2c);
 
#ifdef OVE_HEAP_I2C
int  ove_i2c_create(ove_i2c_t *i2c, const struct ove_i2c_cfg *cfg);
 
void ove_i2c_destroy(ove_i2c_t i2c);
#elif !defined(__ZIG_CIMPORT__)
#define ove_i2c_create(pi2c, cfg) \
    ({ static ove_i2c_storage_t _ove_stor_; \
       ove_i2c_init((pi2c), &_ove_stor_, (cfg)); })
#define ove_i2c_destroy(i2c) ove_i2c_deinit(i2c)
#endif
 
/* ── Operations ──────────────────────────────────────────────────── */
 
int  ove_i2c_write(ove_i2c_t i2c, uint16_t addr,
           const void *data, size_t len, uint32_t timeout_ms);
 
int  ove_i2c_read(ove_i2c_t i2c, uint16_t addr,
          void *buf, size_t len, uint32_t timeout_ms);
 
int  ove_i2c_write_read(ove_i2c_t i2c, uint16_t addr,
            const void *tx, size_t tx_len,
            void *rx, size_t rx_len,
            uint32_t timeout_ms);
 
/* ── Register convenience ────────────────────────────────────────── */
 
#define OVE_I2C_REG_WRITE_MAX  32
 
int  ove_i2c_reg_write(ove_i2c_t i2c, uint16_t addr, uint8_t reg,
               const void *data, size_t len,
               uint32_t timeout_ms);
 
int  ove_i2c_reg_read(ove_i2c_t i2c, uint16_t addr, uint8_t reg,
              void *buf, size_t len, uint32_t timeout_ms);
 
/* ── Bus probe ───────────────────────────────────────────────────── */
 
int  ove_i2c_probe(ove_i2c_t i2c, uint16_t addr, uint32_t timeout_ms);
 
#else /* !CONFIG_OVE_I2C */
 
static inline int  ove_i2c_create(ove_i2c_t *i, const struct ove_i2c_cfg *c) { (void)i; (void)c; return OVE_ERR_NOT_SUPPORTED; }
static inline void ove_i2c_destroy(ove_i2c_t i) { (void)i; }
static inline int  ove_i2c_write(ove_i2c_t i, uint16_t a, const void *d, size_t l, uint32_t t) { (void)i; (void)a; (void)d; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2c_read(ove_i2c_t i, uint16_t a, void *b, size_t l, uint32_t t) { (void)i; (void)a; (void)b; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2c_write_read(ove_i2c_t i, uint16_t a, const void *tx, size_t tl, void *rx, size_t rl, uint32_t t) { (void)i; (void)a; (void)tx; (void)tl; (void)rx; (void)rl; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2c_reg_write(ove_i2c_t i, uint16_t a, uint8_t r, const void *d, size_t l, uint32_t t) { (void)i; (void)a; (void)r; (void)d; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2c_reg_read(ove_i2c_t i, uint16_t a, uint8_t r, void *b, size_t l, uint32_t t) { (void)i; (void)a; (void)r; (void)b; (void)l; (void)t; return OVE_ERR_NOT_SUPPORTED; }
static inline int  ove_i2c_probe(ove_i2c_t i, uint16_t a, uint32_t t) { (void)i; (void)a; (void)t; return OVE_ERR_NOT_SUPPORTED; }
 
#endif /* CONFIG_OVE_I2C */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_I2C_H */