i2c.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Otto-von-Guericke Universität Magdeburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef PERIPH_PIO_I2C_H
#define PERIPH_PIO_I2C_H
 
#include "periph/i2c.h"
#include "periph/pio.h"
#include "mutex.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef i2c_t pio_i2c_t;
 
typedef struct pio_program_i2c {
    pio_program_t base; 
    unsigned ref_mask;  
} pio_program_i2c_t;
 
typedef struct pio_i2c_bus {
    pio_t pio;              
    pio_sm_t sm;            
    mutex_t mtx;            
} pio_i2c_bus_t;
 
pio_i2c_bus_t *pio_i2c_get(pio_i2c_t id);
 
unsigned pio_i2c_numof(void);
 
const pio_program_i2c_t *pio_i2c_get_program(pio_t pio);
 
int pio_i2c_init_program(pio_t pio);
 
void pio_i2c_deinit_program(pio_t pio);
 
pio_sm_t pio_i2c_sm_lock(pio_t pio, pio_i2c_bus_t *i2c);
 
void pio_i2c_sm_unlock(pio_i2c_bus_t *i2c);
 
void pio_i2c_start_programs(void);
 
void pio_i2c_stop_programs(void);
 
int pio_i2c_write_program(pio_t pio, pio_program_i2c_t *pro);
 
int pio_i2c_init(pio_i2c_bus_t *bus,
                 const pio_program_i2c_t *pro,
                 gpio_t sda, gpio_t scl, unsigned irq);
 
void pio_i2c_acquire(pio_i2c_bus_t *bus);
 
void pio_i2c_release(pio_i2c_bus_t *bus);
 
int pio_i2c_read_regs(pio_t pio, pio_sm_t sm, uint16_t addr,
                      uint16_t reg, void *data, size_t len, uint8_t flags);
 
static inline int pio_i2c_read_reg(pio_t pio, pio_sm_t sm, uint16_t addr,
                                   uint16_t reg, void *data, uint8_t flags)
{
    return pio_i2c_read_regs(pio, sm, addr, reg, data, 1, flags);
}
 
int pio_i2c_read_bytes(pio_t pio, pio_sm_t sm, uint16_t addr,
                       void *data, size_t len, uint8_t flags);
 
static inline int pio_i2c_read_byte(pio_t pio, pio_sm_t sm, uint16_t addr,
                                    void *data, uint8_t flags)
{
    return pio_i2c_read_bytes(pio, sm, addr, data, 1, flags);
}
 
int pio_i2c_write_bytes(pio_t pio, pio_sm_t sm, uint16_t addr,
                        const void *data, size_t len, uint8_t flags);
 
static inline int pio_i2c_write_byte(pio_t pio, pio_sm_t sm, uint16_t addr,
                                     uint8_t data, uint8_t flags)
{
    return pio_i2c_write_bytes(pio, sm, addr, &data, 1, flags);
}
 
int pio_i2c_write_regs(pio_t pio, pio_sm_t sm, uint16_t addr,
                       uint16_t reg, const void *data, size_t len, uint8_t flags);
 
static inline int pio_i2c_write_reg(pio_t pio, pio_sm_t sm, uint16_t addr,
                                    uint16_t reg, uint8_t data, uint8_t flags)
{
    return pio_i2c_write_regs(pio, sm, addr, reg, &data, 1, flags);
}
 
#ifdef __cplusplus
}
#endif
#endif /* PERIPH_PIO_I2C_H */