driver for the philips pca9554 i2c gpio device

4 files changed, 311 insertions, 3 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 3bbe6c4b1cc..52fdb2f7e82 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.320 2005/11/15 23:25:24 deraadt Exp $
+#	$OpenBSD: Makefile,v 1.321 2005/11/16 04:05:53 deraadt Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 adc.4 addcom.4 admtmp.4 adv.4 aha.4 ahb.4 ahc.4 \
 	ahd.4 aic.4 amdpm.4 ami.4 amphy.4 an.4 aps.4 aria.4 art.4 ast.4 \
@@ -22,7 +22,7 @@ MAN=	aac.4 ac97.4 acphy.4 adc.4 addcom.4 admtmp.4 adv.4 aha.4 ahb.4 ahc.4 \
 	mii.4 mpt.4 mpu.4 mtd.4 mtdphy.4 multicast.4 mtio.4 ne.4 neo.4 \
 	netintro.4 nge.4 noct.4 nofn.4 nsclpcsio.4 nsgphy.4 \
 	nsphy.4 nsphyter.4 null.4 ohci.4 opl.4 options.4 \
-	oosiop.4 osiop.4 pcdisplay.4 pchb.4 pci.4 pcib.4 pciide.4 pckbc.4 \
+	oosiop.4 osiop.4 pcagpio.4 pcdisplay.4 pchb.4 pci.4 pcib.4 pciide.4 pckbc.4 \
 	pckbd.4 pcmcia.4 pcn.4 pcppi.4 pcscp.4 pf.4 pflog.4 pfsync.4 piixpm.4 pim.4 \
 	pms.4 ppb.4 ppp.4 pppoe.4 pty.4 puc.4 qsphy.4 radio.4 raid.4 ral.4 \
 	random.4 ray.4 rd.4 re.4 rgephy.4 rl.4 rln.4 rlphy.4 route.4 rt.4 \
diff --git a/share/man/man4/pcagpio.4 b/share/man/man4/pcagpio.4
new file mode 100644
index 00000000000..63ff0e281a2
--- /dev/null
+++ b/share/man/man4/pcagpio.4
@@ -0,0 +1,47 @@
+.\"	$OpenBSD: pcagpio.4,v 1.1 2005/11/16 04:05:54 deraadt Exp $
+.\"
+.\" Copyright (c) 2005 Theo de Raadt <deraadt@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd May 16, 2004
+.Dt PCAGPIO 4
+.Os
+.Sh NAME
+.Nm pcagpio
+.Nd Philips PCA9554 gpio
+.Sh SYNOPSIS
+.Cd "pcagpio* at maciic?"
+.Cd "gpio* at pcagpio?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the Philips PCA9554
+.Xr gpio 4
+controller.
+The device has 8 pins which can be configured as either
+inputs or outputs, and accessed using
+.Xr gpioctl 8 .
+.\" Both values are made available through the
+.\" .Xr sysctl 8
+.\" interface.
+.Sh SEE ALSO
+.Xr iic 4 ,
+.Xr intro 4 ,
+.Xr gpioctl 8
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Theo de Raadt Aq deraadt@openbsd.org .
diff --git a/sys/dev/i2c/files.i2c b/sys/dev/i2c/files.i2c
index 6ddf7853197..8a4f6e3a944 100644
--- a/sys/dev/i2c/files.i2c
+++ b/sys/dev/i2c/files.i2c
@@ -1,4 +1,4 @@
-# $OpenBSD: files.i2c,v 1.11 2005/11/15 23:25:24 deraadt Exp $
+# $OpenBSD: files.i2c,v 1.12 2005/11/16 04:05:55 deraadt Exp $
 #	$NetBSD: files.i2c,v 1.3 2003/10/20 16:24:10 briggs Exp $
 
 define	i2c {[addr = -1], [size = -1]}
@@ -43,3 +43,8 @@ file	dev/i2c/tsl2560.c			tsl
 device	admtmp
 attach	admtmp at i2c
 file	dev/i2c/adm1030.c			admtmp
