/* $NetBSD: gpioiic.c,v 1.13 2025/09/15 13:23:03 thorpej Exp $ */
/*      $OpenBSD: gpioiic.c,v 1.8 2008/11/24 12:12:12 mbalmer Exp $     */

/*
 * Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: gpioiic.c,v 1.13 2025/09/15 13:23:03 thorpej Exp $");

/*
 * I2C bus bit-banging through GPIO pins.
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/gpio.h>
#include <sys/rwlock.h>
#include <sys/module.h>

#include <dev/gpio/gpiovar.h>

#include <dev/i2c/i2cvar.h>
#include <dev/i2c/i2c_bitbang.h>

#include "ioconf.h"

#define GPIOIIC_PIN_SDA         0
#define GPIOIIC_PIN_SCL         1
#define GPIOIIC_NPINS           2

#define GPIOIIC_SDA             0x01
#define GPIOIIC_SCL             0x02

#define GPIOIIC_PIN_REVERSE     0x01

struct gpioiic_softc {
        void *                  sc_gpio;
        struct gpio_pinmap      sc_map;
        int                     _map[GPIOIIC_NPINS];

        struct i2c_controller   sc_i2c_tag;
        device_t                sc_i2c_dev;

        int                     sc_pin_sda;
        int                     sc_pin_scl;

        int                     sc_sda;
        int                     sc_scl;
};

int             gpioiic_match(device_t, cfdata_t, void *);
void            gpioiic_attach(device_t, device_t, void *);
int             gpioiic_detach(device_t, int);

int             gpioiic_i2c_send_start(void *, int);
int             gpioiic_i2c_send_stop(void *, int);
int             gpioiic_i2c_initiate_xfer(void *, i2c_addr_t, int);
int             gpioiic_i2c_read_byte(void *, uint8_t *, int);
int             gpioiic_i2c_write_byte(void *, uint8_t, int);

void            gpioiic_bb_set_bits(void *, uint32_t);
void            gpioiic_bb_set_dir(void *, uint32_t);
uint32_t        gpioiic_bb_read_bits(void *);

CFATTACH_DECL_NEW(gpioiic, sizeof(struct gpioiic_softc),
        gpioiic_match, gpioiic_attach, gpioiic_detach, NULL);

static const struct i2c_bitbang_ops gpioiic_bbops = {
        gpioiic_bb_set_bits,
        gpioiic_bb_set_dir,
        gpioiic_bb_read_bits,
        { GPIOIIC_SDA, GPIOIIC_SCL, GPIOIIC_SDA, 0 }
};

int
gpioiic_match(device_t parent, cfdata_t cf, void *aux)
{
        struct gpio_attach_args *ga = aux;

        if (strcmp(ga->ga_dvname, cf->cf_name))
                return 0;

        if (ga->ga_offset == -1)
                return 0;

        /* Check that we have enough pins */
        if (gpio_npins(ga->ga_mask) != GPIOIIC_NPINS) {
                aprint_debug("%s: invalid pin mask 0x%02x\n", cf->cf_name,
                    ga->ga_mask);
                return 0;
        }
        return 1;
}

