Home | History | Annotate | Line # | Download | only in i2c
max77620.c revision 1.2.2.2
      1  1.2.2.2  jdolecek /* $NetBSD: max77620.c,v 1.2.2.2 2017/12/03 11:37:02 jdolecek Exp $ */
      2  1.2.2.2  jdolecek 
      3  1.2.2.2  jdolecek /*-
      4  1.2.2.2  jdolecek  * Copyright (c) 2017 Jared McNeill <jmcneill (at) invisible.ca>
      5  1.2.2.2  jdolecek  * All rights reserved.
      6  1.2.2.2  jdolecek  *
      7  1.2.2.2  jdolecek  * Redistribution and use in source and binary forms, with or without
      8  1.2.2.2  jdolecek  * modification, are permitted provided that the following conditions
      9  1.2.2.2  jdolecek  * are met:
     10  1.2.2.2  jdolecek  * 1. Redistributions of source code must retain the above copyright
     11  1.2.2.2  jdolecek  *    notice, this list of conditions and the following disclaimer.
     12  1.2.2.2  jdolecek  * 2. Redistributions in binary form must reproduce the above copyright
     13  1.2.2.2  jdolecek  *    notice, this list of conditions and the following disclaimer in the
     14  1.2.2.2  jdolecek  *    documentation and/or other materials provided with the distribution.
     15  1.2.2.2  jdolecek  *
     16  1.2.2.2  jdolecek  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     17  1.2.2.2  jdolecek  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18  1.2.2.2  jdolecek  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  1.2.2.2  jdolecek  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     20  1.2.2.2  jdolecek  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     21  1.2.2.2  jdolecek  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     22  1.2.2.2  jdolecek  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     23  1.2.2.2  jdolecek  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     24  1.2.2.2  jdolecek  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     25  1.2.2.2  jdolecek  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     26  1.2.2.2  jdolecek  * POSSIBILITY OF SUCH DAMAGE.
     27  1.2.2.2  jdolecek  */
     28  1.2.2.2  jdolecek 
     29  1.2.2.2  jdolecek #include <sys/cdefs.h>
     30  1.2.2.2  jdolecek __KERNEL_RCSID(0, "$NetBSD: max77620.c,v 1.2.2.2 2017/12/03 11:37:02 jdolecek Exp $");
     31  1.2.2.2  jdolecek 
     32  1.2.2.2  jdolecek #include <sys/param.h>
     33  1.2.2.2  jdolecek #include <sys/systm.h>
     34  1.2.2.2  jdolecek #include <sys/kernel.h>
     35  1.2.2.2  jdolecek #include <sys/device.h>
     36  1.2.2.2  jdolecek #include <sys/conf.h>
     37  1.2.2.2  jdolecek #include <sys/bus.h>
     38  1.2.2.2  jdolecek #include <sys/kmem.h>
     39  1.2.2.2  jdolecek #include <sys/gpio.h>
     40  1.2.2.2  jdolecek 
     41  1.2.2.2  jdolecek #include <dev/i2c/i2cvar.h>
     42  1.2.2.2  jdolecek 
     43  1.2.2.2  jdolecek #include <dev/fdt/fdtvar.h>
     44  1.2.2.2  jdolecek 
     45  1.2.2.2  jdolecek #define	MAX_GPIO_REG(n)		(0x36 + (n))
     46  1.2.2.2  jdolecek #define	 MAX_GPIO_DEBOUNCE	__BITS(7,6)
     47  1.2.2.2  jdolecek #define	 MAX_GPIO_INT		__BITS(5,4)
     48  1.2.2.2  jdolecek #define	 MAX_GPIO_OUTPUT_VAL	__BIT(3)
     49  1.2.2.2  jdolecek #define	 MAX_GPIO_INPUT_VAL	__BIT(2)
     50  1.2.2.2  jdolecek #define	 MAX_GPIO_DIR		__BIT(1)
     51  1.2.2.2  jdolecek #define	 MAX_GPIO_DRV		__BIT(0)
     52  1.2.2.2  jdolecek 
     53  1.2.2.2  jdolecek #define	MAX_GPIO_COUNT		8
     54  1.2.2.2  jdolecek 
     55  1.2.2.2  jdolecek struct max77620_softc {
     56  1.2.2.2  jdolecek 	device_t	sc_dev;
     57  1.2.2.2  jdolecek 	i2c_tag_t	sc_i2c;
     58  1.2.2.2  jdolecek 	i2c_addr_t	sc_addr;
     59  1.2.2.2  jdolecek 	int		sc_phandle;
     60  1.2.2.2  jdolecek };
     61  1.2.2.2  jdolecek 
     62  1.2.2.2  jdolecek struct max77620_pin {
     63  1.2.2.2  jdolecek 	struct max77620_softc	*pin_sc;
     64  1.2.2.2  jdolecek 	int			pin_num;
     65  1.2.2.2  jdolecek 	int			pin_flags;
     66  1.2.2.2  jdolecek 	bool			pin_actlo;
     67  1.2.2.2  jdolecek };
     68  1.2.2.2  jdolecek 
     69  1.2.2.2  jdolecek static const char * max77620_compats[] = {
     70  1.2.2.2  jdolecek 	"maxim,max77620",
     71  1.2.2.2  jdolecek 	NULL
     72  1.2.2.2  jdolecek };
     73  1.2.2.2  jdolecek 
     74  1.2.2.2  jdolecek static uint8_t
     75  1.2.2.2  jdolecek max77620_read(struct max77620_softc *sc, uint8_t reg, int flags)
     76  1.2.2.2  jdolecek {
     77  1.2.2.2  jdolecek 	uint8_t val = 0;
     78  1.2.2.2  jdolecek 	int error;
     79  1.2.2.2  jdolecek 
     80  1.2.2.2  jdolecek 	error = iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP, sc->sc_addr,
     81  1.2.2.2  jdolecek 	    &reg, 1, &val, 1, flags);
     82  1.2.2.2  jdolecek 	if (error != 0)
     83  1.2.2.2  jdolecek 		aprint_error_dev(sc->sc_dev, "error reading reg %#x: %d\n", reg, error);
     84  1.2.2.2  jdolecek 
     85  1.2.2.2  jdolecek 	return val;
     86  1.2.2.2  jdolecek }
     87  1.2.2.2  jdolecek 
     88  1.2.2.2  jdolecek static void
     89  1.2.2.2  jdolecek max77620_write(struct max77620_softc *sc, uint8_t reg, uint8_t val, int flags)
     90  1.2.2.2  jdolecek {
     91  1.2.2.2  jdolecek 	int error;
     92  1.2.2.2  jdolecek 
     93  1.2.2.2  jdolecek 	error = iic_exec(sc->sc_i2c, I2C_OP_WRITE_WITH_STOP, sc->sc_addr,
     94  1.2.2.2  jdolecek 	    &reg, 1, &val, 1, flags);
     95  1.2.2.2  jdolecek 	if (error != 0)
     96  1.2.2.2  jdolecek 		aprint_error_dev(sc->sc_dev, "error writing reg %#x: %d\n", reg, error);
     97  1.2.2.2  jdolecek }
     98  1.2.2.2  jdolecek 
     99  1.2.2.2  jdolecek #define	I2C_READ(sc, reg)	max77620_read((sc), (reg), I2C_F_POLL)
    100  1.2.2.2  jdolecek #define	I2C_WRITE(sc, reg, val)	max77620_write((sc), (reg), (val), I2C_F_POLL)
    101  1.2.2.2  jdolecek #define	I2C_LOCK(sc)		iic_acquire_bus((sc)->sc_i2c, I2C_F_POLL)
    102  1.2.2.2  jdolecek #define	I2C_UNLOCK(sc)		iic_release_bus((sc)->sc_i2c, I2C_F_POLL)
    103  1.2.2.2  jdolecek 
    104  1.2.2.2  jdolecek static int
    105  1.2.2.2  jdolecek max77620_gpio_config(struct max77620_softc *sc, int pin, int flags)
    106  1.2.2.2  jdolecek {
    107  1.2.2.2  jdolecek 	uint32_t gpio;
    108  1.2.2.2  jdolecek 
    109  1.2.2.2  jdolecek 	KASSERT(pin >= 0 && pin < MAX_GPIO_COUNT);
    110  1.2.2.2  jdolecek 
    111  1.2.2.2  jdolecek 	gpio = I2C_READ(sc, MAX_GPIO_REG(pin));
    112  1.2.2.2  jdolecek 
    113  1.2.2.2  jdolecek 	switch (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
    114  1.2.2.2  jdolecek 	case GPIO_PIN_INPUT:
    115  1.2.2.2  jdolecek 		gpio |= MAX_GPIO_DIR;
    116  1.2.2.2  jdolecek 		break;
    117  1.2.2.2  jdolecek 	case GPIO_PIN_OUTPUT:
    118  1.2.2.2  jdolecek 		gpio &= ~MAX_GPIO_DIR;
    119  1.2.2.2  jdolecek 		break;
    120  1.2.2.2  jdolecek 	default:
    121  1.2.2.2  jdolecek 		return EINVAL;
    122  1.2.2.2  jdolecek 	}
    123  1.2.2.2  jdolecek 
    124  1.2.2.2  jdolecek 	switch (flags & (GPIO_PIN_PUSHPULL|GPIO_PIN_OPENDRAIN)) {
    125  1.2.2.2  jdolecek 	case GPIO_PIN_PUSHPULL:
    126  1.2.2.2  jdolecek 		gpio |= MAX_GPIO_DRV;
    127  1.2.2.2  jdolecek 		break;
    128  1.2.2.2  jdolecek 	case GPIO_PIN_OPENDRAIN:
    129  1.2.2.2  jdolecek 		gpio &= ~MAX_GPIO_DRV;
    130  1.2.2.2  jdolecek 		break;
    131  1.2.2.2  jdolecek 	default:
    132  1.2.2.2  jdolecek 		return EINVAL;
    133  1.2.2.2  jdolecek 	}
    134  1.2.2.2  jdolecek 
    135  1.2.2.2  jdolecek 	I2C_WRITE(sc, MAX_GPIO_REG(pin), gpio);
    136  1.2.2.2  jdolecek 
    137  1.2.2.2  jdolecek 	return 0;
    138  1.2.2.2  jdolecek }
    139  1.2.2.2  jdolecek 
    140  1.2.2.2  jdolecek static void *
    141  1.2.2.2  jdolecek max77620_gpio_acquire(device_t dev, const void *data, size_t len, int flags)
    142  1.2.2.2  jdolecek {
    143  1.2.2.2  jdolecek 	struct max77620_softc * const sc = device_private(dev);
    144  1.2.2.2  jdolecek 	struct max77620_pin *gpin;
    145  1.2.2.2  jdolecek 	const u_int *gpio = data;
    146  1.2.2.2  jdolecek 	int error;
    147  1.2.2.2  jdolecek 
    148  1.2.2.2  jdolecek 	if (len != 12)
    149  1.2.2.2  jdolecek 		return NULL;
    150  1.2.2.2  jdolecek 
    151  1.2.2.2  jdolecek 	const uint8_t pin = be32toh(gpio[1]) & 0xff;
    152  1.2.2.2  jdolecek 	const bool actlo = (be32toh(gpio[2]) & __BIT(0)) != 0;
    153  1.2.2.2  jdolecek 	const bool pushpull = (be32toh(gpio[2]) & __BIT(1)) == 0;
    154  1.2.2.2  jdolecek 	const bool opendrain = (be32toh(gpio[2]) & __BIT(2)) != 0;
    155  1.2.2.2  jdolecek 
    156  1.2.2.2  jdolecek 	if (pushpull)
    157  1.2.2.2  jdolecek 		flags |= GPIO_PIN_PUSHPULL;
    158  1.2.2.2  jdolecek 	if (opendrain)
    159  1.2.2.2  jdolecek 		flags |= GPIO_PIN_OPENDRAIN;
    160  1.2.2.2  jdolecek 
    161  1.2.2.2  jdolecek 	if (pin >= MAX_GPIO_COUNT)
    162  1.2.2.2  jdolecek 		return NULL;
    163  1.2.2.2  jdolecek 
    164  1.2.2.2  jdolecek 	I2C_LOCK(sc);
    165  1.2.2.2  jdolecek 	error = max77620_gpio_config(sc, pin, flags);
    166  1.2.2.2  jdolecek 	I2C_UNLOCK(sc);
    167  1.2.2.2  jdolecek 
    168  1.2.2.2  jdolecek 	if (error != 0) {
    169  1.2.2.2  jdolecek 		device_printf(dev, "bad pin %d config %#x\n", pin, flags);
    170  1.2.2.2  jdolecek 		return NULL;
    171  1.2.2.2  jdolecek 	}
    172  1.2.2.2  jdolecek 
    173  1.2.2.2  jdolecek 	gpin = kmem_zalloc(sizeof(*gpin), KM_SLEEP);
    174  1.2.2.2  jdolecek 	gpin->pin_sc = sc;
    175  1.2.2.2  jdolecek 	gpin->pin_num = pin;
    176  1.2.2.2  jdolecek 	gpin->pin_flags = flags;
    177  1.2.2.2  jdolecek 	gpin->pin_actlo = actlo;
    178  1.2.2.2  jdolecek 
    179  1.2.2.2  jdolecek 	return gpin;
    180  1.2.2.2  jdolecek }
    181  1.2.2.2  jdolecek 
    182  1.2.2.2  jdolecek static void
    183  1.2.2.2  jdolecek max77620_gpio_release(device_t dev, void *priv)
    184  1.2.2.2  jdolecek {
    185  1.2.2.2  jdolecek 	struct max77620_softc * const sc = device_private(dev);
    186  1.2.2.2  jdolecek 	struct max77620_pin *gpin = priv;
    187  1.2.2.2  jdolecek 
    188  1.2.2.2  jdolecek 	I2C_LOCK(sc);
    189  1.2.2.2  jdolecek 	max77620_gpio_config(sc, gpin->pin_num, GPIO_PIN_INPUT|GPIO_PIN_OPENDRAIN);
    190  1.2.2.2  jdolecek 	I2C_UNLOCK(sc);
    191  1.2.2.2  jdolecek 
    192  1.2.2.2  jdolecek 	kmem_free(gpin, sizeof(*gpin));
    193  1.2.2.2  jdolecek }
    194  1.2.2.2  jdolecek 
    195  1.2.2.2  jdolecek static int
    196  1.2.2.2  jdolecek max77620_gpio_read(device_t dev, void *priv, bool raw)
    197  1.2.2.2  jdolecek {
    198  1.2.2.2  jdolecek 	struct max77620_softc * const sc = device_private(dev);
    199  1.2.2.2  jdolecek 	struct max77620_pin *gpin = priv;
    200  1.2.2.2  jdolecek 	uint8_t gpio;
    201  1.2.2.2  jdolecek 	int val;
    202  1.2.2.2  jdolecek 
    203  1.2.2.2  jdolecek 	I2C_LOCK(sc);
    204  1.2.2.2  jdolecek 	gpio = I2C_READ(sc, MAX_GPIO_REG(gpin->pin_num));
    205  1.2.2.2  jdolecek 	I2C_UNLOCK(sc);
    206  1.2.2.2  jdolecek 
    207  1.2.2.2  jdolecek 	val = __SHIFTOUT(gpio, MAX_GPIO_INPUT_VAL);
    208  1.2.2.2  jdolecek 	if (!raw && gpin->pin_actlo)
    209  1.2.2.2  jdolecek 		val = !val;
    210  1.2.2.2  jdolecek 
    211  1.2.2.2  jdolecek #ifdef MAX77620_DEBUG
    212  1.2.2.2  jdolecek 	device_printf(sc->sc_dev, "GPIO%d rd %02x (%d %d)\n",
    213  1.2.2.2  jdolecek 	    gpin->pin_num, gpio,
    214  1.2.2.2  jdolecek 	    (int)__SHIFTOUT(gpio, MAX_GPIO_INPUT_VAL), val);
    215  1.2.2.2  jdolecek #endif
    216  1.2.2.2  jdolecek 
    217  1.2.2.2  jdolecek 	return val;
    218  1.2.2.2  jdolecek }
    219  1.2.2.2  jdolecek 
    220  1.2.2.2  jdolecek static void
    221  1.2.2.2  jdolecek max77620_gpio_write(device_t dev, void *priv, int val, bool raw)
    222  1.2.2.2  jdolecek {
    223  1.2.2.2  jdolecek 	struct max77620_softc * const sc = device_private(dev);
    224  1.2.2.2  jdolecek 	struct max77620_pin *gpin = priv;
    225  1.2.2.2  jdolecek 	uint8_t gpio;
    226  1.2.2.2  jdolecek 
    227  1.2.2.2  jdolecek 	if (!raw && gpin->pin_actlo)
    228  1.2.2.2  jdolecek 		val = !val;
    229  1.2.2.2  jdolecek 
    230  1.2.2.2  jdolecek 	I2C_LOCK(sc);
    231  1.2.2.2  jdolecek 	gpio = I2C_READ(sc, MAX_GPIO_REG(gpin->pin_num));
    232  1.2.2.2  jdolecek 	gpio &= ~MAX_GPIO_OUTPUT_VAL;
    233  1.2.2.2  jdolecek 	gpio |= __SHIFTIN(val, MAX_GPIO_OUTPUT_VAL);
    234  1.2.2.2  jdolecek #ifdef MAX77620_DEBUG
    235  1.2.2.2  jdolecek 	device_printf(sc->sc_dev, "GPIO%d wr %02x -> %02x\n",
    236  1.2.2.2  jdolecek 	    gpin->pin_num,
    237  1.2.2.2  jdolecek 	    I2C_READ(sc, MAX_GPIO_REG(gpin->pin_num)), gpio);
    238  1.2.2.2  jdolecek #endif
    239  1.2.2.2  jdolecek 	I2C_WRITE(sc, MAX_GPIO_REG(gpin->pin_num), gpio);
    240  1.2.2.2  jdolecek 	I2C_UNLOCK(sc);
    241  1.2.2.2  jdolecek }
    242  1.2.2.2  jdolecek 
    243  1.2.2.2  jdolecek static struct fdtbus_gpio_controller_func max77620_gpio_funcs = {
    244  1.2.2.2  jdolecek 	.acquire = max77620_gpio_acquire,
    245  1.2.2.2  jdolecek 	.release = max77620_gpio_release,
    246  1.2.2.2  jdolecek 	.read = max77620_gpio_read,
    247  1.2.2.2  jdolecek 	.write = max77620_gpio_write,
    248  1.2.2.2  jdolecek };
    249  1.2.2.2  jdolecek 
    250  1.2.2.2  jdolecek static void
    251  1.2.2.2  jdolecek max77620_gpio_attach(struct max77620_softc *sc)
    252  1.2.2.2  jdolecek {
    253  1.2.2.2  jdolecek 	fdtbus_register_gpio_controller(sc->sc_dev, sc->sc_phandle,
    254  1.2.2.2  jdolecek 	    &max77620_gpio_funcs);
    255  1.2.2.2  jdolecek }
    256  1.2.2.2  jdolecek 
    257  1.2.2.2  jdolecek static int
    258  1.2.2.2  jdolecek max77620_match(device_t parent, cfdata_t match, void *aux)
    259  1.2.2.2  jdolecek {
    260  1.2.2.2  jdolecek 	struct i2c_attach_args *ia = aux;
    261  1.2.2.2  jdolecek 
    262  1.2.2.2  jdolecek 	if (ia->ia_name == NULL)
    263  1.2.2.2  jdolecek 		return 0;
    264  1.2.2.2  jdolecek 
    265  1.2.2.2  jdolecek 	return iic_compat_match(ia, max77620_compats);
    266  1.2.2.2  jdolecek }
    267  1.2.2.2  jdolecek 
    268  1.2.2.2  jdolecek static void
    269  1.2.2.2  jdolecek max77620_attach(device_t parent, device_t self, void *aux)
    270  1.2.2.2  jdolecek {
    271  1.2.2.2  jdolecek 	struct max77620_softc * const sc = device_private(self);
    272  1.2.2.2  jdolecek 	struct i2c_attach_args *ia = aux;
    273  1.2.2.2  jdolecek 
    274  1.2.2.2  jdolecek 	sc->sc_dev = self;
    275  1.2.2.2  jdolecek 	sc->sc_i2c = ia->ia_tag;
    276  1.2.2.2  jdolecek 	sc->sc_addr = ia->ia_addr;
    277  1.2.2.2  jdolecek 	sc->sc_phandle = ia->ia_cookie;
    278  1.2.2.2  jdolecek 
    279  1.2.2.2  jdolecek 	aprint_naive("\n");
    280  1.2.2.2  jdolecek 	aprint_normal(": MAX77620 Power Management IC\n");
    281  1.2.2.2  jdolecek 
    282  1.2.2.2  jdolecek 	max77620_gpio_attach(sc);
    283  1.2.2.2  jdolecek }
    284  1.2.2.2  jdolecek 
    285  1.2.2.2  jdolecek CFATTACH_DECL_NEW(max77620pmic, sizeof(struct max77620_softc),
    286  1.2.2.2  jdolecek     max77620_match, max77620_attach, NULL, NULL);
    287