Home | History | Annotate | Line # | Download | only in i2c
      1 /* $NetBSD: dstemp.c,v 1.15 2025/09/21 13:54:56 thorpej Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2018 Michael Lorenz
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  *
     16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     26  * POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #include <sys/cdefs.h>
     30 __KERNEL_RCSID(0, "$NetBSD: dstemp.c,v 1.15 2025/09/21 13:54:56 thorpej Exp $");
     31 
     32 #include <sys/param.h>
     33 #include <sys/systm.h>
     34 #include <sys/device.h>
     35 #include <sys/conf.h>
     36 #include <sys/bus.h>
     37 
     38 #include <dev/i2c/i2cvar.h>
     39 
     40 #include <dev/sysmon/sysmonvar.h>
     41 
     42 #define DSTEMP_CMD_START	0x51	/* command, no data */
     43 #define DSTEMP_CMD_POR		0x54	/* command, no data */
     44 #define DSTEMP_CMD_STOP		0x22	/* command, no data */
     45 #define DSTEMP_TCURRENT		0xaa	/* current temperature, 2 bytes */
     46 #define DSTEMP_THIGH		0xa1	/* high threshold, 2 bytes */
     47 #define DSTEMP_TLOW		0xa2	/* low threshold, 2 bytes */
     48 #define DSTEMP_CONFIG		0xac	/* 1 byte */
     49 
     50 #define DSTEMP_1SHOT		0x01
     51 #define DSTEMP_POL		0x02	/* Tout polarity, 1 - active high */
     52 #define DSTEMP_8BIT		0x00
     53 #define DSTEMP_10BIT		0x04
     54 #define DSTEMP_11BIT		0x08
     55 #define DSTEMP_12BIT		0x0c
     56 #define DSTEMP_RES_MASK		0x0c
     57 #define DSTEMP_NVB		0x10	/* EEPROM busy */
     58 #define DSTEMP_TLF		0x20	/* temperature low flag */
     59 #define DSTEMP_THF		0x40	/* temperature high flag */
     60 #define DSTEMP_DONE		0x80
     61 
     62 struct dstemp_softc {
     63 	device_t		sc_dev;
     64 	i2c_tag_t		sc_i2c;
     65 	i2c_addr_t		sc_addr;
     66 	struct sysmon_envsys 	*sc_sme;
     67 	envsys_data_t		sc_sensor_temp;
     68 };
     69 
     70 static int	dstemp_match(device_t, cfdata_t, void *);
     71 static void	dstemp_attach(device_t, device_t, void *);
     72 
     73 static void	dstemp_sensors_refresh(struct sysmon_envsys *, envsys_data_t *);
     74 static void	dstemp_init(struct dstemp_softc *);
     75 
     76 CFATTACH_DECL_NEW(dstemp, sizeof(struct dstemp_softc),
     77     dstemp_match, dstemp_attach, NULL, NULL);
     78 
     79 static const struct device_compatible_entry compat_data[] = {
     80 	{ .compat = "dallas,ds1631" },
     81 	{ .compat = "ds1631" },
     82 	DEVICE_COMPAT_EOL
     83 };
     84 
     85 static int
     86 dstemp_match(device_t parent, cfdata_t match, void *aux)
     87 {
     88 	struct i2c_attach_args *ia = aux;
     89 	int match_result;
     90 
     91 	if (iic_use_direct_match(ia, match, compat_data, &match_result))
     92 		return match_result;
     93 
     94 	if ((ia->ia_addr & 0xf8) == 0x48)
     95 		return I2C_MATCH_ADDRESS_ONLY;
     96 
     97 	return 0;
     98 }
     99 
    100 static void
    101 dstemp_attach(device_t parent, device_t self, void *aux)
    102 {
    103 	struct dstemp_softc *sc = device_private(self);
    104 	struct i2c_attach_args *ia = aux;
    105 	char name[64] = "temperature";
    106 	const char *desc;
    107 	prop_dictionary_t props = device_properties(self);
    108 
    109 	sc->sc_dev = self;
    110 	sc->sc_i2c = ia->ia_tag;
    111 	sc->sc_addr = ia->ia_addr;
    112 
    113 	aprint_naive("\n");
    114 	aprint_normal(": DS1361\n");
    115 
    116 	dstemp_init(sc);
    117 
    118 	sc->sc_sme = sysmon_envsys_create();
    119 	sc->sc_sme->sme_name = device_xname(self);
    120 	sc->sc_sme->sme_cookie = sc;
    121 	sc->sc_sme->sme_refresh = dstemp_sensors_refresh;
    122 
    123 	sc->sc_sensor_temp.units = ENVSYS_STEMP;
    124 	sc->sc_sensor_temp.state = ENVSYS_SINVALID;
    125 	sc->sc_sensor_temp.flags = ENVSYS_FHAS_ENTROPY;
    126 
    127 	if (prop_dictionary_get_string(props, "s00", &desc)) {
    128 		strncpy(name, desc, 64);
    129 	} else if (prop_dictionary_get_string(props, "saa", &desc)) {
    130 		strncpy(name, desc, 64);
    131 	}
    132 
    133 	strncpy(sc->sc_sensor_temp.desc, name, sizeof(sc->sc_sensor_temp.desc));
    134 
    135 	sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor_temp);
    136 
    137 	sysmon_envsys_register(sc->sc_sme);
    138 }
    139 
    140 static void
    141 dstemp_init(struct dstemp_softc *sc)
    142 {
    143 	int error;
    144 	uint8_t cmd[2], data;
    145 
    146 	if (iic_acquire_bus(sc->sc_i2c, 0))
    147 		return;
    148 	cmd[0] = DSTEMP_CONFIG;
    149 	data = 0;
    150 	error = iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP,
    151 	    sc->sc_addr, cmd, 1, &data, 1, 0);
    152 	/* we don't want to change the POL bit, so preserve it */
    153 	cmd[1] = (data & DSTEMP_POL) | DSTEMP_12BIT;
    154 	error |= iic_exec(sc->sc_i2c, I2C_OP_WRITE_WITH_STOP,
    155 	    sc->sc_addr, cmd, 2, NULL, 0, 0);
    156 	/* ... and start converting */
    157 	cmd[0] = DSTEMP_CMD_START;
    158 	error |= iic_exec(sc->sc_i2c, I2C_OP_WRITE_WITH_STOP,
    159 	    sc->sc_addr, cmd, 1, NULL, 0, 0);
    160 	if (error) aprint_error_dev(sc->sc_dev, "chip initialization failed\n");
    161 	iic_release_bus(sc->sc_i2c, 0);
    162 }
    163 
    164 static void
    165 dstemp_sensors_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
    166 {
    167 	struct dstemp_softc *sc = sme->sme_cookie;
    168 	uint8_t cmd = DSTEMP_TCURRENT;
    169 	uint16_t data = 0;
    170 	int error;
    171 
    172 
    173 	error = iic_acquire_bus(sc->sc_i2c, 0);
    174 	if (error == 0) {
    175 		error = iic_exec(sc->sc_i2c, I2C_OP_READ_WITH_STOP,
    176 		    sc->sc_addr, &cmd, 1, &data, 2, 0);
    177 		iic_release_bus(sc->sc_i2c, 0);
    178 	}
    179 
    180 	if (error) {
    181 		edata->state = ENVSYS_SINVALID;
    182 	} else {
    183 		edata->value_cur =
    184 		    ((uint64_t)(be16toh(data) >> 4) * 62500) +
    185 		    + 273150000;
    186 		if (edata->value_cur > (273150000 + 120000000)) {
    187 			edata->state = ENVSYS_SINVALID;
    188 		} else
    189 			edata->state = ENVSYS_SVALID;
    190 	}
    191 }
    192