lmtemp(4) -- National Semiconductor LM75/LM77 temperature sensor driver.

Based on the driver from NetBSD (r) written by Jason R. Thorpe,
adapted for our sensors infrastructure and with LM77 support.

ok deraadt@

3 files changed, 406 insertions, 1 deletions

diff --git a/sys/dev/i2c/files.i2c b/sys/dev/i2c/files.i2c
index c53863d6ec2..48d81a83e8e 100644
--- a/sys/dev/i2c/files.i2c
+++ b/sys/dev/i2c/files.i2c
@@ -1,4 +1,4 @@
-# $OpenBSD: files.i2c,v 1.1 2004/05/23 17:33:43 grange Exp $
+# $OpenBSD: files.i2c,v 1.2 2004/05/23 18:12:37 grange Exp $
 #	$NetBSD: files.i2c,v 1.3 2003/10/20 16:24:10 briggs Exp $
 
 device	iic { addr, [size = -1] }
@@ -8,3 +8,8 @@ file	dev/i2c/i2c_exec.c			iic | i2cbus | i2cexec
 
 # Common module for bit-bang'ing an I2C bus
 file	dev/i2c/i2c_bitbang.c			i2c_bitbang
+
+# National Semiconductor LM75/LM77 temperature sensor
+device	lmtemp
+attach	lmtemp at iic
+file	dev/i2c/lm75.c				lmtemp
diff --git a/sys/dev/i2c/lm75.c b/sys/dev/i2c/lm75.c
new file mode 100644
index 00000000000..162247bdc60
--- /dev/null
+++ b/sys/dev/i2c/lm75.c
@@ -0,0 +1,220 @@
+/*	$OpenBSD: lm75.c,v 1.1 2004/05/23 18:12:37 grange Exp $	*/
+/*	$NetBSD: lm75.c,v 1.1 2003/09/30 00:35:31 thorpej Exp $	*/
+/*
+ * Copyright (c) 2004 Alexander Yurchenko <grange@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.
+ */
+
+/*
+ * Copyright (c) 2003 Wasabi Systems, Inc.
+ * All rights reserved.
+ *
+ * Written by Jason R. Thorpe for Wasabi Systems, Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *      This product includes software developed for the NetBSD Project by
+ *      Wasabi Systems, Inc.
+ * 4. The name of Wasabi Systems, Inc. may not be used to endorse
+ *    or promote products derived from this software without specific prior
+ *    written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*
+ * National Semiconductor LM75/LM77 temperature sensor.
+ */
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/device.h>
+#include <sys/kernel.h>
+#include <sys/sensors.h>
+#include <sys/timeout.h>
+
+#include <dev/i2c/i2cvar.h>
+#include <dev/i2c/lm75reg.h>
+
+struct lmtemp_softc {
+	struct device sc_dev;
+	i2c_tag_t sc_tag;
+	int sc_address;
+	int sc_model;
+
+	struct sensor sc_sensor;
+	struct timeout sc_timeout;
+};
+
+int  lmtemp_match(struct device *, void *, void *);
+void lmtemp_attach(struct device *, struct device *, void *);
+
+struct cfattach lmtemp_ca = {
+	sizeof(struct lmtemp_softc),
+	lmtemp_match,
+	lmtemp_attach
+};
+
+struct cfdriver lmtemp_cd = {
+	NULL, "lmtemp", DV_DULL
+};
+
+int  lmtemp_config_write(struct lmtemp_softc *, uint8_t);
+int  lmtemp_temp_read(struct lmtemp_softc *, uint8_t, int *);
+void lmtemp_refresh_sensor_data(void *);
+
+int
+lmtemp_match(struct device *parent, void *match, void *aux)
+{
+	struct i2c_attach_args *ia = aux;
+
+	/* XXX: we allow wider mask for LM77 */
+	if ((ia->ia_addr & LM75_ADDRMASK) == LM75_ADDR)
+		return (1);
+
+	return (0);
+}
+
+void
+lmtemp_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct lmtemp_softc *sc = (struct lmtemp_softc *)self;
+	struct i2c_attach_args *ia = aux;
+	u_int8_t ptr[1], reg[LM75_TEMP_LEN];
+
+	sc->sc_tag = ia->ia_tag;
+	sc->sc_address = ia->ia_addr;
+
+	/* Try to detect LM77 by poking Thigh register */
+	ptr[0] = LM77_REG_THIGH;
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	if (iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_address, ptr, 1, reg, LM75_TEMP_LEN, 0) == 0) {
+		/* Power up default is 64 degC */
+		if (lm77_wordtotemp((reg[0] << 8) | reg[1]) == 64 * 2) {
+			sc->sc_model = LM_MODEL_LM77;
+			printf(": LM77\n");
+		}
+	} else {
+		sc->sc_model = LM_MODEL_LM75;
+		printf(": LM75\n");
+	}
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	/* Set the configuration to defaults */
+	iic_acquire_bus(sc->sc_tag, I2C_F_POLL);
+	if (lmtemp_config_write(sc, 0) != 0) {
+		printf("%s: unable to write config register\n",
+		    sc->sc_dev.dv_xname);
+		iic_release_bus(sc->sc_tag, I2C_F_POLL);
+		return;
+	}
+	iic_release_bus(sc->sc_tag, I2C_F_POLL);
+
+	/* Initialize sensor data */
+	strlcpy(sc->sc_sensor.device, sc->sc_dev.dv_xname,
+	    sizeof(sc->sc_sensor.device));
+	sc->sc_sensor.type = SENSOR_TEMP;
+	strlcpy(sc->sc_sensor.desc, "TEMP", sizeof(sc->sc_sensor.desc));
+
+	/* Hook into the hw.sensors sysctl */
+	SENSOR_ADD(&sc->sc_sensor);
+
+	/* Set poll timer */
+	timeout_set(&sc->sc_timeout, lmtemp_refresh_sensor_data, sc);
+	timeout_add(&sc->sc_timeout, LM_POLLTIME);
+}
+
+int
+lmtemp_config_write(struct lmtemp_softc *sc, uint8_t val)
+{
+	uint8_t cmdbuf[2];
+
+	cmdbuf[0] = LM75_REG_CONFIG;
+	cmdbuf[1] = val;
+
+	return (iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP,
+	    sc->sc_address, cmdbuf, 1, &cmdbuf[1], 1, I2C_F_POLL));
+}
+
+int
+lmtemp_temp_read(struct lmtemp_softc *sc, uint8_t which, int *valp)
+{
+	u_int8_t cmdbuf[1];
+	u_int8_t buf[LM75_TEMP_LEN];
+	int error;
+
+	cmdbuf[0] = which;
+
+	error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
+	    sc->sc_address, cmdbuf, 1, buf, LM75_TEMP_LEN, 0);
+	if (error)
+		return (error);
+
+	switch (sc->sc_model) {
+	case LM_MODEL_LM75:
+		*valp = lm75_wordtotemp((buf[0] << 8) | buf[1]);
+		break;
+	case LM_MODEL_LM77:
+		*valp = lm77_wordtotemp((buf[0] << 8) | buf[1]);
+		break;
+	default:
+		printf("%s: unknown model (%d)\n",
+		    sc->sc_dev.dv_xname, sc->sc_model);
+		return (1);
+	}
+
+	return (0);
+}
+
+void
+lmtemp_refresh_sensor_data(void *aux)
+{
+	struct lmtemp_softc *sc = aux;
+	int val;
+	int error;
+
+	error = lmtemp_temp_read(sc, LM75_REG_TEMP, &val);
+	if (error) {
+#if 0
+		printf("%s: unable to read temperature, error = %d\n",
+		    sc->sc_dev.dv_xname, error);
+#endif
+		sc->sc_sensor.flags |= SENSOR_FINVALID;
+		return;
+	}
+
+	sc->sc_sensor.value = val * 500000 + 273150000;
+	sc->sc_sensor.flags &= ~SENSOR_FINVALID;
+
+	timeout_add(&sc->sc_timeout, LM_POLLTIME);
+}
diff --git a/sys/dev/i2c/lm75reg.h b/sys/dev/i2c/lm75reg.h
new file mode 100644
index 00000000000..892b8b56791
--- /dev/null
+++ b/sys/dev/i2c/lm75reg.h
@@ -0,0 +1,180 @@
+/*	$OpenBSD: lm75reg.h,v 1.1 2004/05/23 18:12:37 grange Exp $	*/
+/*	$NetBSD: lm75reg.h,v 1.1 2003/09/30 00:35:31 thorpej Exp $	*/
+/*
+ * Copyright (c) 2004 Alexander Yurchenko <grange@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.
+ */
+
+/*
+ * Copyright (c) 2003 Wasabi Systems, Inc.
+ * All rights reserved.
+ *
+ * Written by Jason R. Thorpe for Wasabi Systems, Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *      This product includes software developed for the NetBSD Project by
+ *      Wasabi Systems, Inc.
+ * 4. The name of Wasabi Systems, Inc. may not be used to endorse
+ *    or promote products derived from this software without specific prior
+ *    written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef _DEV_I2C_LM75REG_H_
+#define _DEV_I2C_LM75REG_H_
+
+#define	LM_MODEL_LM75	1
+#define	LM_MODEL_LM77	2
+
+#define LM_POLLTIME	(hz * 2)	/* 2s */
+
+/*
+ * LM75 temperature sensor I2C address:
+ *
+ *	100 1xxx
+ */
+#define	LM75_ADDRMASK		0x78
+#define	LM75_ADDR		0x48
+
+/*
+ * LM77 temperature sensor I2C address:
+ *
+ *	100 10xx
+ */
+#define	LM77_ADDRMASK		0x7c
+#define	LM77_ADDR		0x48
+
+/*
+ * Temperature on the LM75 is represented by a 9-bit two's complement
+ * integer in steps of 0.5C.  The following examples are taken from
+ * the LM75 data sheet:
+ *
+ *	+125C	0 1111 1010	0x0fa
+ *	+25C	0 0011 0010	0x032
+ *	+0.5C	0 0000 0001	0x001
+ *	0C	0 0000 0000	0x000
+ *	-0.5C	1 1111 1111	0x1ff
+ *	-25C	1 1100 1110	0x1ce
+ *	-55C	1 1001 0010	0x192
+ *
+ * Temperature on the LM77 is represented by a 10-bit two's complement
+ * integer in steps of 0.5C:
+ *
+ *	+130C	01 0000 0100	0x104
+ *	+125C	00 1111 1010	0x0fa
+ *	+25C	00 0011 0010	0x032
+ *	+0.5C	00 0000 0001	0x001
+ *	0C	00 0000 0000	0x000
+ *	-0.5C	11 1111 1111	0x3ff
+ *	-25C	11 1100 1110	0x3ce
+ *	-55C	11 1001 0010	0x392
+ */
+
+#define	LM75_REG_TEMP			0x00
+#define	LM75_REG_CONFIG			0x01
+#define	LM75_REG_THYST_SET_POINT	0x02
+#define	LM75_REG_TOS_SET_POINT		0x03
+
+#define	LM77_REG_TLOW			0x04
+#define	LM77_REG_THIGH			0x05
+
+#define	LM77_TEMP_ST_LOW		0x01
+#define	LM77_TEMP_ST_HIGH		0x02
+#define	LM77_TEMP_ST_CRIT		0x04
+
+#define	LM75_TEMP_LEN			2	/* 2 data bytes */
+
+#define	LM75_CONFIG_SHUTDOWN		0x01
+#define	LM75_CONFIG_CMPINT		0x02
+#define	LM75_CONFIG_OSPOLARITY		0x04
+#define	LM75_CONFIG_FAULT_QUEUE_1	(0 << 3)
+#define	LM75_CONFIG_FAULT_QUEUE_2	(1 << 3)
+#define	LM75_CONFIG_FAULT_QUEUE_4	(2 << 3)
+#define	LM75_CONFIG_FAULT_QUEUE_6	(3 << 3)
+
+#define	LM77_CONFIG_INTPOLARITY		0x08
+#define	LM77_CONFIG_FAULT_QUEUE_4	0x10
+
+/*
+ * LM75 temperature word:
+ *
+ * MSB Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0 X X X X X X X
+ * 15  14   13   12   11   10   9    8    7    6 5 4 3 2 1 0
+ *
+ *
+ * LM77 temperature word:
+ *
+ * Sign Sign Sign Sign MSB Bit7 Bit6 Bit5 Bit4 Bit3 Bit2 Bit1 Bit0 Status bits
+ * 15   14   13   12   11  10   9    8    7    6    5    4    3    2 1 0
+ */
+
+static __inline int
+lm75_wordtotemp(u_int16_t word)
+{
+	return ((int16_t)word / 128);
+}
+
+static __inline u_int16_t
+lm75_temptoword(int temp)
+{
+	int sign = 0;
+
+	if (temp < 0) {
+		sign = 1;
+		temp = -temp;
+	};
+
+	return ((sign << 15 ) | ((temp & 0xff) << 7));
+}
+
+static __inline int
+lm77_wordtotemp(u_int16_t word)
+{
+	return ((int16_t)word / 8);
+}
+
+static __inline u_int16_t
+lm77_temptoword(int temp)
+{
+	int sign = 0;
+
+	if (temp < 0) {
+		sign = 0xf;
+		temp = -temp;
+	};
+
+	return ((sign << 12 ) | ((temp & 0x1ff) << 3));
+}
+
+#endif /* _DEV_I2C_LM75REG_H_ */