void
gpioiic_attach(device_t parent, device_t self, void *aux)
{
        struct gpioiic_softc *sc = device_private(self);
        struct gpio_attach_args *ga = aux;
        int caps;

        /* Map pins */
        sc->sc_gpio = ga->ga_gpio;
        sc->sc_map.pm_map = sc->_map;


        if (gpio_pin_map(sc->sc_gpio, ga->ga_offset, ga->ga_mask,
            &sc->sc_map)) {
                aprint_error(": can't map pins\n");
                return;
        }

        if (ga->ga_flags & GPIOIIC_PIN_REVERSE) {
                sc->sc_pin_sda = GPIOIIC_PIN_SCL;
                sc->sc_pin_scl = GPIOIIC_PIN_SDA;
        } else {
                sc->sc_pin_sda = GPIOIIC_PIN_SDA;
                sc->sc_pin_scl = GPIOIIC_PIN_SCL;
        }

        /* Configure SDA pin */
        caps = gpio_pin_caps(sc->sc_gpio, &sc->sc_map, sc->sc_pin_sda);
        if (!(caps & GPIO_PIN_OUTPUT)) {
                aprint_error(": SDA pin is unable to drive output\n");
                goto fail;
        }
        if (!(caps & GPIO_PIN_INPUT)) {
                aprint_error(": SDA pin is unable to read input\n");
                goto fail;
        }
        aprint_normal(": SDA[%d]", sc->sc_map.pm_map[sc->sc_pin_sda]);
        sc->sc_sda = GPIO_PIN_OUTPUT;
        if (caps & GPIO_PIN_OPENDRAIN) {
                aprint_normal(" open-drain");
                sc->sc_sda |= GPIO_PIN_OPENDRAIN;
        } else if ((caps & GPIO_PIN_PUSHPULL) && (caps & GPIO_PIN_TRISTATE)) {
                aprint_normal(" push-pull tri-state");
                sc->sc_sda |= GPIO_PIN_PUSHPULL;
        }
        if (caps & GPIO_PIN_PULLUP) {
                aprint_normal(" pull-up");
                sc->sc_sda |= GPIO_PIN_PULLUP;
        }
        gpio_pin_ctl(sc->sc_gpio, &sc->sc_map, sc->sc_pin_sda, sc->sc_sda);

        /* Configure SCL pin */
        caps = gpio_pin_caps(sc->sc_gpio, &sc->sc_map, sc->sc_pin_scl);
        if (!(caps & GPIO_PIN_OUTPUT)) {
                aprint_error(": SCL pin is unable to drive output\n");
                goto fail;
        }
        aprint_normal(", SCL[%d]", sc->sc_map.pm_map[sc->sc_pin_scl]);
        sc->sc_scl = GPIO_PIN_OUTPUT;
        if (caps & GPIO_PIN_OPENDRAIN) {
                aprint_normal(" open-drain");
                sc->sc_scl |= GPIO_PIN_OPENDRAIN;
                if (caps & GPIO_PIN_PULLUP) {
                        aprint_normal(" pull-up");
                        sc->sc_scl |= GPIO_PIN_PULLUP;
                }
        } else if (caps & GPIO_PIN_PUSHPULL) {
                aprint_normal(" push-pull");
                sc->sc_scl |= GPIO_PIN_PUSHPULL;
        }
        gpio_pin_ctl(sc->sc_gpio, &sc->sc_map, sc->sc_pin_scl, sc->sc_scl);

        aprint_normal("\n");

        /* Attach I2C bus */
        iic_tag_init(&sc->sc_i2c_tag);
        sc->sc_i2c_tag.ic_cookie = sc;
        sc->sc_i2c_tag.ic_send_start = gpioiic_i2c_send_start;
        sc->sc_i2c_tag.ic_send_stop = gpioiic_i2c_send_stop;
        sc->sc_i2c_tag.ic_initiate_xfer = gpioiic_i2c_initiate_xfer;
        sc->sc_i2c_tag.ic_read_byte = gpioiic_i2c_read_byte;
        sc->sc_i2c_tag.ic_write_byte = gpioiic_i2c_write_byte;

        sc->sc_i2c_dev = iicbus_attach(self, &sc->sc_i2c_tag);

        if (!pmf_device_register(self, NULL, NULL))
                aprint_error("%s: could not establish power handler\n",
                    device_xname(self));
        return;

fail:
        gpio_pin_unmap(sc->sc_gpio, &sc->sc_map);
}

int
gpioiic_detach(device_t self, int flags)
{
        struct gpioiic_softc *sc = device_private(self);
        int error;

        error = config_detach_children(self, flags);
        if (error)
                return error;

        iic_tag_fini(&sc->sc_i2c_tag);
        gpio_pin_unmap(sc->sc_gpio, &sc->sc_map);
        pmf_device_deregister(self);
        return 0;
}

