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> 56*900fb59eSIan 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; 142*900fb59eSIan Lepore u_int debug; 143*900fb59eSIan Lepore u_int slave; 144484b4fd4SRuslan Bukin }; 145484b4fd4SRuslan Bukin 146*900fb59eSIan Lepore #define DEVICE_DEBUGF(sc, lvl, fmt, args...) \ 147*900fb59eSIan Lepore if ((lvl) <= (sc)->debug) \ 148*900fb59eSIan Lepore device_printf((sc)->dev, fmt, ##args) 149*900fb59eSIan Lepore 150*900fb59eSIan Lepore #define DEBUGF(sc, lvl, fmt, args...) \ 151*900fb59eSIan Lepore if ((lvl) <= (sc)->debug) \ 152*900fb59eSIan Lepore printf(fmt, ##args) 153*900fb59eSIan 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); 157484b4fd4SRuslan Bukin 158484b4fd4SRuslan Bukin static int i2c_repeated_start(device_t, u_char, int); 159484b4fd4SRuslan Bukin static int i2c_start(device_t, u_char, int); 160484b4fd4SRuslan Bukin static int i2c_stop(device_t); 161484b4fd4SRuslan Bukin static int i2c_reset(device_t, u_char, u_char, u_char *); 162484b4fd4SRuslan Bukin static int i2c_read(device_t, char *, int, int *, int, int); 163484b4fd4SRuslan Bukin static int i2c_write(device_t, const char *, int, int *, int); 164484b4fd4SRuslan Bukin 165484b4fd4SRuslan Bukin static device_method_t i2c_methods[] = { 166484b4fd4SRuslan Bukin DEVMETHOD(device_probe, i2c_probe), 167484b4fd4SRuslan Bukin DEVMETHOD(device_attach, i2c_attach), 168484b4fd4SRuslan Bukin 169484b4fd4SRuslan Bukin /* OFW methods */ 170484b4fd4SRuslan Bukin DEVMETHOD(ofw_bus_get_node, i2c_get_node), 171484b4fd4SRuslan Bukin 172484b4fd4SRuslan Bukin DEVMETHOD(iicbus_callback, iicbus_null_callback), 173484b4fd4SRuslan Bukin DEVMETHOD(iicbus_repeated_start, i2c_repeated_start), 174484b4fd4SRuslan Bukin DEVMETHOD(iicbus_start, i2c_start), 175484b4fd4SRuslan Bukin DEVMETHOD(iicbus_stop, i2c_stop), 176484b4fd4SRuslan Bukin DEVMETHOD(iicbus_reset, i2c_reset), 177484b4fd4SRuslan Bukin DEVMETHOD(iicbus_read, i2c_read), 178484b4fd4SRuslan Bukin DEVMETHOD(iicbus_write, i2c_write), 179484b4fd4SRuslan Bukin DEVMETHOD(iicbus_transfer, iicbus_transfer_gen), 180484b4fd4SRuslan Bukin 181d2c05e20SIan Lepore DEVMETHOD_END 182484b4fd4SRuslan Bukin }; 183484b4fd4SRuslan Bukin 184484b4fd4SRuslan Bukin static driver_t i2c_driver = { 185484b4fd4SRuslan Bukin "iichb", 186484b4fd4SRuslan Bukin i2c_methods, 187484b4fd4SRuslan Bukin sizeof(struct i2c_softc), 188484b4fd4SRuslan Bukin }; 189484b4fd4SRuslan Bukin static devclass_t i2c_devclass; 190484b4fd4SRuslan Bukin 191484b4fd4SRuslan Bukin DRIVER_MODULE(i2c, simplebus, i2c_driver, i2c_devclass, 0, 0); 192484b4fd4SRuslan Bukin DRIVER_MODULE(iicbus, i2c, iicbus_driver, iicbus_devclass, 0, 0); 193484b4fd4SRuslan Bukin 194484b4fd4SRuslan Bukin static phandle_t 195484b4fd4SRuslan Bukin i2c_get_node(device_t bus, device_t dev) 196484b4fd4SRuslan Bukin { 197484b4fd4SRuslan Bukin /* 198484b4fd4SRuslan Bukin * Share controller node with iicbus device 199484b4fd4SRuslan Bukin */ 200484b4fd4SRuslan Bukin return ofw_bus_get_node(bus); 201484b4fd4SRuslan Bukin } 202484b4fd4SRuslan Bukin 203484b4fd4SRuslan Bukin static __inline void 204484b4fd4SRuslan Bukin i2c_write_reg(struct i2c_softc *sc, bus_size_t off, uint8_t val) 205484b4fd4SRuslan Bukin { 206484b4fd4SRuslan Bukin 207d2c05e20SIan Lepore bus_write_1(sc->res, off, val); 208484b4fd4SRuslan Bukin } 209484b4fd4SRuslan Bukin 210484b4fd4SRuslan Bukin static __inline uint8_t 211484b4fd4SRuslan Bukin i2c_read_reg(struct i2c_softc *sc, bus_size_t off) 212484b4fd4SRuslan Bukin { 213484b4fd4SRuslan Bukin 214d2c05e20SIan Lepore return (bus_read_1(sc->res, off)); 215484b4fd4SRuslan Bukin } 216484b4fd4SRuslan Bukin 217484b4fd4SRuslan Bukin static __inline void 218484b4fd4SRuslan Bukin i2c_flag_set(struct i2c_softc *sc, bus_size_t off, uint8_t mask) 219484b4fd4SRuslan Bukin { 220484b4fd4SRuslan Bukin uint8_t status; 221484b4fd4SRuslan Bukin 222484b4fd4SRuslan Bukin status = i2c_read_reg(sc, off); 223484b4fd4SRuslan Bukin status |= mask; 224484b4fd4SRuslan Bukin i2c_write_reg(sc, off, status); 225484b4fd4SRuslan Bukin } 226484b4fd4SRuslan Bukin 227d2c05e20SIan Lepore /* Wait for bus to become busy or not-busy. */ 228484b4fd4SRuslan Bukin static int 229d2c05e20SIan Lepore wait_for_busbusy(struct i2c_softc *sc, int wantbusy) 230484b4fd4SRuslan Bukin { 231d2c05e20SIan Lepore int retry, srb; 232484b4fd4SRuslan Bukin 233484b4fd4SRuslan Bukin retry = 1000; 234484b4fd4SRuslan Bukin while (retry --) { 235d2c05e20SIan Lepore srb = i2c_read_reg(sc, I2C_STATUS_REG) & I2CSR_MBB; 236d2c05e20SIan Lepore if ((srb && wantbusy) || (!srb && !wantbusy)) 237484b4fd4SRuslan Bukin return (IIC_NOERR); 238d2c05e20SIan Lepore DELAY(1); 239484b4fd4SRuslan Bukin } 240484b4fd4SRuslan Bukin return (IIC_ETIMEOUT); 241484b4fd4SRuslan Bukin } 242484b4fd4SRuslan Bukin 243d2c05e20SIan Lepore /* Wait for transfer to complete, optionally check RXAK. */ 244484b4fd4SRuslan Bukin static int 245d2c05e20SIan Lepore wait_for_xfer(struct i2c_softc *sc, int checkack) 246484b4fd4SRuslan Bukin { 247d2c05e20SIan Lepore int retry, sr; 248484b4fd4SRuslan Bukin 249d2c05e20SIan Lepore /* 250d2c05e20SIan Lepore * Sleep for about the time it takes to transfer a byte (with precision 251d2c05e20SIan Lepore * set to tolerate 5% oversleep). We calculate the approximate byte 252d2c05e20SIan Lepore * transfer time when we set the bus speed divisor. Slaves are allowed 253d2c05e20SIan Lepore * to do clock-stretching so the actual transfer time can be larger, but 254d2c05e20SIan Lepore * this gets the bulk of the waiting out of the way without tying up the 255d2c05e20SIan Lepore * processor the whole time. 256d2c05e20SIan Lepore */ 257d2c05e20SIan Lepore pause_sbt("imxi2c", sc->byte_time_sbt, sc->byte_time_sbt / 20, 0); 258d2c05e20SIan Lepore 259d2c05e20SIan Lepore retry = 10000; 260484b4fd4SRuslan Bukin while (retry --) { 261d2c05e20SIan Lepore sr = i2c_read_reg(sc, I2C_STATUS_REG); 262d2c05e20SIan Lepore if (sr & I2CSR_MIF) { 263d2c05e20SIan Lepore if (sr & I2CSR_MAL) 264d1e99670SIan Lepore return (IIC_EBUSERR); 265d2c05e20SIan Lepore else if (checkack && (sr & I2CSR_RXAK)) 266d2c05e20SIan Lepore return (IIC_ENOACK); 267d2c05e20SIan Lepore else 268484b4fd4SRuslan Bukin return (IIC_NOERR); 269484b4fd4SRuslan Bukin } 270d2c05e20SIan Lepore DELAY(1); 271d2c05e20SIan Lepore } 272484b4fd4SRuslan Bukin return (IIC_ETIMEOUT); 273484b4fd4SRuslan Bukin } 274484b4fd4SRuslan Bukin 275d2c05e20SIan Lepore /* 276d2c05e20SIan Lepore * Implement the error handling shown in the state diagram of the imx6 reference 277d2c05e20SIan Lepore * manual. If there was an error, then: 278d2c05e20SIan Lepore * - Clear master mode (MSTA and MTX). 279d2c05e20SIan Lepore * - Wait for the bus to become free or for a timeout to happen. 280d2c05e20SIan Lepore * - Disable the controller. 281d2c05e20SIan Lepore */ 282484b4fd4SRuslan Bukin static int 283d2c05e20SIan Lepore i2c_error_handler(struct i2c_softc *sc, int error) 284484b4fd4SRuslan Bukin { 285484b4fd4SRuslan Bukin 286d2c05e20SIan Lepore if (error != 0) { 287d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0); 288d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN); 289d2c05e20SIan Lepore wait_for_busbusy(sc, false); 290d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, 0); 291484b4fd4SRuslan Bukin } 292d2c05e20SIan Lepore return (error); 293484b4fd4SRuslan Bukin } 294484b4fd4SRuslan Bukin 295484b4fd4SRuslan Bukin static int 2968928c2e4SIan Lepore i2c_recover_getsda(void *ctx) 2978928c2e4SIan Lepore { 2988928c2e4SIan Lepore bool active; 2998928c2e4SIan Lepore 3008928c2e4SIan Lepore gpio_pin_is_active(((struct i2c_softc *)ctx)->rb_sdapin, &active); 3018928c2e4SIan Lepore return (active); 3028928c2e4SIan Lepore } 3038928c2e4SIan Lepore 3048928c2e4SIan Lepore static void 3058928c2e4SIan Lepore i2c_recover_setsda(void *ctx, int value) 3068928c2e4SIan Lepore { 3078928c2e4SIan Lepore 3088928c2e4SIan Lepore gpio_pin_set_active(((struct i2c_softc *)ctx)->rb_sdapin, value); 3098928c2e4SIan Lepore } 3108928c2e4SIan Lepore 3118928c2e4SIan Lepore static int 3128928c2e4SIan Lepore i2c_recover_getscl(void *ctx) 3138928c2e4SIan Lepore { 3148928c2e4SIan Lepore bool active; 3158928c2e4SIan Lepore 3168928c2e4SIan Lepore gpio_pin_is_active(((struct i2c_softc *)ctx)->rb_sclpin, &active); 3178928c2e4SIan Lepore return (active); 3188928c2e4SIan Lepore 3198928c2e4SIan Lepore } 3208928c2e4SIan Lepore 3218928c2e4SIan Lepore static void 3228928c2e4SIan Lepore i2c_recover_setscl(void *ctx, int value) 3238928c2e4SIan Lepore { 3248928c2e4SIan Lepore 3258928c2e4SIan Lepore gpio_pin_set_active(((struct i2c_softc *)ctx)->rb_sclpin, value); 3268928c2e4SIan Lepore } 3278928c2e4SIan Lepore 3288928c2e4SIan Lepore static int 3298928c2e4SIan Lepore i2c_recover_bus(struct i2c_softc *sc) 3308928c2e4SIan Lepore { 3318928c2e4SIan Lepore struct iicrb_pin_access pins; 3328928c2e4SIan Lepore int err; 3338928c2e4SIan Lepore 3348928c2e4SIan Lepore /* 3358928c2e4SIan Lepore * If we have gpio pinmux config, reconfigure the pins to gpio mode, 3368928c2e4SIan Lepore * invoke iic_recover_bus which checks for a hung bus and bitbangs a 3378928c2e4SIan Lepore * recovery sequence if necessary, then configure the pins back to i2c 3388928c2e4SIan Lepore * mode (idx 0). 3398928c2e4SIan Lepore */ 3408928c2e4SIan Lepore if (sc->rb_pinctl_idx == 0) 3418928c2e4SIan Lepore return (0); 3428928c2e4SIan Lepore 3438928c2e4SIan Lepore fdt_pinctrl_configure(sc->dev, sc->rb_pinctl_idx); 3448928c2e4SIan Lepore 3458928c2e4SIan Lepore pins.ctx = sc; 3468928c2e4SIan Lepore pins.getsda = i2c_recover_getsda; 3478928c2e4SIan Lepore pins.setsda = i2c_recover_setsda; 3488928c2e4SIan Lepore pins.getscl = i2c_recover_getscl; 3498928c2e4SIan Lepore pins.setscl = i2c_recover_setscl; 3508928c2e4SIan Lepore err = iic_recover_bus(&pins); 3518928c2e4SIan Lepore 3528928c2e4SIan Lepore fdt_pinctrl_configure(sc->dev, 0); 3538928c2e4SIan Lepore 3548928c2e4SIan Lepore return (err); 3558928c2e4SIan Lepore } 3568928c2e4SIan Lepore 3578928c2e4SIan Lepore static int 358484b4fd4SRuslan Bukin i2c_probe(device_t dev) 359484b4fd4SRuslan Bukin { 360484b4fd4SRuslan Bukin 361484b4fd4SRuslan Bukin if (!ofw_bus_status_okay(dev)) 362484b4fd4SRuslan Bukin return (ENXIO); 363484b4fd4SRuslan Bukin 36440d7d632SRuslan Bukin if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0) 365484b4fd4SRuslan Bukin return (ENXIO); 366484b4fd4SRuslan Bukin 367d2c05e20SIan Lepore device_set_desc(dev, "Freescale i.MX I2C"); 368484b4fd4SRuslan Bukin 369484b4fd4SRuslan Bukin return (BUS_PROBE_DEFAULT); 370484b4fd4SRuslan Bukin } 371484b4fd4SRuslan Bukin 372484b4fd4SRuslan Bukin static int 373484b4fd4SRuslan Bukin i2c_attach(device_t dev) 374484b4fd4SRuslan Bukin { 3758928c2e4SIan Lepore char wrkstr[16]; 376484b4fd4SRuslan Bukin struct i2c_softc *sc; 3778928c2e4SIan Lepore phandle_t node; 3788928c2e4SIan Lepore int err, cfgidx; 379484b4fd4SRuslan Bukin 380484b4fd4SRuslan Bukin sc = device_get_softc(dev); 381484b4fd4SRuslan Bukin sc->dev = dev; 382484b4fd4SRuslan Bukin sc->rid = 0; 383484b4fd4SRuslan Bukin 384484b4fd4SRuslan Bukin sc->res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->rid, 385484b4fd4SRuslan Bukin RF_ACTIVE); 386484b4fd4SRuslan Bukin if (sc->res == NULL) { 387484b4fd4SRuslan Bukin device_printf(dev, "could not allocate resources"); 388484b4fd4SRuslan Bukin return (ENXIO); 389484b4fd4SRuslan Bukin } 390484b4fd4SRuslan Bukin 391484b4fd4SRuslan Bukin sc->iicbus = device_add_child(dev, "iicbus", -1); 392484b4fd4SRuslan Bukin if (sc->iicbus == NULL) { 393484b4fd4SRuslan Bukin device_printf(dev, "could not add iicbus child"); 394484b4fd4SRuslan Bukin return (ENXIO); 395484b4fd4SRuslan Bukin } 396484b4fd4SRuslan Bukin 397*900fb59eSIan Lepore /* Set up debug-enable sysctl. */ 398*900fb59eSIan Lepore SYSCTL_ADD_INT(device_get_sysctl_ctx(sc->dev), 399*900fb59eSIan Lepore SYSCTL_CHILDREN(device_get_sysctl_tree(sc->dev)), 400*900fb59eSIan Lepore OID_AUTO, "debug", CTLFLAG_RWTUN, &sc->debug, 0, 401*900fb59eSIan Lepore "Enable debug; 1=reads/writes, 2=add starts/stops"); 402*900fb59eSIan Lepore 4038928c2e4SIan Lepore /* 4048928c2e4SIan Lepore * Set up for bus recovery using gpio pins, if the pinctrl and gpio 4058928c2e4SIan Lepore * properties are present. This is optional. If all the config data is 4068928c2e4SIan Lepore * not in place, we just don't do gpio bitbang bus recovery. 4078928c2e4SIan Lepore */ 4088928c2e4SIan Lepore node = ofw_bus_get_node(sc->dev); 4098928c2e4SIan Lepore 4108928c2e4SIan Lepore err = gpio_pin_get_by_ofw_property(dev, node, "scl-gpios", 4118928c2e4SIan Lepore &sc->rb_sclpin); 4128928c2e4SIan Lepore if (err != 0) 4138928c2e4SIan Lepore goto no_recovery; 4148928c2e4SIan Lepore err = gpio_pin_get_by_ofw_property(dev, node, "sda-gpios", 4158928c2e4SIan Lepore &sc->rb_sdapin); 4168928c2e4SIan Lepore if (err != 0) 4178928c2e4SIan Lepore goto no_recovery; 4188928c2e4SIan Lepore 4198928c2e4SIan Lepore /* 4208928c2e4SIan Lepore * Preset the gpio pins to output high (idle bus state). The signal 4218928c2e4SIan Lepore * won't actually appear on the pins until the bus recovery code changes 4228928c2e4SIan Lepore * the pinmux config from i2c to gpio. 4238928c2e4SIan Lepore */ 4248928c2e4SIan Lepore gpio_pin_setflags(sc->rb_sclpin, GPIO_PIN_OUTPUT); 4258928c2e4SIan Lepore gpio_pin_setflags(sc->rb_sdapin, GPIO_PIN_OUTPUT); 4268928c2e4SIan Lepore gpio_pin_set_active(sc->rb_sclpin, true); 4278928c2e4SIan Lepore gpio_pin_set_active(sc->rb_sdapin, true); 4288928c2e4SIan Lepore 4298928c2e4SIan Lepore /* 4308928c2e4SIan Lepore * Obtain the index of pinctrl node for bus recovery using gpio pins, 4318928c2e4SIan Lepore * then confirm that pinctrl properties exist for that index and for the 4328928c2e4SIan Lepore * default pinctrl-0. If sc->rb_pinctl_idx is non-zero, the reset code 4338928c2e4SIan Lepore * will also do a bus recovery, so setting this value must be last. 4348928c2e4SIan Lepore */ 4358928c2e4SIan Lepore err = ofw_bus_find_string_index(node, "pinctrl-names", "gpio", &cfgidx); 4368928c2e4SIan Lepore if (err == 0) { 4378928c2e4SIan Lepore snprintf(wrkstr, sizeof(wrkstr), "pinctrl-%d", cfgidx); 4388928c2e4SIan Lepore if (OF_hasprop(node, "pinctrl-0") && OF_hasprop(node, wrkstr)) 4398928c2e4SIan Lepore sc->rb_pinctl_idx = cfgidx; 4408928c2e4SIan Lepore } 4418928c2e4SIan Lepore 4428928c2e4SIan Lepore no_recovery: 4438928c2e4SIan Lepore 4448928c2e4SIan Lepore /* We don't do a hardware reset here because iicbus_attach() does it. */ 4458928c2e4SIan Lepore 446484b4fd4SRuslan Bukin bus_generic_attach(dev); 447d2c05e20SIan Lepore return (0); 448484b4fd4SRuslan Bukin } 449484b4fd4SRuslan Bukin 450484b4fd4SRuslan Bukin static int 451484b4fd4SRuslan Bukin i2c_repeated_start(device_t dev, u_char slave, int timeout) 452484b4fd4SRuslan Bukin { 453484b4fd4SRuslan Bukin struct i2c_softc *sc; 454484b4fd4SRuslan Bukin int error; 455484b4fd4SRuslan Bukin 456484b4fd4SRuslan Bukin sc = device_get_softc(dev); 457484b4fd4SRuslan Bukin 458484b4fd4SRuslan Bukin if ((i2c_read_reg(sc, I2C_STATUS_REG) & I2CSR_MBB) == 0) { 459d2c05e20SIan Lepore return (IIC_EBUSERR); 460484b4fd4SRuslan Bukin } 461484b4fd4SRuslan Bukin 462d2c05e20SIan Lepore /* 463d2c05e20SIan Lepore * Set repeated start condition, delay (per reference manual, min 156nS) 464d2c05e20SIan Lepore * before writing slave address, wait for ack after write. 465d2c05e20SIan Lepore */ 466484b4fd4SRuslan Bukin i2c_flag_set(sc, I2C_CONTROL_REG, I2CCR_RSTA); 467d2c05e20SIan Lepore DELAY(1); 468484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 469484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_DATA_REG, slave); 470*900fb59eSIan Lepore sc->slave = slave; 471*900fb59eSIan Lepore DEVICE_DEBUGF(sc, 2, "rstart 0x%02x\n", sc->slave); 472d2c05e20SIan Lepore error = wait_for_xfer(sc, true); 473d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 474484b4fd4SRuslan Bukin } 475484b4fd4SRuslan Bukin 476484b4fd4SRuslan Bukin static int 4778928c2e4SIan Lepore i2c_start_ll(device_t dev, u_char slave, int timeout) 478484b4fd4SRuslan Bukin { 479484b4fd4SRuslan Bukin struct i2c_softc *sc; 480484b4fd4SRuslan Bukin int error; 481484b4fd4SRuslan Bukin 482484b4fd4SRuslan Bukin sc = device_get_softc(dev); 483484b4fd4SRuslan Bukin 484d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN); 485d2c05e20SIan Lepore DELAY(10); /* Delay for controller to sample bus state. */ 486484b4fd4SRuslan Bukin if (i2c_read_reg(sc, I2C_STATUS_REG) & I2CSR_MBB) { 487d1e99670SIan Lepore return (i2c_error_handler(sc, IIC_EBUSERR)); 488484b4fd4SRuslan Bukin } 489d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | I2CCR_MSTA | I2CCR_MTX); 490d2c05e20SIan Lepore if ((error = wait_for_busbusy(sc, true)) != IIC_NOERR) 491d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 492d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0); 493484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_DATA_REG, slave); 494*900fb59eSIan Lepore sc->slave = slave; 495*900fb59eSIan Lepore DEVICE_DEBUGF(sc, 2, "start 0x%02x\n", sc->slave); 496d2c05e20SIan Lepore error = wait_for_xfer(sc, true); 497d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 498484b4fd4SRuslan Bukin } 499484b4fd4SRuslan Bukin 500484b4fd4SRuslan Bukin static int 5018928c2e4SIan Lepore i2c_start(device_t dev, u_char slave, int timeout) 5028928c2e4SIan Lepore { 5038928c2e4SIan Lepore struct i2c_softc *sc; 5048928c2e4SIan Lepore int error; 5058928c2e4SIan Lepore 5068928c2e4SIan Lepore sc = device_get_softc(dev); 5078928c2e4SIan Lepore 5088928c2e4SIan Lepore /* 5098928c2e4SIan Lepore * Invoke the low-level code to put the bus into master mode and address 5108928c2e4SIan Lepore * the given slave. If that fails, idle the controller and attempt a 5118928c2e4SIan Lepore * bus recovery, and then try again one time. Signaling a start and 5128928c2e4SIan Lepore * addressing the slave is the only operation that a low-level driver 5138928c2e4SIan Lepore * can safely retry without any help from the upper layers that know 5148928c2e4SIan Lepore * more about the slave device. 5158928c2e4SIan Lepore */ 5168928c2e4SIan Lepore if ((error = i2c_start_ll(dev, slave, timeout)) != 0) { 5178928c2e4SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, 0x0); 5188928c2e4SIan Lepore if ((error = i2c_recover_bus(sc)) != 0) 5198928c2e4SIan Lepore return (error); 5208928c2e4SIan Lepore error = i2c_start_ll(dev, slave, timeout); 5218928c2e4SIan Lepore } 5228928c2e4SIan Lepore return (error); 5238928c2e4SIan Lepore } 5248928c2e4SIan Lepore 5258928c2e4SIan Lepore static int 526484b4fd4SRuslan Bukin i2c_stop(device_t dev) 527484b4fd4SRuslan Bukin { 528484b4fd4SRuslan Bukin struct i2c_softc *sc; 529484b4fd4SRuslan Bukin 530484b4fd4SRuslan Bukin sc = device_get_softc(dev); 531d2c05e20SIan Lepore 532d2c05e20SIan Lepore i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN); 533d2c05e20SIan Lepore wait_for_busbusy(sc, false); 534484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, 0); 535*900fb59eSIan Lepore DEVICE_DEBUGF(sc, 2, "stop 0x%02x\n", sc->slave); 536484b4fd4SRuslan Bukin return (IIC_NOERR); 537484b4fd4SRuslan Bukin } 538484b4fd4SRuslan Bukin 539484b4fd4SRuslan Bukin static int 540484b4fd4SRuslan Bukin i2c_reset(device_t dev, u_char speed, u_char addr, u_char *oldadr) 541484b4fd4SRuslan Bukin { 542484b4fd4SRuslan Bukin struct i2c_softc *sc; 543844aff82SIan Lepore u_int busfreq, div, i, ipgfreq; 544484b4fd4SRuslan Bukin 545484b4fd4SRuslan Bukin sc = device_get_softc(dev); 546484b4fd4SRuslan Bukin 547*900fb59eSIan Lepore DEVICE_DEBUGF(sc, 1, "reset\n"); 548*900fb59eSIan Lepore 549844aff82SIan Lepore /* 550844aff82SIan Lepore * Look up the divisor that gives the nearest speed that doesn't exceed 551844aff82SIan Lepore * the configured value for the bus. 552844aff82SIan Lepore */ 553844aff82SIan Lepore ipgfreq = imx_ccm_ipg_hz(); 554844aff82SIan Lepore busfreq = IICBUS_GET_FREQUENCY(sc->iicbus, speed); 555f0e56111SPedro F. Giffuni div = howmany(ipgfreq, busfreq); 556844aff82SIan Lepore for (i = 0; i < nitems(clkdiv_table); i++) { 557844aff82SIan Lepore if (clkdiv_table[i].divisor >= div) 558484b4fd4SRuslan Bukin break; 559484b4fd4SRuslan Bukin } 560484b4fd4SRuslan Bukin 561d2c05e20SIan Lepore /* 562d2c05e20SIan Lepore * Calculate roughly how long it will take to transfer a byte (which 563d2c05e20SIan Lepore * requires 9 clock cycles) at the new bus speed. This value is used to 564d2c05e20SIan Lepore * pause() while waiting for transfer-complete. With a 66MHz IPG clock 565d2c05e20SIan Lepore * and the actual i2c bus speeds that leads to, for nominal 100KHz and 566d2c05e20SIan Lepore * 400KHz bus speeds the transfer times are roughly 104uS and 22uS. 567d2c05e20SIan Lepore */ 568d2c05e20SIan Lepore busfreq = ipgfreq / clkdiv_table[i].divisor; 569d2c05e20SIan Lepore sc->byte_time_sbt = SBT_1US * (9000000 / busfreq); 570d2c05e20SIan Lepore 571d2c05e20SIan Lepore /* 572d2c05e20SIan Lepore * Disable the controller (do the reset), and set the new clock divisor. 573d2c05e20SIan Lepore */ 574d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 575484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, 0x0); 576d2c05e20SIan Lepore i2c_write_reg(sc, I2C_FDR_REG, (uint8_t)clkdiv_table[i].regcode); 5778928c2e4SIan Lepore 5788928c2e4SIan Lepore /* 5798928c2e4SIan Lepore * Now that the controller is idle, perform bus recovery. If the bus 5808928c2e4SIan Lepore * isn't hung, this a fairly fast no-op. 5818928c2e4SIan Lepore */ 5828928c2e4SIan Lepore return (i2c_recover_bus(sc)); 583484b4fd4SRuslan Bukin } 584484b4fd4SRuslan Bukin 585484b4fd4SRuslan Bukin static int 586484b4fd4SRuslan Bukin i2c_read(device_t dev, char *buf, int len, int *read, int last, int delay) 587484b4fd4SRuslan Bukin { 588484b4fd4SRuslan Bukin struct i2c_softc *sc; 589484b4fd4SRuslan Bukin int error, reg; 590484b4fd4SRuslan Bukin 591484b4fd4SRuslan Bukin sc = device_get_softc(dev); 592484b4fd4SRuslan Bukin *read = 0; 593484b4fd4SRuslan Bukin 594*900fb59eSIan Lepore DEVICE_DEBUGF(sc, 1, "read 0x%02x len %d: ", sc->slave, len); 595484b4fd4SRuslan Bukin if (len) { 596484b4fd4SRuslan Bukin if (len == 1) 597484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 598484b4fd4SRuslan Bukin I2CCR_MSTA | I2CCR_TXAK); 599484b4fd4SRuslan Bukin else 600484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 601484b4fd4SRuslan Bukin I2CCR_MSTA); 602d2c05e20SIan Lepore /* Dummy read to prime the receiver. */ 603484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 604d2c05e20SIan Lepore i2c_read_reg(sc, I2C_DATA_REG); 605d2c05e20SIan Lepore } 606d2c05e20SIan Lepore 607d2c05e20SIan Lepore error = 0; 608d2c05e20SIan Lepore *read = 0; 609d2c05e20SIan Lepore while (*read < len) { 610d2c05e20SIan Lepore if ((error = wait_for_xfer(sc, false)) != IIC_NOERR) 611d2c05e20SIan Lepore break; 612d2c05e20SIan Lepore i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 613d2c05e20SIan Lepore if (last) { 614d2c05e20SIan Lepore if (*read == len - 2) { 615484b4fd4SRuslan Bukin /* NO ACK on last byte */ 616484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 617484b4fd4SRuslan Bukin I2CCR_MSTA | I2CCR_TXAK); 618d2c05e20SIan Lepore } else if (*read == len - 1) { 619d2c05e20SIan Lepore /* Transfer done, signal stop. */ 620484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_CONTROL_REG, I2CCR_MEN | 621484b4fd4SRuslan Bukin I2CCR_TXAK); 622d2c05e20SIan Lepore wait_for_busbusy(sc, false); 623484b4fd4SRuslan Bukin } 624d2c05e20SIan Lepore } 625484b4fd4SRuslan Bukin reg = i2c_read_reg(sc, I2C_DATA_REG); 626*900fb59eSIan Lepore DEBUGF(sc, 1, "0x%02x ", reg); 627484b4fd4SRuslan Bukin *buf++ = reg; 628484b4fd4SRuslan Bukin (*read)++; 629484b4fd4SRuslan Bukin } 630*900fb59eSIan Lepore DEBUGF(sc, 1, "\n"); 631484b4fd4SRuslan Bukin 632d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 633484b4fd4SRuslan Bukin } 634484b4fd4SRuslan Bukin 635484b4fd4SRuslan Bukin static int 636484b4fd4SRuslan Bukin i2c_write(device_t dev, const char *buf, int len, int *sent, int timeout) 637484b4fd4SRuslan Bukin { 638484b4fd4SRuslan Bukin struct i2c_softc *sc; 639484b4fd4SRuslan Bukin int error; 640484b4fd4SRuslan Bukin 641484b4fd4SRuslan Bukin sc = device_get_softc(dev); 642484b4fd4SRuslan Bukin 643d2c05e20SIan Lepore error = 0; 644d2c05e20SIan Lepore *sent = 0; 645*900fb59eSIan Lepore DEVICE_DEBUGF(sc, 1, "write 0x%02x len %d: ", sc->slave, len); 646484b4fd4SRuslan Bukin while (*sent < len) { 647*900fb59eSIan Lepore DEBUGF(sc, 1, "0x%02x ", *buf); 648484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_STATUS_REG, 0x0); 649484b4fd4SRuslan Bukin i2c_write_reg(sc, I2C_DATA_REG, *buf++); 650d2c05e20SIan Lepore if ((error = wait_for_xfer(sc, true)) != IIC_NOERR) 651d2c05e20SIan Lepore break; 652484b4fd4SRuslan Bukin (*sent)++; 653484b4fd4SRuslan Bukin } 654*900fb59eSIan Lepore DEBUGF(sc, 1, "\n"); 655d2c05e20SIan Lepore return (i2c_error_handler(sc, error)); 656484b4fd4SRuslan Bukin } 657