mira_i2c.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (C) 2016 LumenRadio AB                                         *
 *                                                                          *
 * This file is part of MiraOS.                                             *
 *                                                                          *
 *   MiraOS contains software components that are patented by LumenRadio.   *
 *   Use of this software is under the terms of the LumenRadio MiraOS       *
 *   license.
 *                                                                          *
 *   You should have received a copy of the MiraOS license from your        *
 *   LumenRadio representative. If not, email to <licenses@lumenradio.com>  *
 ****************************************************************************/

#ifndef LIBMIRA_I2C_H_
#define LIBMIRA_I2C_H_

#include <stdint.h>

typedef enum {
    MIRA_I2C_NORMAL_BUS_SPEED = 100000,     
    MIRA_I2C_FAST_BUS_SPEED =   400000      
} MiraI2CSpeed;

typedef enum {
    MIRA_I2C_NO_PULLUPS =   0,  
    MIRA_I2C_USE_PULLUPS =  1   
} MiraI2CPullupMode;

typedef enum {
    MIRA_I2C_MASTER_ERR_NONE        = 0x00,     
    MIRA_I2C_MASTER_ERR_ADDR_ACK    = 0x04,     
    MIRA_I2C_MASTER_ERR_DATA_ACK    = 0x08,     
    MIRA_I2C_MASTER_ERR_ARB_LOST    = 0x10,     
    MIRA_I2C_MASTER_ERR_TIMEOUT     = 0x80,     
} MiraI2CErrorCodeFlags;

void mira_i2c_init(MiraI2CSpeed speed, MiraI2CPullupMode pullups);

MiraI2CErrorCodeFlags mira_i2c_single_send(uint8_t address, uint8_t data);

MiraI2CErrorCodeFlags mira_i2c_single_receive(uint8_t address, uint8_t* data_pointer);

MiraI2CErrorCodeFlags mira_i2c_burst_send(uint8_t address, uint8_t* data_pointer, uint8_t length);

MiraI2CErrorCodeFlags mira_i2c_burst_receive(uint8_t address, uint8_t* data_pointer, uint8_t length);

MiraI2CErrorCodeFlags mira_i2c_generic_single_send(uint8_t address, uint8_t data, uint8_t send_start_and_address, uint8_t send_stop);

MiraI2CErrorCodeFlags mira_i2c_generic_single_receive(uint8_t address, uint8_t* data_pointer, uint8_t send_start_and_address, uint8_t send_stop);

#endif /* LIBMIRA_I2C_H_ */