Driver for Acer Labs M7101 power management controller

2 files changed, 342 insertions, 1 deletions

diff --git a/sys/dev/pci/alipm.c b/sys/dev/pci/alipm.c
new file mode 100644
index 00000000000..b4457e05122
--- /dev/null
+++ b/sys/dev/pci/alipm.c
@@ -0,0 +1,336 @@
+/*	$OpenBSD: alipm.c,v 1.1 2005/12/24 23:36:36 kettenis Exp $	*/
+
+/*
+ * Copyright (c) 2005 Mark Kettenis
+ *
+ * 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/device.h>
+#include <sys/kernel.h>
+#include <sys/lock.h>
+#include <sys/proc.h>
+#include <sys/systm.h>
+
+#include <dev/i2c/i2cvar.h>
+
+#include <dev/pci/pcidevs.h>
+#include <dev/pci/pcireg.h>
+#include <dev/pci/pcivar.h>
+
+/*
+ * Acer Labs M7101 Power register definitions.
+ */
+
+/* PCI configuration registers. */
+#define ALIPM_CONF	0xd0		/* general configuration */
+#define ALIPM_CONF_SMBEN	0x0400		/* emanble SMBus */
+#define ALIPM_BASE	0xe0		/* ACPI and SMBus base address */
+#define ALIPM_SMB_HOSTC	0xf0		/* host configuration */
+#define ALIPM_SMB_HOSTC_HSTEN	0x00000001	/* enable host controller */
+#define ALIPM_SMB_HOSTC_CLOCK	0x00e00000	/* clock speed */
+#define ALIPM_SMB_HOSTC_149K	0x00000000	/* 149 KHz clock */
+#define ALIPM_SMB_HOSTC_74K	0x00200000	/*  74 KHz clock */
+#define ALIPM_SMB_HOSTC_37K	0x00400000	/*  37 KHz clock */
+#define ALIPM_SMB_HOSTC_223K	0x00800000	/* 223 KHz clock */
+#define ALIPM_SMB_HOSTC_111K	0x00a00000	/* 111 KHz clock */
+#define ALIPM_SMB_HOSTC_55K	0x00c00000	/*  55 KHz clock */
+
+#define ALIPM_SMB_SIZE		32	/* SMBus I/O space size */
+
+/* SMBus I/O registers */
+#define ALIPM_SMB_HS	0x00		/* host status */
+#define ALIPM_SMB_HS_IDLE	0x04
+#define ALIPM_SMB_HS_BUSY	0x08	/* running a command */
+#define ALIPM_SMB_HS_DONE	0x10	/* command completed */
+#define ALIPM_SMB_HS_DEVERR	0x20	/* command error */
+#define ALIPM_SMB_HS_BUSERR	0x40	/* transaction collision */
+#define ALIPM_SMB_HS_FAILED	0x80	/* failed bus transaction */
+#define ALIPM_SMB_HS_BITS \
+  "\020\003IDLE\004BUSY\005DONE\006DEVERR\007BUSERR\010FAILED"
+#define ALIPM_SMB_HC	0x01		/* host control */
+#define ALIPM_SMB_HC_KILL	0x04		/* kill command */
+#define ALIPM_SMB_HC_RESET	0x08		/* reset bus */
+#define ALIPM_SMB_HC_CMD_QUICK	0x00		/* QUICK command */
+#define ALIPM_SMB_HC_CMD_BYTE	0x10		/* BYTE command */
+#define ALIPM_SMB_HC_CMD_BDATA	0x20		/* BYTE DATA command */
+#define ALIPM_SMB_HC_CMD_WDATA	0x30		/* WORD DATA command */
+#define ALIPM_SMB_HC_CMD_BLOCK 0x40		/* BLOCK command */
+#define ALIPM_SMB_START		0x02	/* start command */
+#define ALIPM_SMB_TXSLVA	0x03	/* transmit slave address */
+#define ALIPM_SMB_TXSLVA_READ	(1 << 0)	/* read direction */
+#define ALIPM_SMB_TXSLVA_ADDR(x) (((x) & 0x7f) << 1) /* 7-bit address */
+#define ALIPM_SMB_HD0		0x04	/* host data 0 */
+#define ALIPM_SMB_HD1		0x05	/* host data 1 */
+#define ALIPM_SMB_HBDB		0x06	/* host block data byte */
+#define ALIPM_SMB_HCMD		0x07	/* host command */
+
+#ifdef ALIPM_DEBUG
+#define DPRINTF(x) printf x
+#else
+#define DPRINTF(x)
+#endif
+
+#define ALIPM_DELAY	100
+#define ALIPM_TIMEOUT	1
+
+struct alipm_softc {
+	struct device sc_dev;
+
+	bus_space_tag_t sc_iot;
+	bus_space_handle_t sc_ioh;
+
+	struct i2c_controller sc_smb_tag;
+	struct lock sc_smb_lock;
+};
+
+int	alipm_match(struct device *, void *, void *);
+void	alipm_attach(struct device *, struct device *, void *);
+
+int	alipm_smb_acquire_bus(void *, int);
+void	alipm_smb_release_bus(void *, int);
+int	alipm_smb_exec(void *, i2c_op_t, i2c_addr_t, const void *,
+	    size_t, void *, size_t, int);
+
+struct cfattach alipm_ca = {
+	sizeof(struct alipm_softc),
+	alipm_match,
+	alipm_attach
+};
+
+struct cfdriver alipm_cd = {
+	NULL, "alipm", DV_DULL
+};
+
+int
+alipm_match(struct device *parent, void *match, void *aux)
+{
+	struct pci_attach_args *pa = aux;
+
+	if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_ALI &&
+	    (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_ALI_M7101))
+		return (1);
+	return (0);
+}
+
+void
+alipm_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct alipm_softc *sc = (struct alipm_softc *) self;
+	struct pci_attach_args *pa = aux;
+	struct i2cbus_attach_args iba;
+	pcireg_t iobase;
+	pcireg_t reg;
+
+	/* Map I/O space */
+	iobase = pci_conf_read(pa->pa_pc, pa->pa_tag, ALIPM_BASE) >> 16;
+	sc->sc_iot = pa->pa_iot;
+	if (bus_space_map(sc->sc_iot, iobase,
+	    ALIPM_SMB_SIZE, 0, &sc->sc_ioh)) {
+		printf(": can't map I/O space\n");
+		return;
+	}
+
+	reg = pci_conf_read(pa->pa_pc, pa->pa_tag, ALIPM_CONF);
+	if ((reg & ALIPM_CONF_SMBEN) == 0) {
+		printf(": SMBus disabled\n");
+		return;
+	}
+
+	reg = pci_conf_read(pa->pa_pc, pa->pa_tag, ALIPM_SMB_HOSTC);
+	if ((reg & ALIPM_SMB_HOSTC_HSTEN) == 0) {
+		printf(": SMBus host disabled\n");
+		return;
+	}
+
+	switch (reg & ALIPM_SMB_HOSTC_CLOCK) {
+	case ALIPM_SMB_HOSTC_149K:
+		printf(": 149KHz clock");
+		break;
+	case ALIPM_SMB_HOSTC_74K:
+		printf(": 74KHz clock");
+		break;
+	case ALIPM_SMB_HOSTC_37K:
+		printf(": 37KHz clock");
+		break;
+	case ALIPM_SMB_HOSTC_223K:
+		printf(": 223KHz clock");
+		break;
+	case ALIPM_SMB_HOSTC_111K:
+		printf(": 111KHz clock");
+		break;
+	case ALIPM_SMB_HOSTC_55K:
+		printf(": 55KHz clock");
+		break;
+	default:
+		printf(" unknown clock speed");
+		break;
+	}
+
+	printf("\n");
+
+	/* Attach I2C bus */
+	lockinit(&sc->sc_smb_lock, PRIBIO | PCATCH, "alipm", 0, 0);
+	sc->sc_smb_tag.ic_cookie = sc;
+	sc->sc_smb_tag.ic_acquire_bus = alipm_smb_acquire_bus;
+	sc->sc_smb_tag.ic_release_bus = alipm_smb_release_bus;
+	sc->sc_smb_tag.ic_exec = alipm_smb_exec;
+	iba.iba_name = "iic";
+	iba.iba_tag = &sc->sc_smb_tag;
+	iba.iba_scan = 1;
+	config_found(&sc->sc_dev, &iba, iicbus_print);
+}
+
+int
+alipm_smb_acquire_bus(void *cookie, int flags)
+{
+	struct alipm_softc *sc = cookie;
+
+	if (flags & I2C_F_POLL)
+		return (0);
+
+	return (lockmgr(&sc->sc_smb_lock, LK_EXCLUSIVE, NULL));
+}
+
+void
+alipm_smb_release_bus(void *cookie, int flags)
+{
+	struct alipm_softc *sc = cookie;
+
+	if (flags & I2C_F_POLL)
+		return;
+
+	lockmgr(&sc->sc_smb_lock, LK_RELEASE, NULL);
+}
+
+int
+alipm_smb_exec(void *cookie, i2c_op_t op, i2c_addr_t addr,
+    const void *cmdbuf, size_t cmdlen, void *buf, size_t len, int flags)
+{
+	struct alipm_softc *sc = cookie;
+	u_int8_t *b;
+	u_int8_t ctl, st;
+	int retries, error = 0;
+
+	DPRINTF(("%s: exec op %d, addr 0x%x, cmdlen %d, len %d, "
+	    "flags 0x%x\n", sc->sc_dev.dv_xname, op, addr, cmdlen,
+	    len, flags));
+
+	if (!I2C_OP_STOP_P(op) || cmdlen > 1 || len > 2)
+		return (EOPNOTSUPP);
+
+	/* Clear status bits */
+	bus_space_write_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HS,
+	    ALIPM_SMB_HS_DONE | ALIPM_SMB_HS_FAILED |
+	    ALIPM_SMB_HS_BUSERR | ALIPM_SMB_HS_DEVERR);
+
+	/* Wait until bus is idle */
+	for (retries = 1000; retries > 0; retries--) {
+		st = bus_space_read_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HS);
+		if (st & (ALIPM_SMB_HS_IDLE | ALIPM_SMB_HS_FAILED |
+		    ALIPM_SMB_HS_BUSERR | ALIPM_SMB_HS_DEVERR))
+			break;
+		DELAY(ALIPM_DELAY);
+	}
+	if (retries == 0) {
+		printf("%s: timeout waiting until bus is idle\n",
+		    sc->sc_dev.dv_xname);
+		return (ETIMEDOUT);
+	}
+	if (st & (ALIPM_SMB_HS_FAILED |
+	    ALIPM_SMB_HS_BUSERR | ALIPM_SMB_HS_DEVERR)) {
+		printf("%s: bus error 0x%b\n", sc->sc_dev.dv_xname,
+		    st, ALIPM_SMB_HS_BITS);
+		return (EIO);
+	}
+
+	/* Set slave address and transfer direction. */
+	bus_space_write_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_TXSLVA,
+	    ALIPM_SMB_TXSLVA_ADDR(addr) |
+	    (I2C_OP_READ_P(op) ? ALIPM_SMB_TXSLVA_READ : 0));
+
+	b = (void *)cmdbuf;
+	if (cmdlen > 0)
+		/* Set command byte */
+		bus_space_write_1(sc->sc_iot, sc->sc_ioh,
+		     ALIPM_SMB_HCMD, b[0]);
+
+	if (I2C_OP_WRITE_P(op)) {
+		/* Write data. */
+		b = buf;
+		if (len > 0)
+			bus_space_write_1(sc->sc_iot, sc->sc_ioh,
+			    ALIPM_SMB_HD0, b[0]);
+		if (len > 1)
+			bus_space_write_1(sc->sc_iot, sc->sc_ioh,
+			    ALIPM_SMB_HD1, b[1]);
+	}
+
+	/* Set SMBus command */
+	if (len == 0)
+		ctl = ALIPM_SMB_HC_CMD_BYTE;
+	else if (len == 1)
+		ctl = ALIPM_SMB_HC_CMD_BDATA;
+	else if (len == 2)
+		ctl = ALIPM_SMB_HC_CMD_WDATA;
+	bus_space_write_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HC, ctl);
+
+	/* Start transaction */
+	bus_space_write_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_START, 0xff);
+
+	/* Poll for completion */
+	DELAY(ALIPM_DELAY);
+	for (retries = 1000; retries > 0; retries--) {
+		st = bus_space_read_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HS);
+		if (st & (ALIPM_SMB_HS_IDLE | ALIPM_SMB_HS_FAILED |
+		    ALIPM_SMB_HS_BUSERR | ALIPM_SMB_HS_DEVERR))
+			break;
+		DELAY(ALIPM_DELAY);
+	}
+	if (retries == 0) {
+		printf("%s: timeout\n", sc->sc_dev.dv_xname);
+		error = ETIMEDOUT;
+		goto done;
+	}
+
+	if ((st & ALIPM_SMB_HS_DONE) == 0) {
+		bus_space_write_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HC,
+		     ALIPM_SMB_HC_KILL);
+		st = bus_space_read_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HS);
+	}
+
+	/* Check for errors */
+	if (st & (ALIPM_SMB_HS_FAILED |
+	    ALIPM_SMB_HS_BUSERR | ALIPM_SMB_HS_DEVERR)) {
+		error = EIO;
+		goto done;
+	}
+
+	if (I2C_OP_READ_P(op)) {
+		/* Read data */
+		b = buf;
+		if (len > 0)
+			b[0] = bus_space_read_1(sc->sc_iot, sc->sc_ioh,
+			    ALIPM_SMB_HD0);
+		if (len > 1)
+			b[1] = bus_space_read_1(sc->sc_iot, sc->sc_ioh,
+			    ALIPM_SMB_HD1);
+	}
+
+done:
+	/* Clear status bits */
+	bus_space_write_1(sc->sc_iot, sc->sc_ioh, ALIPM_SMB_HS, st);
+
+	return (error);
+}
diff --git a/sys/dev/pci/files.pci b/sys/dev/pci/files.pci
index b7bff165576..6959fc73a05 100644
--- a/sys/dev/pci/files.pci
+++ b/sys/dev/pci/files.pci
@@ -1,4 +1,4 @@
-#	$OpenBSD: files.pci,v 1.193 2005/12/24 21:21:56 grange Exp $
+#	$OpenBSD: files.pci,v 1.194 2005/12/24 23:36:36 kettenis Exp $
 #	$NetBSD: files.pci,v 1.20 1996/09/24 17:47:15 christos Exp $
 #
 # Config file and device description for machine-independent PCI code.
@@ -573,3 +573,8 @@ file	dev/pci/bt8370.c		art
 device	ichiic: i2cbus
 attach	ichiic at pci
 file	dev/pci/ichiic.c		ichiic
+
+# Acer Labs M7101 power management controller
+device	alipm: i2cbus
+attach	alipm at pci
+file	dev/pci/alipm.c			alipm