Home | History | Annotate | Line # | Download | only in spi
      1 /* $NetBSD: tmp121.c,v 1.12 2025/09/13 14:10:44 thorpej Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2006 Urbana-Champaign Independent Media Center.
      5  * Copyright (c) 2006 Garrett D'Amore.
      6  * All rights reserved.
      7  *
      8  * Portions of this code were written by Garrett D'Amore for the
      9  * Champaign-Urbana Community Wireless Network Project.
     10  *
     11  * Redistribution and use in source and binary forms, with or
     12  * without modification, are permitted provided that the following
     13  * conditions are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above
     17  *    copyright notice, this list of conditions and the following
     18  *    disclaimer in the documentation and/or other materials provided
     19  *    with the distribution.
     20  * 3. All advertising materials mentioning features or use of this
     21  *    software must display the following acknowledgements:
     22  *      This product includes software developed by the Urbana-Champaign
     23  *      Independent Media Center.
     24  *	This product includes software developed by Garrett D'Amore.
     25  * 4. Urbana-Champaign Independent Media Center's name and Garrett
     26  *    D'Amore's name may not be used to endorse or promote products
     27  *    derived from this software without specific prior written permission.
     28  *
     29  * THIS SOFTWARE IS PROVIDED BY THE URBANA-CHAMPAIGN INDEPENDENT
     30  * MEDIA CENTER AND GARRETT D'AMORE ``AS IS'' AND ANY EXPRESS OR
     31  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     32  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE URBANA-CHAMPAIGN INDEPENDENT
     34  * MEDIA CENTER OR GARRETT D'AMORE BE LIABLE FOR ANY DIRECT, INDIRECT,
     35  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     36  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     37  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
     38  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     40  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     41  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     42  */
     43 
     44 #include <sys/cdefs.h>
     45 __KERNEL_RCSID(0, "$NetBSD: tmp121.c,v 1.12 2025/09/13 14:10:44 thorpej Exp $");
     46 
     47 #include <sys/param.h>
     48 #include <sys/systm.h>
     49 #include <sys/device.h>
     50 #include <sys/kernel.h>
     51 
     52 #include <dev/sysmon/sysmonvar.h>
     53 
     54 #include <dev/spi/spivar.h>
     55 
     56 struct tmp121temp_softc {
     57 	spi_handle_t sc_sh;
     58 
     59 	struct sysmon_envsys *sc_sme;
     60 	envsys_data_t sc_sensor;
     61 };
     62 
     63 static int	tmp121temp_match(device_t, cfdata_t, void *);
     64 static void	tmp121temp_attach(device_t, device_t, void *);
     65 
     66 static void	tmp121temp_refresh(struct sysmon_envsys *, envsys_data_t *);
     67 
     68 CFATTACH_DECL_NEW(tmp121temp, sizeof(struct tmp121temp_softc),
     69     tmp121temp_match, tmp121temp_attach, NULL, NULL);
     70 
     71 static const struct device_compatible_entry compat_data[] = {
     72 	{ .compat = "ti,tmp121" },
     73 	{ .compat = "TMP00121" },
     74 
     75 #if 0	/* We should also add support for these: */
     76 	{ .compat = "ti,tmp122" },
     77 
     78 	{ .compat = "ti,lm70" },
     79 	{ .compat = "LM000070" },
     80 
     81 	{ .compat = "ti,lm71" },
     82 	{ .compat = "LM000071" },
     83 
     84 	{ .compat = "ti,lm74" },
     85 	{ .compat = "LM000074" },
     86 #endif
     87 	DEVICE_COMPAT_EOL
     88 };
     89 
     90 static int
     91 tmp121temp_match(device_t parent, cfdata_t cf, void *aux)
     92 {
     93 	struct spi_attach_args *sa = aux;
     94 	int match_result;
     95 
     96 	if (spi_use_direct_match(sa, compat_data, &match_result)) {
     97 		return match_result;
     98 	}
     99 
    100 	return SPI_MATCH_DEFAULT;
    101 }
    102 
    103 static void
    104 tmp121temp_attach(device_t parent, device_t self, void *aux)
    105 {
    106 	struct tmp121temp_softc *sc = device_private(self);
    107 	struct spi_attach_args *sa = aux;
    108 	int error;
    109 
    110 	aprint_naive(": Temperature Sensor\n");
    111 	aprint_normal(": TI TMP121 Temperature Sensor\n");
    112 
    113 	/* configure for 10MHz */
    114 	error = spi_configure(self, sa->sa_handle, SPI_MODE_0,
    115 	    SPI_FREQ_MHz(10));
    116 	if (error) {
    117 		return;
    118 	}
    119 
    120 	sc->sc_sh = sa->sa_handle;
    121 
    122 	sc->sc_sme = sysmon_envsys_create();
    123 	sc->sc_sensor.units = ENVSYS_STEMP;
    124 	sc->sc_sensor.state = ENVSYS_SINVALID;
    125 	strlcpy(sc->sc_sensor.desc, device_xname(self),
    126 	    sizeof(sc->sc_sensor.desc));
    127 	if (sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor)) {
    128 		sysmon_envsys_destroy(sc->sc_sme);
    129 		return;
    130 	}
    131 
    132 	sc->sc_sme->sme_name = device_xname(self);
    133 	sc->sc_sme->sme_refresh = tmp121temp_refresh;
    134 	sc->sc_sme->sme_cookie = sc;
    135 
    136 	if (sysmon_envsys_register(sc->sc_sme)) {
    137 		aprint_error_dev(self, "unable to register with sysmon\n");
    138 		sysmon_envsys_destroy(sc->sc_sme);
    139 	}
    140 }
    141 
    142 static void
    143 tmp121temp_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
    144 {
    145 	struct tmp121temp_softc *sc = sme->sme_cookie;
    146 	uint16_t		reg;
    147 	int16_t			sreg;
    148 	int			val;
    149 
    150 	if (spi_recv(sc->sc_sh, 2, (uint8_t *)&reg) != 0) {
    151 		edata->state = ENVSYS_SINVALID;
    152 		return;
    153 	}
    154 
    155 	sreg = (int16_t)be16toh(reg);
    156 
    157 	/*
    158 	 * convert to uK:
    159 	 *
    160 	 * TMP121 bits:
    161 	 * D15		: sign bit
    162 	 * D14-D3	: data (D14 is MSB)
    163 	 * D2-D0	: zero
    164 	 *
    165 	 * The data is represented in units of 0.0625 deg C.
    166 	 */
    167 	sreg >>= 3;
    168 	val = sreg * 62500 + 273150000;
    169 
    170 	edata->value_cur = val;
    171 	edata->state = ENVSYS_SVALID;
    172 }
    173