i2c.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014-2017 Freie Universität Berlin
 *
 * 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_I2C_H
#define PERIPH_I2C_H
 
#include <stdint.h>
#include <stddef.h>
#include <limits.h>
 
#include "periph_conf.h"
#include "periph_cpu.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef I2C_DEV
#define I2C_DEV(x)          (x)
#endif
 
#ifndef I2C_UNDEF
#define I2C_UNDEF           (UINT_MAX)
#endif
 
#ifndef HAVE_I2C_T
typedef unsigned int i2c_t;
#endif
 
#define I2C_READ            (0x0001)
 
#define I2C_10BIT_MAGIC     (0xF0u)
 
#ifndef HAVE_I2C_SPEED_T
typedef enum {
    I2C_SPEED_LOW = 0,      
    I2C_SPEED_NORMAL,       
    I2C_SPEED_FAST,         
    I2C_SPEED_FAST_PLUS,    
    I2C_SPEED_HIGH,         
} i2c_speed_t;
#endif
 
#ifndef HAVE_I2C_FLAGS_T
typedef enum {
    I2C_ADDR10  = 0x01,     
    I2C_REG16   = 0x02,     
    I2C_NOSTOP  = 0x04,     
    I2C_NOSTART = 0x08,     
} i2c_flags_t;
#endif
 
void i2c_init(i2c_t dev);
 
void i2c_init_pins(i2c_t dev);
 
void i2c_deinit_pins(i2c_t dev);
 
#if DOXYGEN /* functions to be implemented as `#define` in `periph_cpu.h` */
 
gpio_t i2c_pin_sda(i2c_t dev);
 
gpio_t i2c_pin_scl(i2c_t dev);
#endif /* DOXYGEN */
 
int i2c_acquire(i2c_t dev);
 
void i2c_release(i2c_t dev);
 
int i2c_read_reg(i2c_t dev, uint16_t addr, uint16_t reg,
                 void *data, uint8_t flags);
 
int i2c_read_regs(i2c_t dev, uint16_t addr, uint16_t reg,
                  void *data, size_t len, uint8_t flags);
 
int i2c_read_byte(i2c_t dev, uint16_t addr, void *data, uint8_t flags);
 
int i2c_read_bytes(i2c_t dev, uint16_t addr,
                   void *data, size_t len, uint8_t flags);
 
int i2c_write_byte(i2c_t dev, uint16_t addr, uint8_t data, uint8_t flags);
 
int i2c_write_bytes(i2c_t dev, uint16_t addr, const void *data,
                    size_t len, uint8_t flags);
 
int i2c_write_reg(i2c_t dev, uint16_t addr, uint16_t reg,
                  uint8_t data, uint8_t flags);
 
int i2c_write_regs(i2c_t dev, uint16_t addr, uint16_t reg,
                  const void *data, size_t len, uint8_t flags);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* PERIPH_I2C_H */