Home | History | Annotate | Line # | Download | only in i2c
hytp14.c revision 1.2.2.2
      1  1.2.2.2  tls /*-
      2  1.2.2.2  tls  * Copyright (c) 2014 The NetBSD Foundation, Inc.
      3  1.2.2.2  tls  * All rights reserved.
      4  1.2.2.2  tls  *
      5  1.2.2.2  tls  * This code is derived from software contributed to The NetBSD Foundation
      6  1.2.2.2  tls  * by Frank Kardel.
      7  1.2.2.2  tls  *
      8  1.2.2.2  tls  * Redistribution and use in source and binary forms, with or without
      9  1.2.2.2  tls  * modification, are permitted provided that the following conditions
     10  1.2.2.2  tls  * are met:
     11  1.2.2.2  tls  * 1. Redistributions of source code must retain the above copyright
     12  1.2.2.2  tls  *    notice, this list of conditions and the following disclaimer.
     13  1.2.2.2  tls  * 2. Redistributions in binary form must reproduce the above copyright
     14  1.2.2.2  tls  *    notice, this list of conditions and the following disclaimer in the
     15  1.2.2.2  tls  *    documentation and/or other materials provided with the distribution.
     16  1.2.2.2  tls  *
     17  1.2.2.2  tls  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     18  1.2.2.2  tls  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     19  1.2.2.2  tls  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     20  1.2.2.2  tls  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     21  1.2.2.2  tls  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     22  1.2.2.2  tls  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     23  1.2.2.2  tls  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     24  1.2.2.2  tls  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     25  1.2.2.2  tls  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     26  1.2.2.2  tls  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     27  1.2.2.2  tls  * POSSIBILITY OF SUCH DAMAGE.
     28  1.2.2.2  tls  */
     29  1.2.2.2  tls 
     30  1.2.2.2  tls /*
     31  1.2.2.2  tls  * IST-AG P14 calibrated Hygro-/Temperature sensor module
     32  1.2.2.2  tls  * Devices: HYT-271, HYT-221 and HYT-939
     33  1.2.2.2  tls  *
     34  1.2.2.2  tls  * see:
     35  1.2.2.2  tls  * http://www.ist-ag.com/eh/ist-ag/resource.nsf/imgref/Download_AHHYTM_E2.1.pdf/
     36  1.2.2.2  tls  *      $FILE/AHHYTM_E2.1.pdf
     37  1.2.2.2  tls  */
     38  1.2.2.2  tls 
     39  1.2.2.2  tls #include <sys/cdefs.h>
     40  1.2.2.2  tls __KERNEL_RCSID(0, "$NetBSD: hytp14.c,v 1.2.2.2 2014/08/10 06:54:51 tls Exp $");
     41  1.2.2.2  tls 
     42  1.2.2.2  tls #include <sys/param.h>
     43  1.2.2.2  tls #include <sys/systm.h>
     44  1.2.2.2  tls #include <sys/kernel.h>
     45  1.2.2.2  tls #include <sys/device.h>
     46  1.2.2.2  tls #include <sys/module.h>
     47  1.2.2.2  tls 
     48  1.2.2.2  tls #include <dev/sysmon/sysmonvar.h>
     49  1.2.2.2  tls 
     50  1.2.2.2  tls #include <dev/i2c/i2cvar.h>
     51  1.2.2.2  tls #include <dev/i2c/hytp14reg.h>
     52  1.2.2.2  tls #include <dev/i2c/hytp14var.h>
     53  1.2.2.2  tls 
     54  1.2.2.2  tls static int hytp14_match(device_t, cfdata_t, void *);
     55  1.2.2.2  tls static void hytp14_attach(device_t, device_t, void *);
     56  1.2.2.2  tls static int hytp14_detach(device_t, int);
     57  1.2.2.2  tls static int hytp14_refresh_sensor(struct hytp14_sc *sc);
     58  1.2.2.2  tls static void hytp14_refresh(struct sysmon_envsys *, envsys_data_t *);
     59  1.2.2.2  tls static void hytp14_refresh_humidity(struct hytp14_sc *, envsys_data_t *);
     60  1.2.2.2  tls static void hytp14_refresh_temp(struct hytp14_sc *, envsys_data_t *);
     61  1.2.2.2  tls 
     62  1.2.2.2  tls /* #define HYT_DEBUG 3 */
     63  1.2.2.2  tls #ifdef HYT_DEBUG
     64  1.2.2.2  tls volatile int hythygtemp_debug = HYT_DEBUG;
     65  1.2.2.2  tls 
     66  1.2.2.2  tls #define DPRINTF(_L_, _X_) do {			\
     67  1.2.2.2  tls 	  if ((_L_) <= hythygtemp_debug) {	\
     68  1.2.2.2  tls 	    printf _X_;				\
     69  1.2.2.2  tls 	  }                                     \
     70  1.2.2.2  tls         } while (0)
     71  1.2.2.2  tls #else
     72  1.2.2.2  tls #define DPRINTF(_L_, _X_)
     73  1.2.2.2  tls #endif
     74  1.2.2.2  tls 
     75  1.2.2.2  tls CFATTACH_DECL_NEW(hythygtemp, sizeof(struct hytp14_sc),
     76  1.2.2.2  tls     hytp14_match, hytp14_attach, hytp14_detach, NULL);
     77  1.2.2.2  tls 
     78  1.2.2.2  tls static struct hytp14_sensor hytp14_sensors[] = {
     79  1.2.2.2  tls 	{
     80  1.2.2.2  tls 		.desc = "humidity",
     81  1.2.2.2  tls 		.type = ENVSYS_SRELHUMIDITY,
     82  1.2.2.2  tls 		.refresh = hytp14_refresh_humidity
     83  1.2.2.2  tls 	},
     84  1.2.2.2  tls 	{
     85  1.2.2.2  tls 		.desc = "temperature",
     86  1.2.2.2  tls 		.type = ENVSYS_STEMP,
     87  1.2.2.2  tls 		.refresh = hytp14_refresh_temp
     88  1.2.2.2  tls 	}
     89  1.2.2.2  tls };
     90  1.2.2.2  tls 
     91  1.2.2.2  tls static int
     92  1.2.2.2  tls hytp14_match(device_t parent, cfdata_t match, void *aux)
     93  1.2.2.2  tls {
     94  1.2.2.2  tls 	struct i2c_attach_args *ia = aux;
     95  1.2.2.2  tls 
     96  1.2.2.2  tls 	if (ia->ia_name) {
     97  1.2.2.2  tls 		/* direct config - check name */
     98  1.2.2.2  tls 		if (strcmp(ia->ia_name, "hythygtemp") == 0)
     99  1.2.2.2  tls 			return 1;
    100  1.2.2.2  tls 	} else {
    101  1.2.2.2  tls 		/* indirect config - check for configured address */
    102  1.2.2.2  tls 		if ((ia->ia_addr > 0) && (ia->ia_addr <= 0x7F))
    103  1.2.2.2  tls 			return 1;
    104  1.2.2.2  tls 	}
    105  1.2.2.2  tls 	return 0;
    106  1.2.2.2  tls }
    107  1.2.2.2  tls 
    108  1.2.2.2  tls static void
    109  1.2.2.2  tls hytp14_attach(device_t parent, device_t self, void *aux)
    110  1.2.2.2  tls {
    111  1.2.2.2  tls 	struct hytp14_sc *sc = device_private(self);
    112  1.2.2.2  tls 	struct i2c_attach_args *ia = aux;
    113  1.2.2.2  tls 	int i;
    114  1.2.2.2  tls 
    115  1.2.2.2  tls 	sc->sc_dev = self;
    116  1.2.2.2  tls 	sc->sc_tag = ia->ia_tag;
    117  1.2.2.2  tls 	sc->sc_addr = ia->ia_addr;
    118  1.2.2.2  tls 	sc->sc_refresh = 0;
    119  1.2.2.2  tls 	sc->sc_valid = ENVSYS_SINVALID;
    120  1.2.2.2  tls 	sc->sc_numsensors = __arraycount(hytp14_sensors);
    121  1.2.2.2  tls 
    122  1.2.2.2  tls 	if ((sc->sc_sme = sysmon_envsys_create()) == NULL) {
    123  1.2.2.2  tls 		aprint_error_dev(sc->sc_dev,
    124  1.2.2.2  tls 		    "unable to create sysmon structure\n");
    125  1.2.2.2  tls 		return;
    126  1.2.2.2  tls 	}
    127  1.2.2.2  tls 
    128  1.2.2.2  tls 	for (i = 0; i < sc->sc_numsensors; i++) {
    129  1.2.2.2  tls 		strlcpy(sc->sc_sensors[i].desc,
    130  1.2.2.2  tls 			hytp14_sensors[i].desc,
    131  1.2.2.2  tls 			sizeof sc->sc_sensors[i].desc);
    132  1.2.2.2  tls 
    133  1.2.2.2  tls 		sc->sc_sensors[i].units = hytp14_sensors[i].type;
    134  1.2.2.2  tls 		sc->sc_sensors[i].state = ENVSYS_SINVALID;
    135  1.2.2.2  tls 
    136  1.2.2.2  tls 		DPRINTF(2, ("hytp14_attach: registering sensor %d (%s)\n", i,
    137  1.2.2.2  tls 			    sc->sc_sensors[i].desc));
    138  1.2.2.2  tls 
    139  1.2.2.2  tls 		if (sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensors[i])) {
    140  1.2.2.2  tls 			aprint_error_dev(sc->sc_dev,
    141  1.2.2.2  tls 			    "unable to attach sensor\n");
    142  1.2.2.2  tls 			sysmon_envsys_destroy(sc->sc_sme);
    143  1.2.2.2  tls 			return;
    144  1.2.2.2  tls 		}
    145  1.2.2.2  tls 	}
    146  1.2.2.2  tls 
    147  1.2.2.2  tls 	sc->sc_sme->sme_name = device_xname(sc->sc_dev);
    148  1.2.2.2  tls 	sc->sc_sme->sme_cookie = sc;
    149  1.2.2.2  tls 	sc->sc_sme->sme_refresh = hytp14_refresh;
    150  1.2.2.2  tls 
    151  1.2.2.2  tls 	DPRINTF(2, ("hytp14_attach: registering with envsys\n"));
    152  1.2.2.2  tls 
    153  1.2.2.2  tls 	if (sysmon_envsys_register(sc->sc_sme)) {
    154  1.2.2.2  tls 		aprint_error_dev(sc->sc_dev,
    155  1.2.2.2  tls 		    "unable to register with sysmon\n");
    156  1.2.2.2  tls 		sysmon_envsys_destroy(sc->sc_sme);
    157  1.2.2.2  tls 		return;
    158  1.2.2.2  tls 	}
    159  1.2.2.2  tls 
    160  1.2.2.2  tls 	aprint_normal(": HYT-221/271/939 humidity and temperature sensor\n");
    161  1.2.2.2  tls }
    162  1.2.2.2  tls 
    163  1.2.2.2  tls static int hytp14_detach(device_t self, int flags)
    164  1.2.2.2  tls {
    165  1.2.2.2  tls 	struct hytp14_sc *sc = device_private(self);
    166  1.2.2.2  tls 
    167  1.2.2.2  tls 	if (sc->sc_sme != NULL) {
    168  1.2.2.2  tls 		sysmon_envsys_unregister(sc->sc_sme);
    169  1.2.2.2  tls 		sc->sc_sme = NULL;
    170  1.2.2.2  tls 	}
    171  1.2.2.2  tls 
    172  1.2.2.2  tls 	return 0;
    173  1.2.2.2  tls }
    174  1.2.2.2  tls 
    175  1.2.2.2  tls static int
    176  1.2.2.2  tls hytp14_refresh_sensor(struct hytp14_sc *sc)
    177  1.2.2.2  tls {
    178  1.2.2.2  tls 	int error = 0;
    179  1.2.2.2  tls 	uint8_t buf[I2C_EXEC_MAX_BUFLEN];
    180  1.2.2.2  tls 
    181  1.2.2.2  tls 	/* no more than once per second */
    182  1.2.2.2  tls 	if (hardclock_ticks - sc->sc_refresh < hz)
    183  1.2.2.2  tls 		return sc->sc_valid;
    184  1.2.2.2  tls 
    185  1.2.2.2  tls 	DPRINTF(2, ("hytp14_refresh_sensor(%s)\n", device_xname(sc->sc_dev)));
    186  1.2.2.2  tls 
    187  1.2.2.2  tls 	if ((error = iic_acquire_bus(sc->sc_tag, 0)) == 0) {
    188  1.2.2.2  tls 		DPRINTF(3, ("hytp14_refresh_sensor(%s): bus locked\n", device_xname(sc->sc_dev)));
    189  1.2.2.2  tls 
    190  1.2.2.2  tls 		/* send MR command */
    191  1.2.2.2  tls                 /* avoid quick read/write by providing a result buffer */
    192  1.2.2.2  tls 		error = iic_exec(sc->sc_tag, I2C_OP_WRITE_WITH_STOP,
    193  1.2.2.2  tls 				 sc->sc_addr, NULL, 0, buf, sizeof buf, 0);
    194  1.2.2.2  tls                 if (error == 0) {
    195  1.2.2.2  tls 			DPRINTF(3, ("hytp14_refresh_sensor(%s): MR sent\n",
    196  1.2.2.2  tls 				    device_xname(sc->sc_dev)));
    197  1.2.2.2  tls 
    198  1.2.2.2  tls 			/* send DF command - read data from sensor */
    199  1.2.2.2  tls 			error = iic_exec(sc->sc_tag, I2C_OP_READ_WITH_STOP,
    200  1.2.2.2  tls 					 sc->sc_addr, NULL, 0, sc->sc_data,
    201  1.2.2.2  tls 					      sizeof sc->sc_data, 0);
    202  1.2.2.2  tls                         if (error != 0) {
    203  1.2.2.2  tls 				DPRINTF(2, ("%s: %s: failed read from 0x%02x - error %d\n",
    204  1.2.2.2  tls 					    device_xname(sc->sc_dev),
    205  1.2.2.2  tls 					    __func__, sc->sc_addr, error));
    206  1.2.2.2  tls 			} else {
    207  1.2.2.2  tls 				DPRINTF(2, ("hytp14_refresh_sensor(%s): DF success : 0x%02x%02x%02x%02x\n",
    208  1.2.2.2  tls 					    device_xname(sc->sc_dev),
    209  1.2.2.2  tls 					    sc->sc_data[0],
    210  1.2.2.2  tls 					    sc->sc_data[1],
    211  1.2.2.2  tls 					    sc->sc_data[2],
    212  1.2.2.2  tls 					    sc->sc_data[3]));
    213  1.2.2.2  tls 			}
    214  1.2.2.2  tls 		} else {
    215  1.2.2.2  tls 			DPRINTF(2, ("%s: %s: failed read from 0x%02x - error %d\n",
    216  1.2.2.2  tls 				    device_xname(sc->sc_dev), __func__,
    217  1.2.2.2  tls 				    sc->sc_addr, error));
    218  1.2.2.2  tls 		}
    219  1.2.2.2  tls 
    220  1.2.2.2  tls 		iic_release_bus(sc->sc_tag, 0);
    221  1.2.2.2  tls 		DPRINTF(3, ("hytp14_refresh_sensor(%s): bus released\n", device_xname(sc->sc_dev)));
    222  1.2.2.2  tls 	} else {
    223  1.2.2.2  tls 		DPRINTF(2, ("%s: %s: failed read from 0x%02x - error %d\n",
    224  1.2.2.2  tls 			    device_xname(sc->sc_dev), __func__, sc->sc_addr, error));
    225  1.2.2.2  tls 	}
    226  1.2.2.2  tls 
    227  1.2.2.2  tls 	sc->sc_refresh = hardclock_ticks;
    228  1.2.2.2  tls 
    229  1.2.2.2  tls 	/* skip data if sensor is in command mode */
    230  1.2.2.2  tls 	if (error == 0 && (sc->sc_data[0] & HYTP14_RESP_CMDMODE) == 0) {
    231  1.2.2.2  tls 		sc->sc_valid = ENVSYS_SVALID;
    232  1.2.2.2  tls 	} else {
    233  1.2.2.2  tls 		sc->sc_valid = ENVSYS_SINVALID;
    234  1.2.2.2  tls 	}
    235  1.2.2.2  tls 
    236  1.2.2.2  tls 	return sc->sc_valid;
    237  1.2.2.2  tls }
    238  1.2.2.2  tls 
    239  1.2.2.2  tls 
    240  1.2.2.2  tls static void
    241  1.2.2.2  tls hytp14_refresh_humidity(struct hytp14_sc *sc, envsys_data_t *edata)
    242  1.2.2.2  tls {
    243  1.2.2.2  tls 	uint16_t hyg;
    244  1.2.2.2  tls 	int status;
    245  1.2.2.2  tls 
    246  1.2.2.2  tls 	status = hytp14_refresh_sensor(sc);
    247  1.2.2.2  tls 
    248  1.2.2.2  tls 	if (status == ENVSYS_SVALID) {
    249  1.2.2.2  tls 		hyg = (sc->sc_data[0] << 8) | sc->sc_data[1];
    250  1.2.2.2  tls 
    251  1.2.2.2  tls 		edata->value_cur = (1000000000 / HYTP14_HYG_SCALE) * (int32_t)HYTP14_HYG_RAWVAL(hyg);
    252  1.2.2.2  tls 		edata->value_cur /= 10;
    253  1.2.2.2  tls 	}
    254  1.2.2.2  tls 
    255  1.2.2.2  tls 	edata->state = status;
    256  1.2.2.2  tls }
    257  1.2.2.2  tls 
    258  1.2.2.2  tls static void
    259  1.2.2.2  tls hytp14_refresh_temp(struct hytp14_sc *sc, envsys_data_t *edata)
    260  1.2.2.2  tls {
    261  1.2.2.2  tls 	uint16_t temp;
    262  1.2.2.2  tls 	int status;
    263  1.2.2.2  tls 
    264  1.2.2.2  tls 	status = hytp14_refresh_sensor(sc);
    265  1.2.2.2  tls 
    266  1.2.2.2  tls 	if (status == ENVSYS_SVALID) {
    267  1.2.2.2  tls 		temp = HYTP14_TEMP_RAWVAL((sc->sc_data[2] << 8) | sc->sc_data[3]);
    268  1.2.2.2  tls 
    269  1.2.2.2  tls 		edata->value_cur = (HYTP14_TEMP_FACTOR * 1000000) / HYTP14_TEMP_SCALE;
    270  1.2.2.2  tls 		edata->value_cur *= (int32_t)temp;
    271  1.2.2.2  tls 		edata->value_cur += HYTP14_TEMP_OFFSET * 1000000 + 273150000;
    272  1.2.2.2  tls 	}
    273  1.2.2.2  tls 
    274  1.2.2.2  tls 	edata->state = status;
    275  1.2.2.2  tls }
    276  1.2.2.2  tls 
    277  1.2.2.2  tls static void
    278  1.2.2.2  tls hytp14_refresh(struct sysmon_envsys *sme, envsys_data_t *edata)
    279  1.2.2.2  tls {
    280  1.2.2.2  tls 	struct hytp14_sc *sc = sme->sme_cookie;
    281  1.2.2.2  tls 
    282  1.2.2.2  tls 	hytp14_sensors[edata->sensor].refresh(sc, edata);
    283  1.2.2.2  tls }
    284  1.2.2.2  tls 
    285  1.2.2.2  tls 
    286  1.2.2.2  tls MODULE(MODULE_CLASS_DRIVER, hythygtemp, "iic");
    287  1.2.2.2  tls 
    288  1.2.2.2  tls #ifdef _MODULE
    289  1.2.2.2  tls #include "ioconf.c"
    290  1.2.2.2  tls #endif
    291  1.2.2.2  tls 
    292  1.2.2.2  tls static int
    293  1.2.2.2  tls hythygtemp_modcmd(modcmd_t cmd, void *opaque)
    294  1.2.2.2  tls {
    295  1.2.2.2  tls 	int error = 0;
    296  1.2.2.2  tls 
    297  1.2.2.2  tls 	switch (cmd) {
    298  1.2.2.2  tls 	case MODULE_CMD_INIT:
    299  1.2.2.2  tls #ifdef _MODULE
    300  1.2.2.2  tls 		error = config_init_component(cfdriver_ioconf_hythygtemp,
    301  1.2.2.2  tls 		    cfattach_ioconf_hythygtemp, cfdata_ioconf_hythygtemp);
    302  1.2.2.2  tls #endif
    303  1.2.2.2  tls 		return error;
    304  1.2.2.2  tls 
    305  1.2.2.2  tls 	case MODULE_CMD_FINI:
    306  1.2.2.2  tls #ifdef _MODULE
    307  1.2.2.2  tls 		error = config_fini_component(cfdriver_ioconf_hythygtemp,
    308  1.2.2.2  tls 		    cfattach_ioconf_hythygtemp, cfdata_ioconf_hythygtemp);
    309  1.2.2.2  tls #endif
    310  1.2.2.2  tls 		return error;
    311  1.2.2.2  tls 
    312  1.2.2.2  tls 	default:
    313  1.2.2.2  tls 		return ENOTTY;
    314  1.2.2.2  tls 	}
    315  1.2.2.2  tls }
    316