i2c.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_I2C_H
#define _ULTIBO_I2C_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/devices.h"

#define I2C_NAME_PREFIX "I2C" 
#define I2CSLAVE_NAME_PREFIX    "I2CSlave" 

#define I2C_TYPE_NONE   0
#define I2C_TYPE_MASTER 1
#define I2C_TYPE_SLAVE  2
 
#define I2C_TYPE_MAX    2

#define I2C_STATE_DISABLED  0
#define I2C_STATE_ENABLED   1
 
#define I2C_STATE_MAX   1

#define I2C_FLAG_NONE   0x00000000
#define I2C_FLAG_SLAVE  0x00000001 
#define I2C_FLAG_10BIT  0x00000002 
#define I2C_FLAG_16BIT  0x00000004 
#define I2C_FLAG_DMA    0x00000008 

#define I2C_TRANSFER_NONE   0x00000000
#define I2C_TRANSFER_DMA    0x00000001 
#define I2C_TRANSFER_IGNORE_NAK 0x00000002 


typedef struct _I2C_PROPERTIES I2C_PROPERTIES;
struct _I2C_PROPERTIES
{
    uint32_t flags; 
    uint32_t maxsize; 
    uint32_t minclock; 
    uint32_t maxclock; 
    uint32_t clockrate; 
    uint16_t slaveaddress; 
};

typedef struct _I2C_DEVICE I2C_DEVICE;

typedef uint32_t STDCALL (*i2c_enumerate_cb)(I2C_DEVICE *i2c, void *data);
typedef uint32_t STDCALL (*i2c_notification_cb)(DEVICE *device, void *data, uint32_t notification);

typedef uint32_t STDCALL (*i2c_device_start_proc)(I2C_DEVICE *i2c, uint32_t rate);
typedef uint32_t STDCALL (*i2c_device_stop_proc)(I2C_DEVICE *i2c);
 
typedef uint32_t STDCALL (*i2c_device_read_proc)(I2C_DEVICE *i2c, uint16_t address, void *buffer, uint32_t size, uint32_t flags, uint32_t *count);
typedef uint32_t STDCALL (*i2c_device_write_proc)(I2C_DEVICE *i2c, uint16_t address, void *buffer, uint32_t size, uint32_t flags, uint32_t *count);
typedef uint32_t STDCALL (*i2c_device_write_read_proc)(I2C_DEVICE *i2c, uint16_t address, void *initial, uint32_t len, void *data, uint32_t size, uint32_t flags, uint32_t *count);
typedef uint32_t STDCALL (*i2c_device_write_write_proc)(I2C_DEVICE *i2c, uint16_t address, void *initial, uint32_t len, void *data, uint32_t size, uint32_t flags, uint32_t *count);
 
typedef uint32_t STDCALL (*i2c_device_get_rate_proc)(I2C_DEVICE *i2c);
typedef uint32_t STDCALL (*i2c_device_set_rate_proc)(I2C_DEVICE *i2c, uint32_t rate);
 
typedef uint16_t STDCALL (*i2c_device_get_address_proc)(I2C_DEVICE *i2c);
typedef uint32_t STDCALL (*i2c_device_set_address_proc)(I2C_DEVICE *i2c, uint16_t address);
 
typedef uint32_t STDCALL (*i2c_device_get_properties_proc)(I2C_DEVICE *i2c, I2C_PROPERTIES *properties);
 
struct _I2C_DEVICE
{
    // Device Properties
    DEVICE device; 
    // I2C Properties
    uint32_t i2cid; 
    uint32_t i2cstate; 
    i2c_device_start_proc devicestart; 
    i2c_device_stop_proc devicestop; 
    i2c_device_read_proc deviceread; 
    i2c_device_write_proc devicewrite; 
    i2c_device_write_read_proc devicewriteread; 
    i2c_device_write_write_proc devicewritewrite; 
    i2c_device_get_rate_proc devicegetrate; 
    i2c_device_set_rate_proc devicesetrate; 
    i2c_device_get_address_proc devicegetaddress; 
    i2c_device_set_address_proc devicesetaddress; 
    i2c_device_get_properties_proc devicegetproperties; 
    // Statistics Properties
    uint32_t readcount;
    uint32_t writecount;
    uint32_t readerrors;
    uint32_t writeerrors;
    // Driver Properties
    MUTEX_HANDLE lock; 
    SEMAPHORE_HANDLE wait; 
    uint32_t clockrate; 
    uint16_t slaveaddress; 
    I2C_PROPERTIES properties; 
    // Internal Properties
    I2C_DEVICE *prev; 
    I2C_DEVICE *next; 
};


