2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2001 Tsubai Masanari. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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 the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * NetBSD: ki2c.c,v 1.11 2007/12/06 17:00:33 ad Exp
30 * Id: ki2c.c,v 1.7 2002/10/05 09:56:05 tsubai Exp
34 * Support routines for the Keywest I2C controller.
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <machine/resource.h>
45 #include <machine/bus.h>
48 #include <dev/iicbus/iicbus.h>
49 #include <dev/iicbus/iiconf.h>
50 #include <dev/ofw/ofw_bus.h>
51 #include "iicbus_if.h"
53 /* Keywest I2C Register offsets */
65 #define I2C_SPEED 0x03 /* Speed mask */
66 #define I2C_100kHz 0x00
67 #define I2C_50kHz 0x01
68 #define I2C_25kHz 0x02
69 #define I2C_MODE 0x0c /* Mode mask */
70 #define I2C_DUMBMODE 0x00 /* Dumb mode */
71 #define I2C_STDMODE 0x04 /* Standard mode */
72 #define I2C_STDSUBMODE 0x08 /* Standard mode + sub address */
73 #define I2C_COMBMODE 0x0c /* Combined mode */
74 #define I2C_PORT 0xf0 /* Port mask */
77 #define I2C_CT_AAK 0x01 /* Send AAK */
78 #define I2C_CT_ADDR 0x02 /* Send address(es) */
79 #define I2C_CT_STOP 0x04 /* Send STOP */
80 #define I2C_CT_START 0x08 /* Send START */
83 #define I2C_ST_BUSY 0x01 /* Busy */
84 #define I2C_ST_LASTAAK 0x02 /* Last AAK */
85 #define I2C_ST_LASTRW 0x04 /* Last R/W */
86 #define I2C_ST_SDA 0x08 /* SDA */
87 #define I2C_ST_SCL 0x10 /* SCL */
90 #define I2C_INT_DATA 0x01 /* Data byte sent/received */
91 #define I2C_INT_ADDR 0x02 /* Address sent */
92 #define I2C_INT_STOP 0x04 /* STOP condition sent */
93 #define I2C_INT_START 0x08 /* START condition sent */
97 #define I2C_READING 0x02
98 #define I2C_ERROR 0x04
99 #define I2C_SELECTED 0x08
105 struct resource *sc_reg;
107 struct resource *sc_irq;
113 uint16_t sc_i2c_base;
117 static int kiic_probe(device_t dev);
118 static int kiic_attach(device_t dev);
119 static void kiic_writereg(struct kiic_softc *sc, u_int, u_int);
120 static u_int kiic_readreg(struct kiic_softc *, u_int);
121 static void kiic_setport(struct kiic_softc *, u_int);
122 static void kiic_setmode(struct kiic_softc *, u_int);
123 static void kiic_setspeed(struct kiic_softc *, u_int);
124 static void kiic_intr(void *xsc);
125 static int kiic_transfer(device_t dev, struct iic_msg *msgs,
127 static phandle_t kiic_get_node(device_t bus, device_t dev);
129 static device_method_t kiic_methods[] = {
130 /* device interface */
131 DEVMETHOD(device_probe, kiic_probe),
132 DEVMETHOD(device_attach, kiic_attach),
134 /* iicbus interface */
135 DEVMETHOD(iicbus_callback, iicbus_null_callback),
136 DEVMETHOD(iicbus_transfer, kiic_transfer),
138 /* ofw_bus interface */
139 DEVMETHOD(ofw_bus_get_node, kiic_get_node),
143 static driver_t kiic_driver = {
146 sizeof(struct kiic_softc)
148 static devclass_t kiic_devclass;
150 DRIVER_MODULE(kiic, macio, kiic_driver, kiic_devclass, 0, 0);
151 DRIVER_MODULE(kiic, unin, kiic_driver, kiic_devclass, 0, 0);
154 kiic_probe(device_t self)
158 name = ofw_bus_get_name(self);
159 if (name && strcmp(name, "i2c") == 0) {
160 device_set_desc(self, "Keywest I2C controller");
168 kiic_attach(device_t self)
170 struct kiic_softc *sc = device_get_softc(self);
175 bzero(sc, sizeof(*sc));
178 node = ofw_bus_get_node(self);
179 if (node == 0 || node == -1) {
184 sc->sc_reg = bus_alloc_resource_any(self, SYS_RES_MEMORY,
186 if (sc->sc_reg == NULL) {
190 if (OF_getencprop(node, "AAPL,i2c-rate", &rate, 4) != 4) {
191 device_printf(self, "cannot get i2c-rate\n");
194 if (OF_getencprop(node, "AAPL,address-step", &sc->sc_regstep, 4) != 4) {
195 device_printf(self, "unable to find i2c address step\n");
200 * Some Keywest I2C devices have their children attached directly
201 * underneath them. Some have a single 'iicbus' child with the
202 * devices underneath that. Sort this out, and make sure that the
203 * OFW I2C layer has the correct node.
205 * Note: the I2C children of the Uninorth bridges have two ports.
206 * In general, the port is designated in the 9th bit of the I2C
207 * address. However, for kiic devices with children attached below
208 * an i2c-bus node, the port is indicated in the 'reg' property
209 * of the i2c-bus node.
214 node = OF_child(node);
215 if (OF_getprop(node, "name", name, sizeof(name)) > 0) {
216 if (strcmp(name,"i2c-bus") == 0) {
218 if (OF_getprop(node, "reg", ®, sizeof(reg)) > 0)
219 sc->sc_i2c_base = reg << 8;
225 mtx_init(&sc->sc_mutex, "kiic", NULL, MTX_DEF);
227 sc->sc_irq = bus_alloc_resource_any(self, SYS_RES_IRQ, &sc->sc_irqrid,
229 bus_setup_intr(self, sc->sc_irq, INTR_TYPE_MISC | INTR_MPSAFE, NULL,
230 kiic_intr, sc, &sc->sc_ih);
232 kiic_writereg(sc, ISR, kiic_readreg(sc, ISR));
233 kiic_writereg(sc, STATUS, 0);
234 kiic_writereg(sc, IER, 0);
236 kiic_setmode(sc, I2C_STDMODE);
237 kiic_setspeed(sc, I2C_100kHz); /* XXX rate */
239 kiic_writereg(sc, IER, I2C_INT_DATA | I2C_INT_ADDR | I2C_INT_STOP);
242 device_printf(self, "Revision: %02X\n", kiic_readreg(sc, REV));
244 /* Add the IIC bus layer */
245 sc->sc_iicbus = device_add_child(self, "iicbus", -1);
247 return (bus_generic_attach(self));
251 kiic_writereg(struct kiic_softc *sc, u_int reg, u_int val)
253 bus_write_4(sc->sc_reg, sc->sc_regstep * reg, val);
254 DELAY(100); /* register access delay */
258 kiic_readreg(struct kiic_softc *sc, u_int reg)
260 return bus_read_4(sc->sc_reg, sc->sc_regstep * reg) & 0xff;
264 kiic_setmode(struct kiic_softc *sc, u_int mode)
268 KASSERT((mode & ~I2C_MODE) == 0, ("bad mode"));
269 x = kiic_readreg(sc, MODE);
272 kiic_writereg(sc, MODE, x);
276 kiic_setport(struct kiic_softc *sc, u_int port)
280 KASSERT(port == 1 || port == 0, ("bad port"));
281 x = kiic_readreg(sc, MODE);
284 kiic_writereg(sc, MODE, x);
288 kiic_setspeed(struct kiic_softc *sc, u_int speed)
292 KASSERT((speed & ~I2C_SPEED) == 0, ("bad speed"));
293 x = kiic_readreg(sc, MODE);
296 kiic_writereg(sc, MODE, x);
302 struct kiic_softc *sc = xsc;
306 mtx_lock(&sc->sc_mutex);
307 isr = kiic_readreg(sc, ISR);
309 if (isr & I2C_INT_ADDR) {
310 sc->sc_flags |= I2C_SELECTED;
312 if (sc->sc_flags & I2C_READING) {
313 if (sc->sc_resid > 1) {
314 x = kiic_readreg(sc, CONTROL);
316 kiic_writereg(sc, CONTROL, x);
319 kiic_writereg(sc, DATA, *sc->sc_data++);
324 if (isr & I2C_INT_DATA) {
325 if (sc->sc_flags & I2C_READING) {
326 if (sc->sc_resid > 0) {
327 *sc->sc_data++ = kiic_readreg(sc, DATA);
330 if (sc->sc_resid == 0) /* done */
331 kiic_writereg(sc, CONTROL, 0);
333 if (sc->sc_resid == 0) {
334 x = kiic_readreg(sc, CONTROL);
336 kiic_writereg(sc, CONTROL, x);
338 kiic_writereg(sc, DATA, *sc->sc_data++);
344 if (isr & I2C_INT_STOP) {
345 kiic_writereg(sc, CONTROL, 0);
346 sc->sc_flags &= ~I2C_SELECTED;
350 kiic_writereg(sc, ISR, isr);
351 mtx_unlock(&sc->sc_mutex);
355 kiic_transfer(device_t dev, struct iic_msg *msgs, uint32_t nmsgs)
357 struct kiic_softc *sc;
362 sc = device_get_softc(dev);
366 mtx_lock(&sc->sc_mutex);
368 if (sc->sc_flags & I2C_BUSY)
369 mtx_sleep(dev, &sc->sc_mutex, 0, "kiic", timo);
371 if (sc->sc_flags & I2C_BUSY) {
372 mtx_unlock(&sc->sc_mutex);
376 sc->sc_flags = I2C_BUSY;
378 /* Clear pending interrupts, and reset controller */
379 kiic_writereg(sc, ISR, kiic_readreg(sc, ISR));
380 kiic_writereg(sc, STATUS, 0);
382 for (i = 0; i < nmsgs; i++) {
383 if (msgs[i].flags & IIC_M_NOSTOP) {
384 if (msgs[i+1].flags & IIC_M_RD)
385 kiic_setmode(sc, I2C_COMBMODE);
387 kiic_setmode(sc, I2C_STDSUBMODE);
388 KASSERT(msgs[i].len == 1, ("oversize I2C message"));
389 subaddr = msgs[i].buf[0];
392 kiic_setmode(sc, I2C_STDMODE);
395 sc->sc_data = msgs[i].buf;
396 sc->sc_resid = msgs[i].len;
397 sc->sc_flags = I2C_BUSY;
398 addr = msgs[i].slave;
399 timo = 1000 + sc->sc_resid * 200;
402 if (msgs[i].flags & IIC_M_RD) {
403 sc->sc_flags |= I2C_READING;
407 addr |= sc->sc_i2c_base;
409 kiic_setport(sc, (addr & 0x100) >> 8);
410 kiic_writereg(sc, ADDR, addr & 0xff);
411 kiic_writereg(sc, SUBADDR, subaddr);
413 x = kiic_readreg(sc, CONTROL) | I2C_CT_ADDR;
414 kiic_writereg(sc, CONTROL, x);
416 err = mtx_sleep(dev, &sc->sc_mutex, 0, "kiic", timo);
418 msgs[i].len -= sc->sc_resid;
420 if ((sc->sc_flags & I2C_ERROR) || err == EWOULDBLOCK) {
421 device_printf(sc->sc_dev, "I2C error\n");
423 mtx_unlock(&sc->sc_mutex);
430 mtx_unlock(&sc->sc_mutex);
436 kiic_get_node(device_t bus, device_t dev)
438 struct kiic_softc *sc;
440 sc = device_get_softc(bus);
441 /* We only have one child, the I2C bus, which needs our own node. */