iicoc.c revision 285830
1/*- 2 * Copyright (c) 2003-2012 Broadcom Corporation 3 * All Rights Reserved 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in 13 * the documentation and/or other materials provided with the 14 * distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY BROADCOM ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29#include <sys/cdefs.h> 30__FBSDID("$FreeBSD: releng/10.2/sys/dev/iicbus/iicoc.c 233539 2012-03-27 10:44:32Z jchandra $"); 31 32#include <sys/param.h> 33#include <sys/systm.h> 34#include <sys/kernel.h> 35#include <sys/lock.h> 36#include <sys/module.h> 37#include <sys/mutex.h> 38#include <sys/bus.h> 39#include <sys/rman.h> 40 41#include <machine/bus.h> 42 43#include <dev/iicbus/iiconf.h> 44#include <dev/iicbus/iicbus.h> 45#include <dev/iicbus/iicoc.h> 46 47#include <dev/pci/pcireg.h> 48#include <dev/pci/pcivar.h> 49 50#include "iicbus_if.h" 51 52static devclass_t iicoc_devclass; 53 54/* 55 * Device methods 56 */ 57static int iicoc_probe(device_t); 58static int iicoc_attach(device_t); 59static int iicoc_detach(device_t); 60 61static int iicoc_start(device_t dev, u_char slave, int timeout); 62static int iicoc_stop(device_t dev); 63static int iicoc_read(device_t dev, char *buf, 64 int len, int *read, int last, int delay); 65static int iicoc_write(device_t dev, const char *buf, 66 int len, int *sent, int timeout); 67static int iicoc_repeated_start(device_t dev, u_char slave, int timeout); 68 69struct iicoc_softc { 70 device_t dev; /* Self */ 71 u_int reg_shift; /* Chip specific */ 72 u_int clockfreq; 73 u_int i2cfreq; 74 struct resource *mem_res; /* Memory resource */ 75 int mem_rid; 76 int sc_started; 77 uint8_t i2cdev_addr; 78 device_t iicbus; 79 struct mtx sc_mtx; 80}; 81 82static void 83iicoc_dev_write(device_t dev, int reg, int value) 84{ 85 struct iicoc_softc *sc; 86 87 sc = device_get_softc(dev); 88 bus_write_1(sc->mem_res, reg<<sc->reg_shift, value); 89} 90 91static int 92iicoc_dev_read(device_t dev, int reg) 93{ 94 uint8_t val; 95 struct iicoc_softc *sc; 96 97 sc = device_get_softc(dev); 98 val = bus_read_1(sc->mem_res, reg<<sc->reg_shift); 99 return (val); 100} 101 102static int 103iicoc_wait_on_status(device_t dev, uint8_t bit) 104{ 105 int tries = I2C_TIMEOUT; 106 uint8_t status; 107 108 do { 109 status = iicoc_dev_read(dev, OC_I2C_STATUS_REG); 110 } while ((status & bit) != 0 && --tries > 0); 111 112 return (tries == 0 ? -1: 0); 113} 114 115static int 116iicoc_rd_cmd(device_t dev, uint8_t cmd) 117{ 118 uint8_t data; 119 120 iicoc_dev_write(dev, OC_I2C_CMD_REG, cmd); 121 if (iicoc_wait_on_status(dev, OC_STATUS_TIP) < 0) { 122 device_printf(dev, "read: Timeout waiting for TIP clear.\n"); 123 return (-1); 124 } 125 data = iicoc_dev_read(dev, OC_I2C_DATA_REG); 126 return (data); 127} 128 129static int 130iicoc_wr_cmd(device_t dev, uint8_t data, uint8_t cmd) 131{ 132 133 iicoc_dev_write(dev, OC_I2C_DATA_REG, data); 134 iicoc_dev_write(dev, OC_I2C_CMD_REG, cmd); 135 if (iicoc_wait_on_status(dev, OC_STATUS_TIP) < 0) { 136 device_printf(dev, "write: Timeout waiting for TIP clear.\n"); 137 return (-1); 138 } 139 return (0); 140} 141 142static int 143iicoc_wr_ack_cmd(device_t dev, uint8_t data, uint8_t cmd) 144{ 145 if (iicoc_wr_cmd(dev, data, cmd) < 0) 146 return (-1); 147 148 if (iicoc_dev_read(dev, OC_I2C_STATUS_REG) & OC_STATUS_NACK) { 149 device_printf(dev, "write: I2C command ACK Error.\n"); 150 return (IIC_ENOACK); 151 } 152 return (0); 153} 154 155static int 156iicoc_init(device_t dev) 157{ 158 struct iicoc_softc *sc; 159 int value; 160 161 sc = device_get_softc(dev); 162 value = iicoc_dev_read(dev, OC_I2C_CTRL_REG); 163 iicoc_dev_write(dev, OC_I2C_CTRL_REG, 164 value & ~(OC_CONTROL_EN | OC_CONTROL_IEN)); 165 value = (sc->clockfreq/(5 * sc->i2cfreq)) - 1; 166 iicoc_dev_write(dev, OC_I2C_PRESCALE_LO_REG, value & 0xff); 167 iicoc_dev_write(dev, OC_I2C_PRESCALE_HI_REG, value >> 8); 168 value = iicoc_dev_read(dev, OC_I2C_CTRL_REG); 169 iicoc_dev_write(dev, OC_I2C_CTRL_REG, value | OC_CONTROL_EN); 170 171 value = iicoc_dev_read(dev, OC_I2C_CTRL_REG); 172 /* return 0 on success, 1 on error */ 173 return ((value & OC_CONTROL_EN) == 0); 174} 175 176static int 177iicoc_probe(device_t dev) 178{ 179 struct iicoc_softc *sc; 180 181 sc = device_get_softc(dev); 182 if ((pci_get_vendor(dev) == 0x184e) && 183 (pci_get_device(dev) == 0x1011)) { 184 sc->clockfreq = XLP_I2C_CLKFREQ; 185 sc->i2cfreq = XLP_I2C_FREQ; 186 sc->reg_shift = 2; 187 device_set_desc(dev, "Netlogic XLP I2C Controller"); 188 return (BUS_PROBE_DEFAULT); 189 } 190 return (ENXIO); 191} 192 193 194/* 195 * We add all the devices which we know about. 196 * The generic attach routine will attach them if they are alive. 197 */ 198static int 199iicoc_attach(device_t dev) 200{ 201 int bus; 202 struct iicoc_softc *sc; 203 204 sc = device_get_softc(dev); 205 bus = device_get_unit(dev); 206 207 sc->dev = dev; 208 mtx_init(&sc->sc_mtx, "iicoc", "iicoc", MTX_DEF); 209 sc->mem_rid = 0; 210 sc->mem_res = bus_alloc_resource(dev, 211 SYS_RES_MEMORY, &sc->mem_rid, 0ul, ~0ul, 0x100, RF_ACTIVE); 212 213 if (sc->mem_res == NULL) { 214 device_printf(dev, "Could not allocate bus resource.\n"); 215 return (-1); 216 } 217 iicoc_init(dev); 218 sc->iicbus = device_add_child(dev, "iicbus", -1); 219 if (sc->iicbus == NULL) { 220 device_printf(dev, "Could not allocate iicbus instance.\n"); 221 return (-1); 222 } 223 bus_generic_attach(dev); 224 225 return (0); 226} 227 228static int 229iicoc_detach(device_t dev) 230{ 231 bus_generic_detach(dev); 232 233 return (0); 234} 235 236static int 237iicoc_start(device_t dev, u_char slave, int timeout) 238{ 239 int error = IIC_EBUSBSY; 240 struct iicoc_softc *sc; 241 242 sc = device_get_softc(dev); 243 mtx_lock(&sc->sc_mtx); 244 sc->i2cdev_addr = (slave >> 1); 245 246 /* Verify the bus is idle */ 247 if (iicoc_wait_on_status(dev, OC_STATUS_BUSY) < 0) 248 goto i2c_stx_error; 249 250 /* Write Slave Address */ 251 if (iicoc_wr_ack_cmd(dev, slave, OC_COMMAND_START)) { 252 device_printf(dev, 253 "I2C write slave address [0x%x] failed.\n", slave); 254 error = IIC_ENOACK; 255 goto i2c_stx_error; 256 } 257 258 /* Verify Arbitration is not Lost */ 259 if (iicoc_dev_read(dev, OC_I2C_STATUS_REG) & OC_STATUS_AL) { 260 device_printf(dev, "I2C Bus Arbitration Lost, Aborting.\n"); 261 error = IIC_EBUSERR; 262 goto i2c_stx_error; 263 } 264 error = IIC_NOERR; 265 mtx_unlock(&sc->sc_mtx); 266 return (error); 267i2c_stx_error: 268 iicoc_dev_write(dev, OC_I2C_CMD_REG, OC_COMMAND_STOP); 269 iicoc_wait_on_status(dev, OC_STATUS_BUSY); /* wait for idle */ 270 mtx_unlock(&sc->sc_mtx); 271 return (error); 272} 273 274static int 275iicoc_stop(device_t dev) 276{ 277 int error = 0; 278 struct iicoc_softc *sc; 279 280 sc = device_get_softc(dev); 281 mtx_lock(&sc->sc_mtx); 282 iicoc_dev_write(dev, OC_I2C_CMD_REG, OC_COMMAND_STOP); 283 iicoc_wait_on_status(dev, OC_STATUS_BUSY); /* wait for idle */ 284 mtx_unlock(&sc->sc_mtx); 285 return (error); 286 287} 288 289static int 290iicoc_write(device_t dev, const char *buf, int len, 291 int *sent, int timeout /* us */ ) 292{ 293 uint8_t value; 294 int i; 295 296 value = buf[0]; 297 /* Write Slave Offset */ 298 if (iicoc_wr_ack_cmd(dev, value, OC_COMMAND_WRITE)) { 299 device_printf(dev, "I2C write slave offset failed.\n"); 300 goto i2c_tx_error; 301 } 302 303 for (i = 1; i < len; i++) { 304 /* Write data byte */ 305 value = buf[i]; 306 if (iicoc_wr_cmd(dev, value, OC_COMMAND_WRITE)) { 307 device_printf(dev, "I2C write data byte %d failed.\n", 308 i); 309 goto i2c_tx_error; 310 } 311 } 312 *sent = len; 313 return (IIC_NOERR); 314 315i2c_tx_error: 316 return (IIC_EBUSERR); 317} 318 319static int 320iicoc_read(device_t dev, char *buf, int len, int *read, int last, 321 int delay) 322{ 323 int data, i; 324 uint8_t cmd; 325 326 for (i = 0; i < len; i++) { 327 /* Read data byte */ 328 cmd = (i == len - 1) ? OC_COMMAND_RDNACK : OC_COMMAND_READ; 329 data = iicoc_rd_cmd(dev, cmd); 330 if (data < 0) { 331 device_printf(dev, 332 "I2C read data byte %d failed.\n", i); 333 goto i2c_rx_error; 334 } 335 buf[i] = (uint8_t)data; 336 } 337 338 *read = len; 339 return (IIC_NOERR); 340 341i2c_rx_error: 342 return (IIC_EBUSERR); 343} 344 345static int 346iicoc_reset(device_t dev, u_char speed, u_char addr, u_char *oldadr) 347{ 348 int error; 349 struct iicoc_softc *sc; 350 351 sc = device_get_softc(dev); 352 mtx_lock(&sc->sc_mtx); 353 error = iicoc_init(dev); 354 mtx_unlock(&sc->sc_mtx); 355 return (error); 356} 357 358static int 359iicoc_repeated_start(device_t dev, u_char slave, int timeout) 360{ 361 return 0; 362} 363 364static device_method_t iicoc_methods[] = { 365 /* device interface */ 366 DEVMETHOD(device_probe, iicoc_probe), 367 DEVMETHOD(device_attach, iicoc_attach), 368 DEVMETHOD(device_detach, iicoc_detach), 369 370 /* iicbus interface */ 371 DEVMETHOD(iicbus_callback, iicbus_null_callback), 372 DEVMETHOD(iicbus_repeated_start, iicoc_repeated_start), 373 DEVMETHOD(iicbus_start, iicoc_start), 374 DEVMETHOD(iicbus_stop, iicoc_stop), 375 DEVMETHOD(iicbus_reset, iicoc_reset), 376 DEVMETHOD(iicbus_write, iicoc_write), 377 DEVMETHOD(iicbus_read, iicoc_read), 378 DEVMETHOD(iicbus_transfer, iicbus_transfer_gen), 379 380 DEVMETHOD_END 381}; 382 383static driver_t iicoc_driver = { 384 "iicoc", 385 iicoc_methods, 386 sizeof(struct iicoc_softc), 387}; 388 389DRIVER_MODULE(iicoc, pci, iicoc_driver, iicoc_devclass, 0, 0); 390DRIVER_MODULE(iicbus, iicoc, iicbus_driver, iicbus_devclass, 0, 0); 391