uint32_t STDCALL i2c_device_start(I2C_DEVICE *i2c, uint32_t rate);

uint32_t STDCALL i2c_device_stop(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_device_read(I2C_DEVICE *i2c, uint16_t address, void *buffer, uint32_t size, uint32_t *count);

uint32_t STDCALL i2c_device_read_ex(I2C_DEVICE *i2c, uint16_t address, void *buffer, uint32_t size, uint32_t flags, uint32_t *count);

uint32_t STDCALL i2c_device_write(I2C_DEVICE *i2c, uint16_t address, void *buffer, uint32_t size, uint32_t *count);

uint32_t STDCALL i2c_device_write_ex(I2C_DEVICE *i2c, uint16_t address, void *buffer, uint32_t size, uint32_t flags, uint32_t *count);

uint32_t STDCALL i2c_device_write_read(I2C_DEVICE *i2c, uint16_t address, void *initial, uint32_t len, void *data, uint32_t size, uint32_t *count);

uint32_t STDCALL i2c_device_write_read_ex(I2C_DEVICE *i2c, uint16_t address, void *initial, uint32_t len, void *data, uint32_t size, uint32_t flags, uint32_t *count);

uint32_t STDCALL i2c_device_write_write(I2C_DEVICE *i2c, uint16_t address, void *initial, uint32_t len, void *data, uint32_t size, uint32_t *count);

uint32_t STDCALL i2c_device_write_write_ex(I2C_DEVICE *i2c, uint16_t address, void *initial, uint32_t len, void *data, uint32_t size, uint32_t flags, uint32_t *count);

uint32_t STDCALL i2c_device_get_rate(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_device_set_rate(I2C_DEVICE *i2c, uint32_t rate);

uint16_t STDCALL i2c_device_get_address(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_device_set_address(I2C_DEVICE *i2c, uint16_t address);

uint32_t STDCALL i2c_device_properties(I2C_DEVICE *i2c, I2C_PROPERTIES *properties);

uint32_t STDCALL i2c_device_get_properties(I2C_DEVICE *i2c, I2C_PROPERTIES *properties);

I2C_DEVICE * STDCALL i2c_device_create(void);

I2C_DEVICE * STDCALL i2c_device_create_ex(uint32_t size);

uint32_t STDCALL i2c_device_destroy(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_device_register(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_device_deregister(I2C_DEVICE *i2c);

I2C_DEVICE * STDCALL i2c_device_find(uint32_t i2cid);

I2C_DEVICE * STDCALL i2c_device_find_by_name(const char *name);

I2C_DEVICE * STDCALL i2c_device_find_by_description(const char *description);

uint32_t STDCALL i2c_device_enumerate(i2c_enumerate_cb callback, void *data);

uint32_t STDCALL i2c_device_notification(I2C_DEVICE *i2c, i2c_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


uint32_t STDCALL i2c_slave_start(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_slave_stop(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_slave_read(I2C_DEVICE *i2c, void *buffer, uint32_t size, uint32_t *count);

uint32_t STDCALL i2c_slave_write(I2C_DEVICE *i2c, void *buffer, uint32_t size, uint32_t *count);

uint16_t STDCALL i2c_slave_get_address(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_slave_set_address(I2C_DEVICE *i2c, uint16_t address);

uint32_t STDCALL i2c_slave_get_properties(I2C_DEVICE *i2c, I2C_PROPERTIES *properties);

I2C_DEVICE * STDCALL i2c_slave_create(void);

I2C_DEVICE * STDCALL i2c_slave_create_ex(uint32_t size);

uint32_t STDCALL i2c_slave_destroy(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_slave_register(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_slave_deregister(I2C_DEVICE *i2c);

I2C_DEVICE * STDCALL i2c_slave_find(uint32_t i2cid);

I2C_DEVICE * STDCALL i2c_slave_find_by_name(const char *name);

I2C_DEVICE * STDCALL i2c_slave_find_by_description(const char *description);


uint32_t STDCALL i2c_get_count(void);

I2C_DEVICE * STDCALL i2c_device_get_default(void);

uint32_t STDCALL i2c_device_set_default(I2C_DEVICE *i2c);

I2C_DEVICE * STDCALL i2c_device_check(I2C_DEVICE *i2c);

BOOL STDCALL i2c_device_is_slave(I2C_DEVICE *i2c);

uint32_t STDCALL i2c_type_to_string(uint32_t i2ctype, char *string, uint32_t len);

uint32_t STDCALL i2c_state_to_string(uint32_t i2cstate, char *string, uint32_t len);

BOOL STDCALL i2c_is7bit_address(uint16_t address);

BOOL STDCALL i2c_is10bit_address(uint16_t address);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_I2C_H