root/sys/dev/iicbus/controller/twsi/a10_twsi.c
/*-
 * Copyright (c) 2016-2019 Emmanuel Vadot <manu@freebsd.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/bus.h>
#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/resource.h>

#include <machine/bus.h>
#include <machine/resource.h>

#include <sys/rman.h>

#include <sys/lock.h>
#include <sys/mutex.h>

#include <dev/iicbus/iiconf.h>
#include <dev/iicbus/iicbus.h>
#include <dev/iicbus/controller/twsi/twsi.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>

#include <dev/clk/clk.h>
#include <dev/hwreset/hwreset.h>

#include "iicbus_if.h"

#define TWI_ADDR        0x0
#define TWI_XADDR       0x4
#define TWI_DATA        0x8
#define TWI_CNTR        0xC
#define TWI_STAT        0x10
#define TWI_CCR         0x14
#define TWI_SRST        0x18
#define TWI_EFR         0x1C
#define TWI_LCR         0x20

static struct ofw_compat_data compat_data[] = {
        {"allwinner,sun4i-a10-i2c", 1},
        {"allwinner,sun6i-a31-i2c", 1},
        {"allwinner,sun8i-a83t-i2c", 1},
        {"allwinner,sun50i-h616-i2c", 1},
        {NULL, 0},
};

static int
a10_twsi_probe(device_t dev)
{

        if (!ofw_bus_status_okay(dev))
                return (ENXIO);

        if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
                return (ENXIO);

        device_set_desc(dev, "Allwinner Integrated I2C Bus Controller");
        return (BUS_PROBE_DEFAULT);
}

static int
a10_twsi_attach(device_t dev)
{
        struct twsi_softc *sc;
        hwreset_t rst;
        int error;

        sc = device_get_softc(dev);

        /* De-assert reset */
        if (hwreset_get_by_ofw_idx(dev, 0, 0, &rst) == 0) {
                error = hwreset_deassert(rst);
                if (error != 0) {
                        device_printf(dev, "could not de-assert reset\n");
                        return (error);
                }
        }

        /* Activate clock */
        error = clk_get_by_ofw_index(dev, 0, 0, &sc->clk_core);
        if (error != 0) {
                device_printf(dev, "could not find clock\n");
                return (error);
        }
        error = clk_enable(sc->clk_core);
        if (error != 0) {
                device_printf(dev, "could not enable clock\n");
                return (error);
        }

        sc->reg_data = TWI_DATA;
        sc->reg_slave_addr = TWI_ADDR;
        sc->reg_slave_ext_addr = TWI_XADDR;
        sc->reg_control = TWI_CNTR;
        sc->reg_status = TWI_STAT;
        sc->reg_baud_rate = TWI_CCR;
        sc->reg_soft_reset = TWI_SRST;

        if (ofw_bus_is_compatible(dev, "allwinner,sun6i-a31-i2c") ||
            ofw_bus_is_compatible(dev, "allwinner,sun6i-a83t-i2c"))
                sc->iflag_w1c = true;
        return (twsi_attach(dev));
}

static phandle_t
a10_twsi_get_node(device_t bus, device_t dev)
{
        return (ofw_bus_get_node(bus));
}

static device_method_t a10_twsi_methods[] = {
        /* device interface */
        DEVMETHOD(device_probe,         a10_twsi_probe),
        DEVMETHOD(device_attach,        a10_twsi_attach),

        /* OFW methods */
        DEVMETHOD(ofw_bus_get_node,     a10_twsi_get_node),

        DEVMETHOD_END
};

DEFINE_CLASS_1(iichb, a10_twsi_driver, a10_twsi_methods,
    sizeof(struct twsi_softc), twsi_driver);

EARLY_DRIVER_MODULE(a10_twsi, simplebus, a10_twsi_driver,
    0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_LATE);
EARLY_DRIVER_MODULE(iicbus, a10_twsi, iicbus_driver,
    0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_LATE);
MODULE_DEPEND(a10_twsi, iicbus, 1, 1, 1);
SIMPLEBUS_PNP_INFO(compat_data);