1484b4fd4SRuslan Bukin /*- 2484b4fd4SRuslan Bukin * Copyright (C) 2008-2009 Semihalf, Michal Hajduk 3484b4fd4SRuslan Bukin * Copyright (c) 2012, 2013 The FreeBSD Foundation 4d2c05e20SIan Lepore * Copyright (c) 2015 Ian Lepore <ian@FreeBSD.org> 5484b4fd4SRuslan Bukin * All rights reserved. 6484b4fd4SRuslan Bukin * 7484b4fd4SRuslan Bukin * Portions of this software were developed by Oleksandr Rybalko 8484b4fd4SRuslan Bukin * under sponsorship from the FreeBSD Foundation. 9484b4fd4SRuslan Bukin * 10484b4fd4SRuslan Bukin * Redistribution and use in source and binary forms, with or without 11484b4fd4SRuslan Bukin * modification, are permitted provided that the following conditions 12484b4fd4SRuslan Bukin * are met: 13484b4fd4SRuslan Bukin * 1. Redistributions of source code must retain the above copyright 14484b4fd4SRuslan Bukin * notice, this list of conditions and the following disclaimer. 15484b4fd4SRuslan Bukin * 2. Redistributions in binary form must reproduce the above copyright 16484b4fd4SRuslan Bukin * notice, this list of conditions and the following disclaimer in the 17484b4fd4SRuslan Bukin * documentation and/or other materials provided with the distribution. 18484b4fd4SRuslan Bukin * 19484b4fd4SRuslan Bukin * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20484b4fd4SRuslan Bukin * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21484b4fd4SRuslan Bukin * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22484b4fd4SRuslan Bukin * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 23484b4fd4SRuslan Bukin * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24484b4fd4SRuslan Bukin * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25484b4fd4SRuslan Bukin * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26484b4fd4SRuslan Bukin * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27484b4fd4SRuslan Bukin * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28484b4fd4SRuslan Bukin * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29484b4fd4SRuslan Bukin * SUCH DAMAGE. 30484b4fd4SRuslan Bukin */ 31484b4fd4SRuslan Bukin 32d2c05e20SIan Lepore /* 33d2c05e20SIan Lepore * I2C driver for Freescale i.MX hardware. 34d2c05e20SIan Lepore * 35d2c05e20SIan Lepore * Note that the hardware is capable of running as both a master and a slave. 36d2c05e20SIan Lepore * This driver currently implements only master-mode operations. 37d2c05e20SIan Lepore * 38db4fcadfSConrad Meyer * This driver supports multi-master i2c buses, by detecting bus arbitration 39d2c05e20SIan Lepore * loss and returning IIC_EBUSBSY status. Notably, it does not do any kind of 40d2c05e20SIan Lepore * retries if some other master jumps onto the bus and interrupts one of our 41d2c05e20SIan Lepore * transfer cycles resulting in arbitration loss in mid-transfer. The caller 42d2c05e20SIan Lepore * must handle retries in a way that makes sense for the slave being addressed. 43d2c05e20SIan Lepore */ 44d2c05e20SIan Lepore 45484b4fd4SRuslan Bukin #include <sys/cdefs.h> 46484b4fd4SRuslan Bukin __FBSDID("$FreeBSD$"); 47484b4fd4SRuslan Bukin 48484b4fd4SRuslan Bukin #include <sys/param.h> 49484b4fd4SRuslan Bukin #include <sys/systm.h> 50484b4fd4SRuslan Bukin #include <sys/bus.h> 518928c2e4SIan Lepore #include <sys/gpio.h> 52484b4fd4SRuslan Bukin #include <sys/kernel.h> 53844aff82SIan Lepore #include <sys/limits.h> 54484b4fd4SRuslan Bukin #include <sys/module.h> 55484b4fd4SRuslan Bukin #include <sys/resource.h> 56900fb59eSIan Lepore #include <sys/sysctl.h> 57484b4fd4SRuslan Bukin 58484b4fd4SRuslan Bukin #include <machine/bus.h> 59484b4fd4SRuslan Bukin #include <machine/resource.h> 60484b4fd4SRuslan Bukin #include <sys/rman.h> 61484b4fd4SRuslan Bukin 62844aff82SIan Lepore #include <arm/freescale/imx/imx_ccmvar.h> 63844aff82SIan Lepore 64484b4fd4SRuslan Bukin #include <dev/iicbus/iiconf.h> 65484b4fd4SRuslan Bukin #include <dev/iicbus/iicbus.h> 668928c2e4SIan Lepore #include <dev/iicbus/iic_recover_bus.h> 67484b4fd4SRuslan Bukin #include "iicbus_if.h" 68484b4fd4SRuslan Bukin 69484b4fd4SRuslan Bukin #include <dev/ofw/openfirm.h> 70484b4fd4SRuslan Bukin #include <dev/ofw/ofw_bus.h> 71484b4fd4SRuslan Bukin #include <dev/ofw/ofw_bus_subr.h> 72484b4fd4SRuslan Bukin 738928c2e4SIan Lepore #include <dev/fdt/fdt_pinctrl.h> 748928c2e4SIan Lepore #include <dev/gpio/gpiobusvar.h> 758928c2e4SIan Lepore 76484b4fd4SRuslan Bukin #define I2C_ADDR_REG 0x00 /* I2C slave address register */ 77484b4fd4SRuslan Bukin #define I2C_FDR_REG 0x04 /* I2C frequency divider register */ 78484b4fd4SRuslan Bukin #define I2C_CONTROL_REG 0x08 /* I2C control register */ 79484b4fd4SRuslan Bukin #define I2C_STATUS_REG 0x0C /* I2C status register */ 80484b4fd4SRuslan Bukin #define I2C_DATA_REG 0x10 /* I2C data register */ 81484b4fd4SRuslan Bukin #define I2C_DFSRR_REG 0x14 /* I2C Digital Filter Sampling rate */ 82484b4fd4SRuslan Bukin 83484b4fd4SRuslan Bukin #define I2CCR_MEN (1 << 7) /* Module enable */ 84484b4fd4SRuslan Bukin #define I2CCR_MSTA (1 << 5) /* Master/slave mode */ 85484b4fd4SRuslan Bukin #define I2CCR_MTX (1 << 4) /* Transmit/receive mode */ 86484b4fd4SRuslan Bukin #define I2CCR_TXAK (1 << 3) /* Transfer acknowledge */ 87484b4fd4SRuslan Bukin #define I2CCR_RSTA (1 << 2) /* Repeated START */ 88484b4fd4SRuslan Bukin 89484b4fd4SRuslan Bukin #define I2CSR_MCF (1 << 7) /* Data transfer */ 90484b4fd4SRuslan Bukin #define I2CSR_MASS (1 << 6) /* Addressed as a slave */ 91484b4fd4SRuslan Bukin #define I2CSR_MBB (1 << 5) /* Bus busy */ 92484b4fd4SRuslan Bukin #define I2CSR_MAL (1 << 4) /* Arbitration lost */ 93484b4fd4SRuslan Bukin #define I2CSR_SRW (1 << 2) /* Slave read/write */ 94484b4fd4SRuslan Bukin #define I2CSR_MIF (1 << 1) /* Module interrupt */ 95484b4fd4SRuslan Bukin #define I2CSR_RXAK (1 << 0) /* Received acknowledge */ 96484b4fd4SRuslan Bukin 97484b4fd4SRuslan Bukin #define I2C_BAUD_RATE_FAST 0x31 98484b4fd4SRuslan Bukin #define I2C_BAUD_RATE_DEF 0x3F 99484b4fd4SRuslan Bukin #define I2C_DFSSR_DIV 0x10 100484b4fd4SRuslan Bukin 101844aff82SIan Lepore /* 102844aff82SIan Lepore * A table of available divisors and the associated coded values to put in the 103844aff82SIan Lepore * FDR register to achieve that divisor.. There is no algorithmic relationship I 104844aff82SIan Lepore * can see between divisors and the codes that go into the register. The table 105844aff82SIan Lepore * begins and ends with entries that handle insane configuration values. 106844aff82SIan Lepore */ 107844aff82SIan Lepore struct clkdiv { 108844aff82SIan Lepore u_int divisor; 109844aff82SIan Lepore u_int regcode; 110844aff82SIan Lepore }; 111844aff82SIan Lepore static struct clkdiv clkdiv_table[] = { 112844aff82SIan Lepore { 0, 0x20 }, { 22, 0x20 }, { 24, 0x21 }, { 26, 0x22 }, 113844aff82SIan Lepore { 28, 0x23 }, { 30, 0x00 }, { 32, 0x24 }, { 36, 0x25 }, 114844aff82SIan Lepore { 40, 0x26 }, { 42, 0x03 }, { 44, 0x27 }, { 48, 0x28 }, 115844aff82SIan Lepore { 52, 0x05 }, { 56, 0x29 }, { 60, 0x06 }, { 64, 0x2a }, 116844aff82SIan Lepore { 72, 0x2b }, { 80, 0x2c }, { 88, 0x09 }, { 96, 0x2d }, 117844aff82SIan Lepore { 104, 0x0a }, { 112, 0x2e }, { 128, 0x2f }, { 144, 0x0c }, 118844aff82SIan Lepore { 160, 0x30 }, { 192, 0x31 }, { 224, 0x32 }, { 240, 0x0f }, 119844aff82SIan Lepore { 256, 0x33 }, { 288, 0x10 }, { 320, 0x34 }, { 384, 0x35 }, 120844aff82SIan Lepore { 448, 0x36 }, { 480, 0x13 }, { 512, 0x37 }, { 576, 0x14 }, 121844aff82SIan Lepore { 640, 0x38 }, { 768, 0x39 }, { 896, 0x3a }, { 960, 0x17 }, 122844aff82SIan Lepore { 1024, 0x3b }, { 1152, 0x18 }, { 1280, 0x3c }, { 1536, 0x3d }, 123844aff82SIan Lepore { 1792, 0x3e }, { 1920, 0x1b }, { 2048, 0x3f }, { 2304, 0x1c }, 124844aff82SIan Lepore { 2560, 0x1d }, { 3072, 0x1e }, { 3840, 0x1f }, {UINT_MAX, 0x1f} 125844aff82SIan Lepore }; 126844aff82SIan Lepore 12740d7d632SRuslan Bukin static struct ofw_compat_data compat_data[] = { 12840d7d632SRuslan Bukin {"fsl,imx6q-i2c", 1}, 12940d7d632SRuslan Bukin {"fsl,imx-i2c", 1}, 13040d7d632SRuslan Bukin {NULL, 0} 13140d7d632SRuslan Bukin }; 13240d7d632SRuslan Bukin 133484b4fd4SRuslan Bukin struct i2c_softc { 134484b4fd4SRuslan Bukin device_t dev; 135484b4fd4SRuslan Bukin device_t iicbus; 136484b4fd4SRuslan Bukin struct resource *res; 137484b4fd4SRuslan Bukin int rid; 138d2c05e20SIan Lepore sbintime_t byte_time_sbt; 1398928c2e4SIan Lepore int rb_pinctl_idx; 1408928c2e4SIan Lepore gpio_pin_t rb_sclpin; 1418928c2e4SIan Lepore gpio_pin_t rb_sdapin; 142900fb59eSIan Lepore u_int debug; 143900fb59eSIan Lepore u_int slave; 144484b4fd4SRuslan Bukin }; 145484b4fd4SRuslan Bukin 146900fb59eSIan Lepore #define DEVICE_DEBUGF(sc, lvl, fmt, args...) \ 147900fb59eSIan Lepore if ((lvl) <= (sc)->debug) \ 148900fb59eSIan Lepore device_printf((sc)->dev, fmt, ##args) 149900fb59eSIan Lepore 150900fb59eSIan Lepore #define DEBUGF(sc, lvl, fmt, args...) \ 151900fb59eSIan Lepore if ((lvl) <= (sc)->debug) \ 152900fb59eSIan Lepore printf(fmt, ##args) 153900fb59eSIan Lepore 154484b4fd4SRuslan Bukin static phandle_t i2c_get_node(device_t, device_t); 155484b4fd4SRuslan Bukin static int i2c_probe(device_t); 156484b4fd4SRuslan Bukin static int i2c_attach(device_t); 157b107b904SIan Lepore static int i2c_detach(device_t); 158484b4fd4SRuslan Bukin 159484b4fd4SRuslan Bukin static int i2c_repeated_start(device_t, u_char, int); 160484b4fd4SRuslan Bukin static int i2c_start(device_t, u_char, int); 161484b4fd4SRuslan Bukin static int i2c_stop(device_t); 162484b4fd4SRuslan Bukin static int i2c_reset(device_t, u_char, u_char, u_char *); 163484b4fd4SRuslan Bukin static int i2c_read(device_t, char *, int, int *, int, int); 164484b4fd4SRuslan Bukin static int i2c_write(device_t, const char *, int, int *, int); 165484b4fd4SRuslan Bukin 166484b4fd4SRuslan Bukin static device_method_t i2c_methods[] = { 167484b4fd4SRuslan Bukin DEVMETHOD(device_probe, i2c_probe), 168484b4fd4SRuslan Bukin DEVMETHOD(device_attach, i2c_attach), 169b107b904SIan Lepore DEVMETHOD(device_detach, i2c_detach), 170484b4fd4SRuslan Bukin 171484b4fd4SRuslan Bukin /* OFW methods */ 172484b4fd4SRuslan Bukin DEVMETHOD(ofw_bus_get_node, i2c_get_node), 173484b4fd4SRuslan Bukin 174484b4fd4SRuslan Bukin DEVMETHOD(iicbus_callback, iicbus_null_callback), 175484b4fd4SRuslan Bukin DEVMETHOD(iicbus_repeated_start, i2c_repeated_start), 176484b4fd4SRuslan Bukin DEVMETHOD(iicbus_start, i2c_start), 177484b4fd4SRuslan Bukin DEVMETHOD(iicbus_stop, i2c_stop), 178484b4fd4SRuslan Bukin DEVMETHOD(iicbus_reset, i2c_reset), 179484b4fd4SRuslan Bukin DEVMETHOD(iicbus_read, i2c_read), 180484b4fd4SRuslan Bukin DEVMETHOD(iicbus_write, i2c_write), 181484b4fd4SRuslan Bukin DEVMETHOD(iicbus_transfer, iicbus_transfer_gen), 182484b4fd4SRuslan Bukin 183d2c05e20SIan Lepore DEVMETHOD_END 184484b4fd4SRuslan Bukin }; 185484b4fd4SRuslan Bukin 186484b4fd4SRuslan Bukin static driver_t i2c_driver = { 187*af85a3d1SIan Lepore "imx_i2c", 188484b4fd4SRuslan Bukin i2c_methods, 189484b4fd4SRuslan Bukin sizeof(struct i2c_softc), 190484b4fd4SRuslan Bukin }; 191484b4fd4SRuslan Bukin static devclass_t i2c_devclass; 192484b4fd4SRuslan Bukin 193*af85a3d1SIan Lepore DRIVER_MODULE(imx_i2c, simplebus, i2c_driver, i2c_devclass, 0, 0); 194*af85a3d1SIan Lepore DRIVER_MODULE(ofw_iicbus, imx_i2c, ofw_iicbus_driver, ofw_iicbus_devclass, 0, 0); 195484b4fd4SRuslan Bukin 196484b4fd4SRuslan Bukin static phandle_t 197484b4fd4SRuslan Bukin i2c_get_node(device_t bus, device_t dev) 198484b4fd4SRuslan Bukin { 199484b4fd4SRuslan Bukin /* 200484b4fd4SRuslan Bukin * Share controller node with iicbus device 201484b4fd4SRuslan Bukin */ 202484b4fd4SRuslan Bukin return ofw_bus_get_node(bus); 203484b4fd4SRuslan Bukin } 204484b4fd4SRuslan Bukin 205484b4fd4SRuslan Bukin static __inline void 206484b4fd4SRuslan Bukin i2c_write_reg(struct i2c_softc *sc, bus_size_t off, uint8_t val) 207484b4fd4SRuslan Bukin { 208484b4fd4SRuslan Bukin 209d2c05e20SIan Lepore bus_write_1(sc->res, off, val); 210484b4fd4SRuslan Bukin } 211484b4fd4SRuslan Bukin 212484b4fd4SRuslan Bukin static __inline uint8_t 213484b4fd4SRuslan Bukin i2c_read_reg(struct i2c_softc *sc, bus_size_t off) 214484b4fd4SRuslan Bukin { 215484b4fd4SRuslan Bukin 216d2c05e20SIan Lepore return (bus_read_1(sc->res, off)); 217484b4fd4SRuslan Bukin } 218484b4fd4SRuslan Bukin 219484b4fd4SRuslan Bukin static __inline void 220484b4fd4SRuslan Bukin i2c_flag_set(struct i2c_softc *sc, bus_size_t off, uint8_t mask) 221484b4fd4SRuslan Bukin { 222484b4fd4SRuslan Bukin uint8_t status; 223484b4fd4SRuslan Bukin 224484b4fd4SRuslan Bukin status = i2c_read_reg(sc, off); 225484b4fd4SRuslan Bukin status |= mask; 226484b4fd4SRuslan Bukin i2c_write_reg(sc, off, status); 227484b4fd4SRuslan Bukin } 228484b4fd4SRuslan Bukin 229d2c05e20SIan Lepore /* Wait for bus to become busy or not-busy. */ 230484b4fd4SRuslan Bukin static int 231d2c05e20SIan Lepore wait_for_busbusy(struct i2c_softc *sc, int wantbusy) 232484b4fd4SRuslan Bukin { 233d2c05e20SIan Lepore int retry, srb; 234484b4fd4SRuslan Bukin 235484b4fd4SRuslan Bukin retry = 1000; 236484b4fd4SRuslan Bukin while (retry --) { 237d2c05e20SIan Lepore srb = i2c_read_reg(sc, I2C_STATUS_REG) & I2CSR_MBB; 238d2c05e20SIan Lepore if ((srb && wantbusy) || (!srb && !wantbusy)) 239484b4fd4SRuslan Bukin return (IIC_NOERR); 240d2c05e20SIan Lepore DELAY(1); 241484b4fd4SRuslan Bukin } 242484b4fd4SRuslan Bukin return (IIC_ETIMEOUT); 243484b4fd4SRuslan Bukin } 244484b4fd4SRuslan Bukin 245d2c05e20SIan Lepore /* Wait for transfer to complete, optionally check RXAK. */ 246484b4fd4SRuslan Bukin static int 247d2c05e20SIan Lepore wait_for_xfer(struct i2c_softc *sc, int checkack) 248484b4fd4SRuslan Bukin { 249d2c05e20SIan Lepore int retry, sr; 250484b4fd4SRuslan Bukin 251d2c05e20SIan Lepore /* 252d2c05e20SIan Lepore * Sleep for about the time it takes to transfer a byte (with precision 253d2c05e20SIan Lepore * set to tolerate 5% oversleep). We calculate the approximate byte 254d2c05e20SIan Lepore * transfer time when we set the bus speed divisor. Slaves are allowed 255d2c05e20SIan Lepore * to do clock-stretching so the actual transfer time can be larger, but 256d2c05e20SIan Lepore * this gets the bulk of the waiting out of the way without tying up the 257d2c05e20SIan Lepore * processor the whole time. 258d2c05e20SIan Lepore */ 259d2c05e20SIan Lepore pause_sbt("imxi2c", sc->byte_time_sbt, sc->byte_time_sbt / 20, 0); 260d2c05e20SIan Lepore 261d2c05e20SIan Lepore retry = 10000; 262484b4fd4SRuslan Bukin while (retry --) { 263d2c05e20SIan Lepore sr = i2c_read_reg(sc, I2C_STATUS_REG); 264d2c05e20SIan Lepore if (sr & I2CSR_MIF) { 265d2c05e20SIan Lepore if (sr & I2CSR_MAL) 266d1e99670SIan Lepore return (IIC_EBUSERR); 267d2c05e20SIan Lepore else if (checkack && (sr & I2CSR_RXAK)) 268d2c05e20SIan Lepore return (IIC_ENOACK); 269d2c05e20SIan Lepore else 270484b4fd4SRuslan Bukin return (IIC_NOERR); 271484b4fd4SRuslan Bukin } 272d2c05e20SIan Lepore DELAY(1); 273d2c05e20SIan Lepore } 274484b4fd4SRuslan Bukin return (IIC_ETIMEOUT); 275484b4fd4SRuslan Bukin } 276484b4fd4SRuslan Bukin 277d2c05e20SIan Lepore /* 278d2c05e20SIan Lepore * Implement the error handling shown in the state diagram of the imx6 reference 279d2c05e20SIan Lepore * manual. If there was an error, then: 280d2c05e20SIan Lepore * - Clear master mode (MSTA and MTX). 281d2c05e20SIan Lepore * - Wait for the bus to become free or for a timeout to happen. 282d2c05e20SIan Lepore * - Disable the controller. 283d2c05e20SIan Lepore */ 284484b4fd4SRuslan Bukin static int 285d2c05e20SIan Lepore i2c_error_handler(struct i2c_softc *sc, int error) 286484b4fd4SRuslan Bukin { 287484b4fd4SRuslan Bukin 288d2c05e20SIan Lepore if (error != 0) { 289d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0); 290d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN); 291d2c05e20SIan Lepore wait_for_busbusy(sc, false); 292d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, 0); 293484b4fd4SRuslan Bukin } 294d2c05e20SIan Lepore return (error); 295484b4fd4SRuslan Bukin } 296484b4fd4SRuslan Bukin 297484b4fd4SRuslan Bukin static int 2988928c2e4SIan Lepore i2c_recover_getsda(void *ctx) 2998928c2e4SIan Lepore { 3008928c2e4SIan Lepore bool active; 3018928c2e4SIan Lepore 3028928c2e4SIan Lepore gpio_pin_is_active(((struct i2c_softc *)ctx)->rb_sdapin, &active); 3038928c2e4SIan Lepore return (active); 3048928c2e4SIan Lepore } 3058928c2e4SIan Lepore 3068928c2e4SIan Lepore static void 3078928c2e4SIan Lepore i2c_recover_setsda(void *ctx, int value) 3088928c2e4SIan Lepore { 3098928c2e4SIan Lepore 3108928c2e4SIan Lepore gpio_pin_set_active(((struct i2c_softc *)ctx)->rb_sdapin, value); 3118928c2e4SIan Lepore } 3128928c2e4SIan Lepore 3138928c2e4SIan Lepore static int 3148928c2e4SIan Lepore i2c_recover_getscl(void *ctx) 3158928c2e4SIan Lepore { 3168928c2e4SIan Lepore bool active; 3178928c2e4SIan Lepore 3188928c2e4SIan Lepore gpio_pin_is_active(((struct i2c_softc *)ctx)->rb_sclpin, &active); 3198928c2e4SIan Lepore return (active); 3208928c2e4SIan Lepore 3218928c2e4SIan Lepore } 3228928c2e4SIan Lepore 3238928c2e4SIan Lepore static void 3248928c2e4SIan Lepore i2c_recover_setscl(void *ctx, int value) 3258928c2e4SIan Lepore { 3268928c2e4SIan Lepore 3278928c2e4SIan Lepore gpio_pin_set_active(((struct i2c_softc *)ctx)->rb_sclpin, value); 3288928c2e4SIan Lepore } 3298928c2e4SIan Lepore 3308928c2e4SIan Lepore static int 3318928c2e4SIan Lepore i2c_recover_bus(struct i2c_softc *sc) 3328928c2e4SIan Lepore { 3338928c2e4SIan Lepore struct iicrb_pin_access pins; 3348928c2e4SIan Lepore int err; 3358928c2e4SIan Lepore 3368928c2e4SIan Lepore /* 3378928c2e4SIan Lepore * If we have gpio pinmux config, reconfigure the pins to gpio mode, 3388928c2e4SIan Lepore * invoke iic_recover_bus which checks for a hung bus and bitbangs a 3398928c2e4SIan Lepore * recovery sequence if necessary, then configure the pins back to i2c 3408928c2e4SIan Lepore * mode (idx 0). 3418928c2e4SIan Lepore */ 3428928c2e4SIan Lepore if (sc->rb_pinctl_idx == 0) 3438928c2e4SIan Lepore return (0); 3448928c2e4SIan Lepore 3458928c2e4SIan Lepore fdt_pinctrl_configure(sc->dev, sc->rb_pinctl_idx); 3468928c2e4SIan Lepore 3478928c2e4SIan Lepore pins.ctx = sc; 3488928c2e4SIan Lepore pins.getsda = i2c_recover_getsda; 3498928c2e4SIan Lepore pins.setsda = i2c_recover_setsda; 3508928c2e4SIan Lepore pins.getscl = i2c_recover_getscl; 3518928c2e4SIan Lepore pins.setscl = i2c_recover_setscl; 3528928c2e4SIan Lepore err = iic_recover_bus(&pins); 3538928c2e4SIan Lepore 3548928c2e4SIan Lepore fdt_pinctrl_configure(sc->dev, 0); 3558928c2e4SIan Lepore 3568928c2e4SIan Lepore return (err); 3578928c2e4SIan Lepore } 3588928c2e4SIan Lepore 3598928c2e4SIan Lepore static int 360484b4fd4SRuslan Bukin i2c_probe(device_t dev) 361484b4fd4SRuslan Bukin { 362484b4fd4SRuslan Bukin 363484b4fd4SRuslan Bukin if (!ofw_bus_status_okay(dev)) 364484b4fd4SRuslan Bukin return (ENXIO); 365484b4fd4SRuslan Bukin 36640d7d632SRuslan Bukin if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0) 367484b4fd4SRuslan Bukin return (ENXIO); 368484b4fd4SRuslan Bukin 369d2c05e20SIan Lepore device_set_desc(dev, "Freescale i.MX I2C"); 370484b4fd4SRuslan Bukin 371484b4fd4SRuslan Bukin return (BUS_PROBE_DEFAULT); 372484b4fd4SRuslan Bukin } 373484b4fd4SRuslan Bukin 374484b4fd4SRuslan Bukin static int 375484b4fd4SRuslan Bukin i2c_attach(device_t dev) 376484b4fd4SRuslan Bukin { 3778928c2e4SIan Lepore char wrkstr[16]; 378484b4fd4SRuslan Bukin struct i2c_softc *sc; 3798928c2e4SIan Lepore phandle_t node; 3808928c2e4SIan Lepore int err, cfgidx; 381484b4fd4SRuslan Bukin 382484b4fd4SRuslan Bukin sc = device_get_softc(dev); 383484b4fd4SRuslan Bukin sc->dev = dev; 384484b4fd4SRuslan Bukin sc->rid = 0; 385484b4fd4SRuslan Bukin 386484b4fd4SRuslan Bukin sc->res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->rid, 387484b4fd4SRuslan Bukin RF_ACTIVE); 388484b4fd4SRuslan Bukin if (sc->res == NULL) { 389484b4fd4SRuslan Bukin device_printf(dev, "could not allocate resources"); 390484b4fd4SRuslan Bukin return (ENXIO); 391484b4fd4SRuslan Bukin } 392484b4fd4SRuslan Bukin 393484b4fd4SRuslan Bukin sc->iicbus = device_add_child(dev, "iicbus", -1); 394484b4fd4SRuslan Bukin if (sc->iicbus == NULL) { 395484b4fd4SRuslan Bukin device_printf(dev, "could not add iicbus child"); 396484b4fd4SRuslan Bukin return (ENXIO); 397484b4fd4SRuslan Bukin } 398484b4fd4SRuslan Bukin 399900fb59eSIan Lepore /* Set up debug-enable sysctl. */ 400900fb59eSIan Lepore SYSCTL_ADD_INT(device_get_sysctl_ctx(sc->dev), 401900fb59eSIan Lepore SYSCTL_CHILDREN(device_get_sysctl_tree(sc->dev)), 402900fb59eSIan Lepore OID_AUTO, "debug", CTLFLAG_RWTUN, &sc->debug, 0, 403900fb59eSIan Lepore "Enable debug; 1=reads/writes, 2=add starts/stops"); 404900fb59eSIan Lepore 4058928c2e4SIan Lepore /* 4068928c2e4SIan Lepore * Set up for bus recovery using gpio pins, if the pinctrl and gpio 4078928c2e4SIan Lepore * properties are present. This is optional. If all the config data is 4088928c2e4SIan Lepore * not in place, we just don't do gpio bitbang bus recovery. 4098928c2e4SIan Lepore */ 4108928c2e4SIan Lepore node = ofw_bus_get_node(sc->dev); 4118928c2e4SIan Lepore 4128928c2e4SIan Lepore err = gpio_pin_get_by_ofw_property(dev, node, "scl-gpios", 4138928c2e4SIan Lepore &sc->rb_sclpin); 4148928c2e4SIan Lepore if (err != 0) 4158928c2e4SIan Lepore goto no_recovery; 4168928c2e4SIan Lepore err = gpio_pin_get_by_ofw_property(dev, node, "sda-gpios", 4178928c2e4SIan Lepore &sc->rb_sdapin); 4188928c2e4SIan Lepore if (err != 0) 4198928c2e4SIan Lepore goto no_recovery; 4208928c2e4SIan Lepore 4218928c2e4SIan Lepore /* 4228928c2e4SIan Lepore * Preset the gpio pins to output high (idle bus state). The signal 4238928c2e4SIan Lepore * won't actually appear on the pins until the bus recovery code changes 4248928c2e4SIan Lepore * the pinmux config from i2c to gpio. 4258928c2e4SIan Lepore */ 4268928c2e4SIan Lepore gpio_pin_setflags(sc->rb_sclpin, GPIO_PIN_OUTPUT); 4278928c2e4SIan Lepore gpio_pin_setflags(sc->rb_sdapin, GPIO_PIN_OUTPUT); 4288928c2e4SIan Lepore gpio_pin_set_active(sc->rb_sclpin, true); 4298928c2e4SIan Lepore gpio_pin_set_active(sc->rb_sdapin, true); 4308928c2e4SIan Lepore 4318928c2e4SIan Lepore /* 4328928c2e4SIan Lepore * Obtain the index of pinctrl node for bus recovery using gpio pins, 4338928c2e4SIan Lepore * then confirm that pinctrl properties exist for that index and for the 4348928c2e4SIan Lepore * default pinctrl-0. If sc->rb_pinctl_idx is non-zero, the reset code 4358928c2e4SIan Lepore * will also do a bus recovery, so setting this value must be last. 4368928c2e4SIan Lepore */ 4378928c2e4SIan Lepore err = ofw_bus_find_string_index(node, "pinctrl-names", "gpio", &cfgidx); 4388928c2e4SIan Lepore if (err == 0) { 4398928c2e4SIan Lepore snprintf(wrkstr, sizeof(wrkstr), "pinctrl-%d", cfgidx); 4408928c2e4SIan Lepore if (OF_hasprop(node, "pinctrl-0") && OF_hasprop(node, wrkstr)) 4418928c2e4SIan Lepore sc->rb_pinctl_idx = cfgidx; 4428928c2e4SIan Lepore } 4438928c2e4SIan Lepore 4448928c2e4SIan Lepore no_recovery: 4458928c2e4SIan Lepore 4468928c2e4SIan Lepore /* We don't do a hardware reset here because iicbus_attach() does it. */ 4478928c2e4SIan Lepore 4481e4042d4SIan Lepore /* Probe and attach the iicbus when interrupts are available. */ 4491e4042d4SIan Lepore config_intrhook_oneshot((ich_func_t)bus_generic_attach, dev); 450d2c05e20SIan Lepore return (0); 451484b4fd4SRuslan Bukin } 452484b4fd4SRuslan Bukin 453484b4fd4SRuslan Bukin static int 454b107b904SIan Lepore i2c_detach(device_t dev) 455b107b904SIan Lepore { 456b107b904SIan Lepore struct i2c_softc *sc; 457b107b904SIan Lepore int error; 458b107b904SIan Lepore 459b107b904SIan Lepore sc = device_get_softc(dev); 460b107b904SIan Lepore 461b107b904SIan Lepore if ((error = bus_generic_detach(sc->dev)) != 0) { 462b107b904SIan Lepore device_printf(sc->dev, "cannot detach child devices\n"); 463b107b904SIan Lepore return (error); 464b107b904SIan Lepore } 465b107b904SIan Lepore 466b107b904SIan Lepore if (sc->iicbus != NULL) 467b107b904SIan Lepore device_delete_child(dev, sc->iicbus); 468b107b904SIan Lepore 469b107b904SIan Lepore if (sc->res != NULL) 470b107b904SIan Lepore bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->res); 471b107b904SIan Lepore 472b107b904SIan Lepore return (0); 473b107b904SIan Lepore } 474b107b904SIan Lepore 475b107b904SIan Lepore static int 476484b4fd4SRuslan Bukin i2c_repeated_start(device_t dev, u_char slave, int timeout) 477484b4fd4SRuslan Bukin { 478484b4fd4SRuslan Bukin struct i2c_softc *sc; 479484b4fd4SRuslan Bukin int error; 480484b4fd4SRuslan Bukin 481484b4fd4SRuslan Bukin sc = device_get_softc(dev); 482484b4fd4SRuslan Bukin 483484b4fd4SRuslan Bukin if ((i2c_read_reg(sc, I2C_STATUS_REG) & I2CSR_MBB) == 0) { 484d2c05e20SIan Lepore return (IIC_EBUSERR); 485484b4fd4SRuslan Bukin } 486484b4fd4SRuslan Bukin 487d2c05e20SIan Lepore /* 488d2c05e20SIan Lepore * Set repeated start condition, delay (per reference manual, min 156nS) 489d2c05e20SIan Lepore * before writing slave address, wait for ack after write. 490d2c05e20SIan Lepore */ 491484b4fd4SRuslan Bukin i2c_flag_set(sc, I2C_CONTROL_REG, I2CCR_RSTA); 492d2c05e20SIan Lepore DELAY(1); 493484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 494484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_DATA_REG, slave); 495900fb59eSIan Lepore sc->slave = slave; 496900fb59eSIan Lepore DEVICE_DEBUGF(sc, 2, "rstart 0x%02x\n", sc->slave); 497d2c05e20SIan Lepore error = wait_for_xfer(sc, true); 498d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 499484b4fd4SRuslan Bukin } 500484b4fd4SRuslan Bukin 501484b4fd4SRuslan Bukin static int 5028928c2e4SIan Lepore i2c_start_ll(device_t dev, u_char slave, int timeout) 503484b4fd4SRuslan Bukin { 504484b4fd4SRuslan Bukin struct i2c_softc *sc; 505484b4fd4SRuslan Bukin int error; 506484b4fd4SRuslan Bukin 507484b4fd4SRuslan Bukin sc = device_get_softc(dev); 508484b4fd4SRuslan Bukin 509d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN); 510d2c05e20SIan Lepore DELAY(10); /* Delay for controller to sample bus state. */ 511484b4fd4SRuslan Bukin if (i2c_read_reg(sc, I2C_STATUS_REG) & I2CSR_MBB) { 512d1e99670SIan Lepore return (i2c_error_handler(sc, IIC_EBUSERR)); 513484b4fd4SRuslan Bukin } 514d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | I2CCR_MSTA | I2CCR_MTX); 515d2c05e20SIan Lepore if ((error = wait_for_busbusy(sc, true)) != IIC_NOERR) 516d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 517d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0); 518484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_DATA_REG, slave); 519900fb59eSIan Lepore sc->slave = slave; 520900fb59eSIan Lepore DEVICE_DEBUGF(sc, 2, "start 0x%02x\n", sc->slave); 521d2c05e20SIan Lepore error = wait_for_xfer(sc, true); 522d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 523484b4fd4SRuslan Bukin } 524484b4fd4SRuslan Bukin 525484b4fd4SRuslan Bukin static int 5268928c2e4SIan Lepore i2c_start(device_t dev, u_char slave, int timeout) 5278928c2e4SIan Lepore { 5288928c2e4SIan Lepore struct i2c_softc *sc; 5298928c2e4SIan Lepore int error; 5308928c2e4SIan Lepore 5318928c2e4SIan Lepore sc = device_get_softc(dev); 5328928c2e4SIan Lepore 5338928c2e4SIan Lepore /* 5348928c2e4SIan Lepore * Invoke the low-level code to put the bus into master mode and address 5358928c2e4SIan Lepore * the given slave. If that fails, idle the controller and attempt a 5368928c2e4SIan Lepore * bus recovery, and then try again one time. Signaling a start and 5378928c2e4SIan Lepore * addressing the slave is the only operation that a low-level driver 5388928c2e4SIan Lepore * can safely retry without any help from the upper layers that know 5398928c2e4SIan Lepore * more about the slave device. 5408928c2e4SIan Lepore */ 5418928c2e4SIan Lepore if ((error = i2c_start_ll(dev, slave, timeout)) != 0) { 5428928c2e4SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, 0x0); 5438928c2e4SIan Lepore if ((error = i2c_recover_bus(sc)) != 0) 5448928c2e4SIan Lepore return (error); 5458928c2e4SIan Lepore error = i2c_start_ll(dev, slave, timeout); 5468928c2e4SIan Lepore } 5478928c2e4SIan Lepore return (error); 5488928c2e4SIan Lepore } 5498928c2e4SIan Lepore 5508928c2e4SIan Lepore static int 551484b4fd4SRuslan Bukin i2c_stop(device_t dev) 552484b4fd4SRuslan Bukin { 553484b4fd4SRuslan Bukin struct i2c_softc *sc; 554484b4fd4SRuslan Bukin 555484b4fd4SRuslan Bukin sc = device_get_softc(dev); 556d2c05e20SIan Lepore 557d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN); 558d2c05e20SIan Lepore wait_for_busbusy(sc, false); 559484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, 0); 560900fb59eSIan Lepore DEVICE_DEBUGF(sc, 2, "stop 0x%02x\n", sc->slave); 561484b4fd4SRuslan Bukin return (IIC_NOERR); 562484b4fd4SRuslan Bukin } 563484b4fd4SRuslan Bukin 564484b4fd4SRuslan Bukin static int 565484b4fd4SRuslan Bukin i2c_reset(device_t dev, u_char speed, u_char addr, u_char *oldadr) 566484b4fd4SRuslan Bukin { 567484b4fd4SRuslan Bukin struct i2c_softc *sc; 568844aff82SIan Lepore u_int busfreq, div, i, ipgfreq; 569484b4fd4SRuslan Bukin 570484b4fd4SRuslan Bukin sc = device_get_softc(dev); 571484b4fd4SRuslan Bukin 572900fb59eSIan Lepore DEVICE_DEBUGF(sc, 1, "reset\n"); 573900fb59eSIan Lepore 574844aff82SIan Lepore /* 575844aff82SIan Lepore * Look up the divisor that gives the nearest speed that doesn't exceed 576844aff82SIan Lepore * the configured value for the bus. 577844aff82SIan Lepore */ 578844aff82SIan Lepore ipgfreq = imx_ccm_ipg_hz(); 579844aff82SIan Lepore busfreq = IICBUS_GET_FREQUENCY(sc->iicbus, speed); 580f0e56111SPedro F. Giffuni div = howmany(ipgfreq, busfreq); 581844aff82SIan Lepore for (i = 0; i < nitems(clkdiv_table); i++) { 582844aff82SIan Lepore if (clkdiv_table[i].divisor >= div) 583484b4fd4SRuslan Bukin break; 584484b4fd4SRuslan Bukin } 585484b4fd4SRuslan Bukin 586d2c05e20SIan Lepore /* 587d2c05e20SIan Lepore * Calculate roughly how long it will take to transfer a byte (which 588d2c05e20SIan Lepore * requires 9 clock cycles) at the new bus speed. This value is used to 589d2c05e20SIan Lepore * pause() while waiting for transfer-complete. With a 66MHz IPG clock 590d2c05e20SIan Lepore * and the actual i2c bus speeds that leads to, for nominal 100KHz and 591d2c05e20SIan Lepore * 400KHz bus speeds the transfer times are roughly 104uS and 22uS. 592d2c05e20SIan Lepore */ 593d2c05e20SIan Lepore busfreq = ipgfreq / clkdiv_table[i].divisor; 594d2c05e20SIan Lepore sc->byte_time_sbt = SBT_1US * (9000000 / busfreq); 595d2c05e20SIan Lepore 596d2c05e20SIan Lepore /* 597d2c05e20SIan Lepore * Disable the controller (do the reset), and set the new clock divisor. 598d2c05e20SIan Lepore */ 599d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 600484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, 0x0); 601d2c05e20SIan Lepore i2c_write_reg(sc, I2C_FDR_REG, (uint8_t)clkdiv_table[i].regcode); 6028928c2e4SIan Lepore 6038928c2e4SIan Lepore /* 6048928c2e4SIan Lepore * Now that the controller is idle, perform bus recovery. If the bus 6058928c2e4SIan Lepore * isn't hung, this a fairly fast no-op. 6068928c2e4SIan Lepore */ 6078928c2e4SIan Lepore return (i2c_recover_bus(sc)); 608484b4fd4SRuslan Bukin } 609484b4fd4SRuslan Bukin 610484b4fd4SRuslan Bukin static int 611484b4fd4SRuslan Bukin i2c_read(device_t dev, char *buf, int len, int *read, int last, int delay) 612484b4fd4SRuslan Bukin { 613484b4fd4SRuslan Bukin struct i2c_softc *sc; 614484b4fd4SRuslan Bukin int error, reg; 615484b4fd4SRuslan Bukin 616484b4fd4SRuslan Bukin sc = device_get_softc(dev); 617484b4fd4SRuslan Bukin *read = 0; 618484b4fd4SRuslan Bukin 619900fb59eSIan Lepore DEVICE_DEBUGF(sc, 1, "read 0x%02x len %d: ", sc->slave, len); 620484b4fd4SRuslan Bukin if (len) { 621484b4fd4SRuslan Bukin if (len == 1) 622484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 623484b4fd4SRuslan Bukin I2CCR_MSTA | I2CCR_TXAK); 624484b4fd4SRuslan Bukin else 625484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 626484b4fd4SRuslan Bukin I2CCR_MSTA); 627d2c05e20SIan Lepore /* Dummy read to prime the receiver. */ 628484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 629d2c05e20SIan Lepore i2c_read_reg(sc, I2C_DATA_REG); 630d2c05e20SIan Lepore } 631d2c05e20SIan Lepore 632d2c05e20SIan Lepore error = 0; 633d2c05e20SIan Lepore *read = 0; 634d2c05e20SIan Lepore while (*read < len) { 635d2c05e20SIan Lepore if ((error = wait_for_xfer(sc, false)) != IIC_NOERR) 636d2c05e20SIan Lepore break; 637d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 638d2c05e20SIan Lepore if (last) { 639d2c05e20SIan Lepore if (*read == len - 2) { 640484b4fd4SRuslan Bukin /* NO ACK on last byte */ 641484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 642484b4fd4SRuslan Bukin I2CCR_MSTA | I2CCR_TXAK); 643d2c05e20SIan Lepore } else if (*read == len - 1) { 644d2c05e20SIan Lepore /* Transfer done, signal stop. */ 645484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 646484b4fd4SRuslan Bukin I2CCR_TXAK); 647d2c05e20SIan Lepore wait_for_busbusy(sc, false); 648484b4fd4SRuslan Bukin } 649d2c05e20SIan Lepore } 650484b4fd4SRuslan Bukin reg = i2c_read_reg(sc, I2C_DATA_REG); 651900fb59eSIan Lepore DEBUGF(sc, 1, "0x%02x ", reg); 652484b4fd4SRuslan Bukin *buf++ = reg; 653484b4fd4SRuslan Bukin (*read)++; 654484b4fd4SRuslan Bukin } 655900fb59eSIan Lepore DEBUGF(sc, 1, "\n"); 656484b4fd4SRuslan Bukin 657d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 658484b4fd4SRuslan Bukin } 659484b4fd4SRuslan Bukin 660484b4fd4SRuslan Bukin static int 661484b4fd4SRuslan Bukin i2c_write(device_t dev, const char *buf, int len, int *sent, int timeout) 662484b4fd4SRuslan Bukin { 663484b4fd4SRuslan Bukin struct i2c_softc *sc; 664484b4fd4SRuslan Bukin int error; 665484b4fd4SRuslan Bukin 666484b4fd4SRuslan Bukin sc = device_get_softc(dev); 667484b4fd4SRuslan Bukin 668d2c05e20SIan Lepore error = 0; 669d2c05e20SIan Lepore *sent = 0; 670900fb59eSIan Lepore DEVICE_DEBUGF(sc, 1, "write 0x%02x len %d: ", sc->slave, len); 671484b4fd4SRuslan Bukin while (*sent < len) { 672900fb59eSIan Lepore DEBUGF(sc, 1, "0x%02x ", *buf); 673484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 674484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_DATA_REG, *buf++); 675d2c05e20SIan Lepore if ((error = wait_for_xfer(sc, true)) != IIC_NOERR) 676d2c05e20SIan Lepore break; 677484b4fd4SRuslan Bukin (*sent)++; 678484b4fd4SRuslan Bukin } 679900fb59eSIan Lepore DEBUGF(sc, 1, "\n"); 680d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 681484b4fd4SRuslan Bukin } 682