i2cgpio.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_I2CGPIO_H
#define _ULTIBO_I2CGPIO_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/gpio.h"
#include "ultibo/i2c.h"

#define I2CGPIO_I2C_DESCRIPTION "GPIO Software I2C" 
 
#define I2CGPIO_I2C_MAX_SIZE    0xFFFF
#define I2CGPIO_I2C_MIN_CLOCK   10000 
#define I2CGPIO_I2C_MAX_CLOCK   100000 
 
#define I2CGPIO_RETRY_COUNT 3
 
#define I2CGPIO_DEFAULT_TIMEOUT 100

typedef struct _I2CGPIO_DEVICE I2CGPIO_DEVICE;
struct _I2CGPIO_DEVICE
{
    // I2C Properties
    I2C_DEVICE i2c;
    // I2CGPIO Properties
    GPIO_DEVICE *gpio; 
    uint32_t sda; 
    uint32_t scl; 
    uint32_t delay; 
    uint32_t timeout; 
    LONGBOOL outputonly; 
    LONGBOOL opendrain; 
    // Transfer Properties
    LONGBOOL ignorenak; 
};

I2C_DEVICE * STDCALL i2cgpio_create(GPIO_DEVICE *gpio, uint32_t sda, uint32_t scl, uint32_t delay, uint32_t timeout, BOOL outputonly, BOOL opendrain);
uint32_t STDCALL i2cgpio_destroy(I2C_DEVICE *i2c);

 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_I2CGPIO_H