2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Ben Gray <ben.r.gray@gmail.com>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 * Texas Instruments TWL4030/TWL5030/TWL60x0/TPS659x0 Power Management and
35 * Audio CODEC devices.
37 * This code is based on the Linux TWL multifunctional device driver, which is
38 * copyright (C) 2005-2006 Texas Instruments, Inc.
40 * These chips are typically used as support ICs for the OMAP range of embedded
41 * ARM processes/SOC from Texas Instruments. They are typically used to control
42 * on board voltages, however some variants have other features like audio
43 * codecs, USB OTG transceivers, RTC, PWM, etc.
45 * This driver acts as a bus for more specific companion devices.
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
53 #include <sys/module.h>
55 #include <sys/resource.h>
57 #include <sys/sysctl.h>
58 #include <sys/mutex.h>
59 #include <sys/malloc.h>
61 #include <machine/bus.h>
62 #include <machine/resource.h>
63 #include <machine/intr.h>
65 #include <dev/iicbus/iicbus.h>
66 #include <dev/iicbus/iiconf.h>
68 #include <dev/ofw/openfirm.h>
69 #include <dev/ofw/ofw_bus.h>
70 #include <dev/ofw/ofw_bus_subr.h>
72 #include "arm/ti/twl/twl.h"
75 #define TWL_DEVICE_UNKNOWN 0xffff
76 #define TWL_DEVICE_4030 0x4030
77 #define TWL_DEVICE_6025 0x6025
78 #define TWL_DEVICE_6030 0x6030
80 /* Each TWL device typically has more than one I2C address */
81 #define TWL_MAX_SUBADDRS 4
83 /* The maxium number of bytes that can be written in one call */
84 #define TWL_MAX_IIC_DATA_SIZE 63
86 /* The TWL devices typically use 4 I2C address for the different internal
87 * register sets, plus one SmartReflex I2C address.
89 #define TWL_CHIP_ID0 0x48
90 #define TWL_CHIP_ID1 0x49
91 #define TWL_CHIP_ID2 0x4A
92 #define TWL_CHIP_ID3 0x4B
94 #define TWL_SMARTREFLEX_CHIP_ID 0x12
96 #define TWL_INVALID_CHIP_ID 0xff
101 unsigned int sc_type;
103 uint8_t sc_subaddr_map[TWL_MAX_SUBADDRS];
105 struct intr_config_hook sc_scan_hook;
112 * Macros for driver mutex locking
114 #define TWL_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
115 #define TWL_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
116 #define TWL_LOCK_INIT(_sc) \
117 mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
119 #define TWL_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
120 #define TWL_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED);
121 #define TWL_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
125 * twl_is_4030 - returns true if the device is TWL4030
126 * twl_is_6025 - returns true if the device is TWL6025
127 * twl_is_6030 - returns true if the device is TWL6030
128 * @sc: device soft context
130 * Returns a non-zero value if the device matches.
133 * Returns a non-zero value if the device matches, otherwise zero.
136 twl_is_4030(device_t dev)
138 struct twl_softc *sc = device_get_softc(dev);
139 return (sc->sc_type == TWL_DEVICE_4030);
143 twl_is_6025(device_t dev)
145 struct twl_softc *sc = device_get_softc(dev);
146 return (sc->sc_type == TWL_DEVICE_6025);
150 twl_is_6030(device_t dev)
152 struct twl_softc *sc = device_get_softc(dev);
153 return (sc->sc_type == TWL_DEVICE_6030);
158 * twl_read - read one or more registers from the TWL device
159 * @sc: device soft context
160 * @nsub: the sub-module to read from
161 * @reg: the register offset within the module to read
162 * @buf: buffer to store the bytes in
163 * @cnt: the number of bytes to read
165 * Reads one or more registers and stores the result in the suppled buffer.
168 * Zero on success or an error code on failure.
171 twl_read(device_t dev, uint8_t nsub, uint8_t reg, uint8_t *buf, uint16_t cnt)
173 struct twl_softc *sc;
174 struct iic_msg msg[2];
178 sc = device_get_softc(dev);
181 addr = sc->sc_subaddr_map[nsub];
184 if (addr == TWL_INVALID_CHIP_ID)
188 /* Set the address to read from */
190 msg[0].flags = IIC_M_WR | IIC_M_NOSTOP;
193 /* Read the data back */
195 msg[1].flags = IIC_M_RD;
199 rc = iicbus_transfer(dev, msg, 2);
201 device_printf(dev, "iicbus read failed (adr:0x%02x, reg:0x%02x)\n",
210 * twl_write - writes one or more registers to the TWL device
211 * @sc: device soft context
212 * @nsub: the sub-module to read from
213 * @reg: the register offset within the module to read
214 * @buf: data to write
215 * @cnt: the number of bytes to write
217 * Writes one or more registers.
220 * Zero on success or a negative error code on failure.
223 twl_write(device_t dev, uint8_t nsub, uint8_t reg, uint8_t *buf, uint16_t cnt)
225 struct twl_softc *sc;
228 uint8_t tmp_buf[TWL_MAX_IIC_DATA_SIZE + 1];
231 if (cnt > TWL_MAX_IIC_DATA_SIZE)
234 /* Set the register address as the first byte */
236 memcpy(&tmp_buf[1], buf, cnt);
238 sc = device_get_softc(dev);
241 addr = sc->sc_subaddr_map[nsub];
244 if (addr == TWL_INVALID_CHIP_ID)
248 /* Setup the transfer and execute it */
250 msg.flags = IIC_M_WR;
254 rc = iicbus_transfer(dev, &msg, 1);
256 device_printf(sc->sc_dev, "iicbus write failed (adr:0x%02x, reg:0x%02x)\n",
265 * twl_test_present - checks if a device with given address is present
266 * @sc: device soft context
267 * @addr: the address of the device to scan for
269 * Sends just the address byte and checks for an ACK. If no ACK then device
270 * is assumed to not be present.
273 * EIO if device is not present, otherwise 0 is returned.
276 twl_test_present(struct twl_softc *sc, uint8_t addr)
281 /* Set the address to read from */
283 msg.flags = IIC_M_RD;
287 if (iicbus_transfer(sc->sc_dev, &msg, 1) != 0)
294 * twl_scan - scans the i2c bus for sub modules
295 * @dev: the twl device
297 * TWL devices don't just have one i2c slave address, rather they have up to
298 * 5 other addresses, each is for separate modules within the device. This
299 * function scans the bus for 4 possible sub-devices and stores the info
306 struct twl_softc *sc;
308 uint8_t devs[TWL_MAX_SUBADDRS];
309 uint8_t base = TWL_CHIP_ID0;
311 sc = device_get_softc((device_t)dev);
313 memset(devs, TWL_INVALID_CHIP_ID, TWL_MAX_SUBADDRS);
315 /* Try each of the addresses (0x48, 0x49, 0x4a & 0x4b) to determine which
316 * sub modules we have.
318 for (i = 0; i < TWL_MAX_SUBADDRS; i++) {
319 if (twl_test_present(sc, (base + i)) == 0) {
320 devs[i] = (base + i);
321 device_printf(sc->sc_dev, "Found (sub)device at 0x%02x\n", (base + i));
326 memcpy(sc->sc_subaddr_map, devs, TWL_MAX_SUBADDRS);
329 /* Finished with the interrupt hook */
330 config_intrhook_disestablish(&sc->sc_scan_hook);
335 * @dev: the twl device
337 * Scans the FDT for a match for the device, possible compatible device
338 * strings are; "ti,twl6030", "ti,twl6025", "ti,twl4030".
340 * The FDT compat string also determines the type of device (it is currently
341 * not possible to dynamically determine the device type).
345 twl_probe(device_t dev)
350 struct twl_softc *sc;
352 if ((compat = ofw_bus_get_compat(dev)) == NULL)
355 if ((node = ofw_bus_get_node(dev)) == 0)
358 /* Get total 'compatible' prop len */
359 if ((len = OF_getproplen(node, "compatible")) <= 0)
362 sc = device_get_softc(dev);
364 sc->sc_type = TWL_DEVICE_UNKNOWN;
367 if (strncasecmp(compat, "ti,twl6030", 10) == 0)
368 sc->sc_type = TWL_DEVICE_6030;
369 else if (strncasecmp(compat, "ti,twl6025", 10) == 0)
370 sc->sc_type = TWL_DEVICE_6025;
371 else if (strncasecmp(compat, "ti,twl4030", 10) == 0)
372 sc->sc_type = TWL_DEVICE_4030;
374 if (sc->sc_type != TWL_DEVICE_UNKNOWN)
377 /* Slide to the next sub-string. */
378 l = strlen(compat) + 1;
383 switch (sc->sc_type) {
384 case TWL_DEVICE_4030:
385 device_set_desc(dev, "TI TWL4030/TPS659x0 Companion IC");
387 case TWL_DEVICE_6025:
388 device_set_desc(dev, "TI TWL6025 Companion IC");
390 case TWL_DEVICE_6030:
391 device_set_desc(dev, "TI TWL6030 Companion IC");
393 case TWL_DEVICE_UNKNOWN:
402 twl_attach(device_t dev)
404 struct twl_softc *sc;
406 sc = device_get_softc(dev);
411 /* We have to wait until interrupts are enabled. I2C read and write
412 * only works if the interrupts are available.
414 sc->sc_scan_hook.ich_func = twl_scan;
415 sc->sc_scan_hook.ich_arg = dev;
417 if (config_intrhook_establish(&sc->sc_scan_hook) != 0)
420 /* FIXME: should be in DTS file */
421 if ((sc->sc_vreg = device_add_child(dev, "twl_vreg", -1)) == NULL)
422 device_printf(dev, "could not allocate twl_vreg instance\n");
423 if ((sc->sc_clks = device_add_child(dev, "twl_clks", -1)) == NULL)
424 device_printf(dev, "could not allocate twl_clks instance\n");
426 return (bus_generic_attach(dev));
430 twl_detach(device_t dev)
432 struct twl_softc *sc;
434 sc = device_get_softc(dev);
437 device_delete_child(dev, sc->sc_vreg);
439 device_delete_child(dev, sc->sc_clks);
442 TWL_LOCK_DESTROY(sc);
447 static device_method_t twl_methods[] = {
448 DEVMETHOD(device_probe, twl_probe),
449 DEVMETHOD(device_attach, twl_attach),
450 DEVMETHOD(device_detach, twl_detach),
455 static driver_t twl_driver = {
458 sizeof(struct twl_softc),
460 static devclass_t twl_devclass;
462 DRIVER_MODULE(twl, iicbus, twl_driver, twl_devclass, 0, 0);
463 MODULE_VERSION(twl, 1);