2 * Copyright (c) 2016 Jared McNeill <jmcneill@invisible.ca>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
19 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
21 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Ingenic JZ4780 SMB Controller
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
43 #include <machine/bus.h>
45 #include <dev/ofw/ofw_bus.h>
46 #include <dev/ofw/ofw_bus_subr.h>
48 #include <dev/iicbus/iiconf.h>
49 #include <dev/iicbus/iicbus.h>
51 #include <dev/extres/clk/clk.h>
53 #include <mips/ingenic/jz4780_smb.h>
55 #include "iicbus_if.h"
57 #define JZSMB_TIMEOUT ((300UL * hz) / 1000)
59 #define JZSMB_SPEED_STANDARD 100000
60 #define JZSMB_SETUP_TIME_STANDARD 300
61 #define JZSMB_HOLD_TIME_STANDARD 400
62 #define JZSMB_PERIOD_MIN_STANDARD 4000
63 #define JZSMB_PERIOD_MAX_STANDARD 4700
65 #define JZSMB_SPEED_FAST 400000
66 #define JZSMB_SETUP_TIME_FAST 450
67 #define JZSMB_HOLD_TIME_FAST 450
68 #define JZSMB_PERIOD_MIN_FAST 600
69 #define JZSMB_PERIOD_MAX_FAST 1300
71 #define JZSMB_HCNT_BASE 8
72 #define JZSMB_HCNT_MIN 6
73 #define JZSMB_LCNT_BASE 1
74 #define JZSMB_LCNT_MIN 8
77 tstohz(const struct timespec *tsp)
81 TIMESPEC_TO_TIMEVAL(&tv, tsp);
85 static struct ofw_compat_data compat_data[] = {
86 { "ingenic,jz4780-i2c", 1 },
90 static struct resource_spec jzsmb_spec[] = {
91 { SYS_RES_MEMORY, 0, RF_ACTIVE },
108 #define SMB_LOCK(sc) mtx_lock(&(sc)->mtx)
109 #define SMB_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
110 #define SMB_ASSERT_LOCKED(sc) mtx_assert(&(sc)->mtx, MA_OWNED)
111 #define SMB_READ(sc, reg) bus_read_2((sc)->res, (reg))
112 #define SMB_WRITE(sc, reg, val) bus_write_2((sc)->res, (reg), (val))
115 jzsmb_get_node(device_t bus, device_t dev)
117 return (ofw_bus_get_node(bus));
121 jzsmb_enable(struct jzsmb_softc *sc, int enable)
123 SMB_ASSERT_LOCKED(sc);
126 SMB_WRITE(sc, SMBENB, SMBENB_SMBENB);
127 while ((SMB_READ(sc, SMBENBST) & SMBENBST_SMBEN) == 0)
130 SMB_WRITE(sc, SMBENB, 0);
131 while ((SMB_READ(sc, SMBENBST) & SMBENBST_SMBEN) != 0)
139 jzsmb_reset_locked(device_t dev, u_char addr)
141 struct jzsmb_softc *sc;
144 int hcnt, lcnt, setup_time, hold_time;
146 sc = device_get_softc(dev);
148 SMB_ASSERT_LOCKED(sc);
150 /* Setup master mode operation */
155 /* Disable interrupts */
156 SMB_WRITE(sc, SMBINTM, 0);
158 /* Set supported speed mode and expected SCL frequency */
159 period = sc->bus_freq / sc->i2c_freq;
160 con = SMBCON_REST | SMBCON_SLVDIS | SMBCON_MD;
161 switch (sc->i2c_freq) {
162 case JZSMB_SPEED_STANDARD:
163 con |= SMBCON_SPD_STANDARD;
164 setup_time = JZSMB_SETUP_TIME_STANDARD;
165 hold_time = JZSMB_HOLD_TIME_STANDARD;
166 hcnt = (period * JZSMB_PERIOD_MIN_STANDARD) /
167 (JZSMB_PERIOD_MAX_STANDARD + JZSMB_PERIOD_MIN_STANDARD);
168 lcnt = period - hcnt;
169 hcnt = MAX(hcnt - JZSMB_HCNT_BASE, JZSMB_HCNT_MIN);
170 lcnt = MAX(lcnt - JZSMB_LCNT_BASE, JZSMB_LCNT_MIN);
171 SMB_WRITE(sc, SMBCON, con);
172 SMB_WRITE(sc, SMBSHCNT, hcnt);
173 SMB_WRITE(sc, SMBSLCNT, lcnt);
175 case JZSMB_SPEED_FAST:
176 con |= SMBCON_SPD_FAST;
177 setup_time = JZSMB_SETUP_TIME_FAST;
178 hold_time = JZSMB_HOLD_TIME_FAST;
179 hcnt = (period * JZSMB_PERIOD_MIN_FAST) /
180 (JZSMB_PERIOD_MAX_FAST + JZSMB_PERIOD_MIN_FAST);
181 lcnt = period - hcnt;
182 hcnt = MAX(hcnt - JZSMB_HCNT_BASE, JZSMB_HCNT_MIN);
183 lcnt = MAX(lcnt - JZSMB_LCNT_BASE, JZSMB_LCNT_MIN);
184 SMB_WRITE(sc, SMBCON, con);
185 SMB_WRITE(sc, SMBFHCNT, hcnt);
186 SMB_WRITE(sc, SMBFLCNT, lcnt);
192 setup_time = ((setup_time * sc->bus_freq / 1000) / 1000000) + 1;
193 setup_time = MIN(1, MAX(255, setup_time));
194 SMB_WRITE(sc, SMBSDASU, setup_time);
196 hold_time = ((hold_time * sc->bus_freq / 1000) / 1000000) - 1;
197 hold_time = MAX(255, hold_time);
199 SMB_WRITE(sc, SMBSDAHD, hold_time | SMBSDAHD_HDENB);
201 SMB_WRITE(sc, SMBSDAHD, 0);
203 SMB_WRITE(sc, SMBTAR, addr >> 1);
214 jzsmb_reset(device_t dev, u_char speed, u_char addr, u_char *oldaddr)
216 struct jzsmb_softc *sc;
219 sc = device_get_softc(dev);
222 error = jzsmb_reset_locked(dev, addr);
229 jzsmb_transfer_read(device_t dev, struct iic_msg *msg)
231 struct jzsmb_softc *sc;
232 struct timespec start, diff;
236 sc = device_get_softc(dev);
237 timeo = JZSMB_TIMEOUT * msg->len;
239 SMB_ASSERT_LOCKED(sc);
241 con = SMB_READ(sc, SMBCON);
242 con |= SMBCON_STPHLD;
243 SMB_WRITE(sc, SMBCON, con);
245 getnanouptime(&start);
246 for (resid = msg->len; resid > 0; resid--) {
247 for (int i = 0; i < min(resid, 8); i++)
248 SMB_WRITE(sc, SMBDC, SMBDC_CMD);
250 getnanouptime(&diff);
251 timespecsub(&diff, &start, &diff);
252 if ((SMB_READ(sc, SMBST) & SMBST_RFNE) != 0) {
253 msg->buf[msg->len - resid] =
254 SMB_READ(sc, SMBDC) & SMBDC_DAT;
259 if (tstohz(&diff) >= timeo) {
261 "read timeout (status=0x%02x)\n",
262 SMB_READ(sc, SMBST));
268 con = SMB_READ(sc, SMBCON);
269 con &= ~SMBCON_STPHLD;
270 SMB_WRITE(sc, SMBCON, con);
276 jzsmb_transfer_write(device_t dev, struct iic_msg *msg, int stop_hold)
278 struct jzsmb_softc *sc;
279 struct timespec start, diff;
283 sc = device_get_softc(dev);
284 timeo = JZSMB_TIMEOUT * msg->len;
286 SMB_ASSERT_LOCKED(sc);
288 con = SMB_READ(sc, SMBCON);
289 con |= SMBCON_STPHLD;
290 SMB_WRITE(sc, SMBCON, con);
292 getnanouptime(&start);
293 for (resid = msg->len; resid > 0; resid--) {
295 getnanouptime(&diff);
296 timespecsub(&diff, &start, &diff);
297 if ((SMB_READ(sc, SMBST) & SMBST_TFNF) != 0) {
299 msg->buf[msg->len - resid]);
302 DELAY((1000 * hz) / JZSMB_TIMEOUT);
304 if (tstohz(&diff) >= timeo) {
306 "write timeout (status=0x%02x)\n",
307 SMB_READ(sc, SMBST));
314 con = SMB_READ(sc, SMBCON);
315 con &= ~SMBCON_STPHLD;
316 SMB_WRITE(sc, SMBCON, con);
323 jzsmb_transfer(device_t dev, struct iic_msg *msgs, uint32_t nmsgs)
325 struct jzsmb_softc *sc;
330 sc = device_get_softc(dev);
334 mtx_sleep(sc, &sc->mtx, 0, "i2cbuswait", 0);
338 for (n = 0; n < nmsgs; n++) {
339 /* Set target address */
340 if (n == 0 || msgs[n].slave != msgs[n - 1].slave)
341 jzsmb_reset_locked(dev, msgs[n].slave);
343 /* Set read or write */
344 if ((msgs[n].flags & IIC_M_RD) != 0)
345 error = jzsmb_transfer_read(dev, &msgs[n]);
347 error = jzsmb_transfer_write(dev, &msgs[n],
355 /* Send stop if necessary */
356 con = SMB_READ(sc, SMBCON);
357 con &= ~SMBCON_STPHLD;
358 SMB_WRITE(sc, SMBCON, con);
372 jzsmb_probe(device_t dev)
374 if (!ofw_bus_status_okay(dev))
377 if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
380 device_set_desc(dev, "Ingenic JZ4780 SMB Controller");
382 return (BUS_PROBE_DEFAULT);
386 jzsmb_attach(device_t dev)
388 struct jzsmb_softc *sc;
392 sc = device_get_softc(dev);
393 node = ofw_bus_get_node(dev);
394 mtx_init(&sc->mtx, device_get_nameunit(dev), "jzsmb", MTX_DEF);
396 error = clk_get_by_ofw_index(dev, 0, 0, &sc->clk);
398 device_printf(dev, "cannot get clock\n");
401 error = clk_enable(sc->clk);
403 device_printf(dev, "cannot enable clock\n");
406 error = clk_get_freq(sc->clk, &sc->bus_freq);
407 if (error != 0 || sc->bus_freq == 0) {
408 device_printf(dev, "cannot get bus frequency\n");
412 if (bus_alloc_resources(dev, jzsmb_spec, &sc->res) != 0) {
413 device_printf(dev, "cannot allocate resources for device\n");
418 if (OF_getencprop(node, "clock-frequency", &sc->i2c_freq,
419 sizeof(sc->i2c_freq)) != 0 || sc->i2c_freq == 0)
420 sc->i2c_freq = 100000; /* Default to standard mode */
422 sc->iicbus = device_add_child(dev, "iicbus", -1);
423 if (sc->iicbus == NULL) {
424 device_printf(dev, "cannot add iicbus child device\n");
429 bus_generic_attach(dev);
434 bus_release_resources(dev, jzsmb_spec, &sc->res);
436 clk_release(sc->clk);
437 mtx_destroy(&sc->mtx);
441 static device_method_t jzsmb_methods[] = {
442 /* Device interface */
443 DEVMETHOD(device_probe, jzsmb_probe),
444 DEVMETHOD(device_attach, jzsmb_attach),
447 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
448 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
449 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
450 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
451 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
452 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
453 DEVMETHOD(bus_adjust_resource, bus_generic_adjust_resource),
454 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
455 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
458 DEVMETHOD(ofw_bus_get_node, jzsmb_get_node),
460 /* iicbus interface */
461 DEVMETHOD(iicbus_callback, iicbus_null_callback),
462 DEVMETHOD(iicbus_reset, jzsmb_reset),
463 DEVMETHOD(iicbus_transfer, jzsmb_transfer),
468 static driver_t jzsmb_driver = {
471 sizeof(struct jzsmb_softc),
474 static devclass_t jzsmb_devclass;
476 EARLY_DRIVER_MODULE(iicbus, jzsmb, iicbus_driver, iicbus_devclass, 0, 0,
477 BUS_PASS_RESOURCE + BUS_PASS_ORDER_MIDDLE);
478 EARLY_DRIVER_MODULE(jzsmb, simplebus, jzsmb_driver, jzsmb_devclass, 0, 0,
479 BUS_PASS_RESOURCE + BUS_PASS_ORDER_MIDDLE);
480 MODULE_VERSION(jzsmb, 1);