int
gpioiic_i2c_send_start(void *cookie, int flags)
{
        return i2c_bitbang_send_start(cookie, flags, &gpioiic_bbops);
}

int
gpioiic_i2c_send_stop(void *cookie, int flags)
{
        return i2c_bitbang_send_stop(cookie, flags, &gpioiic_bbops);
}

int
gpioiic_i2c_initiate_xfer(void *cookie, i2c_addr_t addr, int flags)
{
        return i2c_bitbang_initiate_xfer(cookie, addr, flags, &gpioiic_bbops);
}

int
gpioiic_i2c_read_byte(void *cookie, uint8_t *bytep, int flags)
{
        return i2c_bitbang_read_byte(cookie, bytep, flags, &gpioiic_bbops);
}

int
gpioiic_i2c_write_byte(void *cookie, uint8_t byte, int flags)
{
        return i2c_bitbang_write_byte(cookie, byte, flags, &gpioiic_bbops);
}

void
gpioiic_bb_set_bits(void *cookie, uint32_t bits)
{
        struct gpioiic_softc *sc = cookie;

        gpio_pin_write(sc->sc_gpio, &sc->sc_map, sc->sc_pin_sda,
            bits & GPIOIIC_SDA ? GPIO_PIN_HIGH : GPIO_PIN_LOW);
        gpio_pin_write(sc->sc_gpio, &sc->sc_map, sc->sc_pin_scl,
            bits & GPIOIIC_SCL ? GPIO_PIN_HIGH : GPIO_PIN_LOW);
}

void
gpioiic_bb_set_dir(void *cookie, uint32_t bits)
{
        struct gpioiic_softc *sc = cookie;
        int sda = sc->sc_sda;

        sda &= ~(GPIO_PIN_INPUT | GPIO_PIN_OUTPUT | GPIO_PIN_TRISTATE);
        sda |= (bits & GPIOIIC_SDA ? GPIO_PIN_OUTPUT : GPIO_PIN_INPUT);
        if ((sda & GPIO_PIN_PUSHPULL) && !(bits & GPIOIIC_SDA))
                sda |= GPIO_PIN_TRISTATE;
        if (sc->sc_sda != sda) {
                sc->sc_sda = sda;
                gpio_pin_ctl(sc->sc_gpio, &sc->sc_map, sc->sc_pin_sda,
                    sc->sc_sda);
        }
}

uint32_t
gpioiic_bb_read_bits(void *cookie)
{
        struct gpioiic_softc *sc = cookie;
        uint32_t bits = 0;

        if (gpio_pin_read(sc->sc_gpio, &sc->sc_map,
            sc->sc_pin_sda) == GPIO_PIN_HIGH)
                bits |= GPIOIIC_SDA;
        if (gpio_pin_read(sc->sc_gpio, &sc->sc_map,
            sc->sc_pin_scl) == GPIO_PIN_HIGH)
                bits |= GPIOIIC_SCL;

        return bits;
}

MODULE(MODULE_CLASS_DRIVER, gpioiic, "gpio,iic");

#ifdef _MODULE
#include "ioconf.c"
#endif

static int
gpioiic_modcmd(modcmd_t cmd, void *opaque)
{
        int error;

        error = 0;
        switch (cmd) {
        case MODULE_CMD_INIT:
#ifdef _MODULE
                error = config_init_component(cfdriver_ioconf_gpioiic,
                    cfattach_ioconf_gpioiic, cfdata_ioconf_gpioiic);
                if (error)
                        aprint_error("%s: unable to init component\n",
                            gpioiic_cd.cd_name);
#endif
                break;
        case MODULE_CMD_FINI:
#ifdef _MODULE
                config_fini_component(cfdriver_ioconf_gpioiic,
                    cfattach_ioconf_gpioiic, cfdata_ioconf_gpioiic);
#endif
                break;
        default:
                error = ENOTTY;
        }
        return error;
}