+
+# PCA9554
+device	pcagpio: gpiobus
+attach	pcagpio at i2c
+file	dev/i2c/pca9554.c			pcagpio
diff --git a/sys/dev/i2c/pca9554.c b/sys/dev/i2c/pca9554.c
new file mode 100644
index 00000000000..22cd953e7fe
--- /dev/null
+++ b/sys/dev/i2c/pca9554.c
@@ -0,0 +1,256 @@
+/*	$OpenBSD: pca9554.c,v 1.1 2005/11/16 04:05:55 deraadt Exp $	*/
+
+/*
+ * Copyright (c) 2005 Theo de Raadt
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/device.h>
+#include <sys/gpio.h>
+#include <sys/sensors.h>
+
+#include <dev/i2c/i2cvar.h>
+
+#include <dev/gpio/gpiovar.h>
+
+/* Maxim 6690 registers */
+#define PCA9554_IN		0x00
+#define PCA9554_OUT		0x01
+#define PCA9554_POLARITY	0x02
+#define PCA9554_CONFIG		0x03
+
+/* Sensors */
+#define GSCGPIO_NPINS	8
+
+struct pcagpio_softc {
+	struct device	sc_dev;
+	i2c_tag_t	sc_tag;
+	i2c_addr_t	sc_addr;
+	u_int8_t	sc_control;
+	u_int8_t	sc_polarity;
+
+	struct gpio_chipset_tag sc_gpio_gc;
+        gpio_pin_t sc_gpio_pins[GSCGPIO_NPINS];
+
+	struct sensor sc_sensor[GSCGPIO_NPINS];
+};
+
+int	pcagpio_match(struct device *, void *, void *);
+void	pcagpio_attach(struct device *, struct device *, void *);
+int	pcagpio_check(struct i2c_attach_args *, u_int8_t *, u_int8_t *);
+void	pcagpio_refresh(void *);
+
+int     pcagpio_gpio_pin_read(void *, int);
+void    pcagpio_gpio_pin_write(void *, int, int);
+void    pcagpio_gpio_pin_ctl(void *, int, int);
+
+struct cfattach pcagpio_ca = {
+	sizeof(struct pcagpio_softc), pcagpio_match, pcagpio_attach
+};
+
+struct cfdriver pcagpio_cd = {
+	NULL, "pcagpio", DV_DULL
+};
+
+int
+pcagpio_match(struct device *parent, void *match, void *aux)
+{
+	struct i2c_attach_args *ia = aux;
+
+	if (ia->ia_compat) {
+		if (strcmp(ia->ia_compat, "PCA9554") == 0 ||
+		    strcmp(ia->ia_compat, "PCA9554M") == 0)
+			return (1);
+		return (0);
+	}
+	return (1);
+}
+
+void
+pcagpio_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct pcagpio_softc *sc = (struct pcagpio_softc *)self;
+	struct i2c_attach_args *ia = aux;
+	struct gpiobus_attach_args gba;
+	u_int8_t cmd, data;
+	int outputs = 0, i;
+
+	sc->sc_tag = ia->ia_tag;
+	sc->sc_addr = ia->ia_addr;
+
+	cmd = PCA9554_CONFIG;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &data, sizeof data, 0)) {
+		printf(": failed to initialize\n");
+		return;
+	}
+	sc->sc_control = data;
+	cmd = PCA9554_POLARITY;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &data, sizeof data, 0)) {
+		printf(": failed to initialize\n");
+		return;
+	}
+	sc->sc_polarity = data;
+	cmd = PCA9554_OUT;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &data, sizeof data, 0)) {
+		printf(": failed to initialize\n");
+		return;
+	}
+
+	/* Initialize sensor data. */
+	for (i = 0; i < GSCGPIO_NPINS; i++)
+		strlcpy(sc->sc_sensor[i].device, sc->sc_dev.dv_xname,
+		    sizeof(sc->sc_sensor[i].device));
+
+	for (i = 0; i < GSCGPIO_NPINS; i++) {
+		sc->sc_sensor[i].type = SENSOR_INTEGER;
+		if ((sc->sc_control & (1 << i)) == 0) {
+			snprintf(sc->sc_sensor[i].desc,
+			    sizeof(sc->sc_sensor[i].desc), "out%d", i);
+			outputs++;
+		} else
+			snprintf(sc->sc_sensor[i].desc,
+			    sizeof(sc->sc_sensor[i].desc), "in%d", i);
+
+	}
+
+	if (sensor_task_register(sc, pcagpio_refresh, 5)) {
+		printf(", unable to register update task\n");
+		return;
+	}
+
+#if 0
+	for (i = 0; i < GSCGPIO_NPINS; i++)
+		SENSOR_ADD(&sc->sc_sensor[i]);
+#endif
+
+	printf(": %d inputs %d outputs\n", 8 - outputs, outputs);
+
+	for (i = 0; i < GSCGPIO_NPINS; i++) {
+		sc->sc_gpio_pins[i].pin_num = i;
+		sc->sc_gpio_pins[i].pin_caps = GPIO_PIN_INPUT | GPIO_PIN_OUTPUT;
+
+		if ((sc->sc_control & (1 << i)) == 0) {
+			sc->sc_gpio_pins[i].pin_flags = GPIO_PIN_OUTPUT;
+			sc->sc_gpio_pins[i].pin_state =
+			    data & (1 << i) ? GPIO_PIN_HIGH : GPIO_PIN_LOW;
+		}
+	}
+
+	/* Create controller tag */
+	sc->sc_gpio_gc.gp_cookie = sc;
+	sc->sc_gpio_gc.gp_pin_read = pcagpio_gpio_pin_read;
+	sc->sc_gpio_gc.gp_pin_write = pcagpio_gpio_pin_write;
+	sc->sc_gpio_gc.gp_pin_ctl = pcagpio_gpio_pin_ctl;
+
+	gba.gba_name = "gpio";
+	gba.gba_gc = &sc->sc_gpio_gc;
+	gba.gba_pins = sc->sc_gpio_pins;
+	gba.gba_npins = GSCGPIO_NPINS;
+
+	config_found(&sc->sc_dev, &gba, gpiobus_print);
+
+}
+
+void
+pcagpio_refresh(void *arg)
+{
+	struct pcagpio_softc *sc = arg;
+	u_int8_t cmd, in, out, bit;
+	int i;
+
+	iic_acquire_bus(sc->sc_tag, 0);
+
+	cmd = PCA9554_IN;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &in, sizeof in, 0))
+		goto invalid;
+
+	cmd = PCA9554_OUT;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &out, sizeof out, 0))
+		goto invalid;
+
+	for (i = 0; i < GSCGPIO_NPINS; i++) {
+		bit = 1 << i;
+		if ((sc->sc_control & bit))
+			sc->sc_sensor[i].value = (in & bit) ? 1 : 0;
+		else
+			sc->sc_sensor[i].value = (out & bit) ? 1 : 0;
+	}
+
+invalid:
+	iic_release_bus(sc->sc_tag, 0);
+}
+
+
+int
+pcagpio_gpio_pin_read(void *arg, int pin)
+{
+	struct pcagpio_softc *sc = arg;
+	u_int8_t cmd, in;
+
+	cmd = PCA9554_IN;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &in, sizeof in, 0))
+		return 0;
+	return (in & (1 << pin)) ? 1 : 0;
+}
+
+void
+pcagpio_gpio_pin_write(void *arg, int pin, int value)
+{
+	struct pcagpio_softc *sc = arg;
+	u_int8_t cmd, out, mask;
+
+	mask = 0xff ^ (1 << pin);
+	cmd = PCA9554_OUT;
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &out, sizeof out, 0))
+		return;
+	out = (out & mask) | (value << pin);
+
+	cmd = PCA9554_OUT;
+	if (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP,
+	    sc->sc_addr, &cmd, sizeof cmd, &out, sizeof out, 0))
+		return;
+}
+
+void
+pcagpio_gpio_pin_ctl(void *arg, int pin, int flags)
+{
+#if 0
+	struct pcagpio_softc *sc = arg;
+	u_int32_t conf;
+
+	pcagpio_gpio_pin_select(sc, pin);
+	conf = bus_space_read_4(sc->sc_gpio_iot, sc->sc_gpio_ioh,
+	    GSCGPIO_CONF);
+
+	conf &= ~(GSCGPIO_CONF_OUTPUTEN | GSCGPIO_CONF_PUSHPULL |
+	    GSCGPIO_CONF_PULLUP);
+	if ((flags & GPIO_PIN_TRISTATE) == 0)
+		conf |= GSCGPIO_CONF_OUTPUTEN;
+	if (flags & GPIO_PIN_PUSHPULL)
+		conf |= GSCGPIO_CONF_PUSHPULL;
+	if (flags & GPIO_PIN_PULLUP)
+		conf |= GSCGPIO_CONF_PULLUP;
+	bus_space_write_4(sc->sc_gpio_iot, sc->sc_gpio_ioh,
+	    GSCGPIO_CONF, conf);
+#endif
+}