sol-i2c.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>

#include <sol-macros.h>
#include <sol-buffer.h>

#ifdef __cplusplus
extern "C" {
#endif

struct sol_i2c;
typedef struct sol_i2c sol_i2c;


struct sol_i2c_pending;
typedef struct sol_i2c_pending sol_i2c_pending;

enum sol_i2c_speed {
    SOL_I2C_SPEED_10KBIT = 0, 
    SOL_I2C_SPEED_100KBIT, 
    SOL_I2C_SPEED_400KBIT, 
    SOL_I2C_SPEED_1MBIT, 
    SOL_I2C_SPEED_3MBIT_400KBIT 
};

enum sol_i2c_speed sol_i2c_speed_from_str(const char *speed)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_i2c_speed_to_str(enum sol_i2c_speed speed)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

struct sol_i2c *sol_i2c_open_raw(uint8_t bus, enum sol_i2c_speed speed)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

struct sol_i2c *sol_i2c_open(uint8_t bus, enum sol_i2c_speed speed)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

void sol_i2c_close(struct sol_i2c *i2c);

int sol_i2c_set_slave_address(struct sol_i2c *i2c, uint8_t slave_address);

uint8_t sol_i2c_get_slave_address(struct sol_i2c *i2c);

struct sol_i2c_pending *sol_i2c_write_quick(struct sol_i2c *i2c, bool rw, void (*write_quick_cb)(void *cb_data, struct sol_i2c *i2c, ssize_t status), const void *cb_data);

struct sol_i2c_pending *sol_i2c_read(struct sol_i2c *i2c, uint8_t *data, size_t count, void (*read_cb)(void *cb_data, struct sol_i2c *i2c, uint8_t *data, ssize_t status), const void *cb_data);

struct sol_i2c_pending *sol_i2c_write(struct sol_i2c *i2c, uint8_t *data, size_t count, void (*write_cb)(void *cb_data, struct sol_i2c *i2c, uint8_t *data, ssize_t status), const void *cb_data);

struct sol_i2c_pending *sol_i2c_read_register(struct sol_i2c *i2c, uint8_t reg, uint8_t *data, size_t count, void (*read_reg_cb)(void *cb_data, struct sol_i2c *i2c, uint8_t reg, uint8_t *data, ssize_t status), const void *cb_data);

struct sol_i2c_pending *sol_i2c_write_register(struct sol_i2c *i2c, uint8_t reg, const uint8_t *data, size_t count, void (*write_reg_cb)(void *cb_data, struct sol_i2c *i2c, uint8_t reg, uint8_t *data, ssize_t status), const void *cb_data);

struct sol_i2c_pending *sol_i2c_read_register_multiple(struct sol_i2c *i2c, uint8_t reg, uint8_t *values, size_t count, uint8_t times, void (*read_reg_multiple_cb)(void *cb_data, struct sol_i2c *i2c, uint8_t reg, uint8_t *data, ssize_t status), const void *cb_data);

uint8_t sol_i2c_get_bus(const struct sol_i2c *i2c);

void sol_i2c_pending_cancel(struct sol_i2c *i2c, struct sol_i2c_pending *pending);

#ifdef SOL_PLATFORM_LINUX

int sol_i2c_create_device(const char *address, const char *dev_name, unsigned int dev_number, struct sol_buffer *result_path);
#endif

enum sol_i2c_op_type {
    SOL_I2C_READ,
    SOL_I2C_WRITE
};

struct sol_i2c_op {
    enum sol_i2c_op_type type; 
    uint8_t reg; 
    uint8_t value; 
};

struct sol_i2c_op_set_pending;
typedef struct sol_i2c_op_set_pending sol_i2c_op_set_pending;

struct sol_i2c_op_set_pending *sol_i2c_dispatcher_add_op_set(struct sol_i2c *i2c, uint8_t addr, struct sol_vector *set, void (*cb)(void *cb_data, ssize_t status), void *cb_data, uint32_t delay);

void sol_i2c_dispatcher_remove_op_set(struct sol_i2c *i2c, struct sol_i2c_op_set_pending *pending);

#ifdef __cplusplus
}
#endif