uthum.c revision 1.5
1 /* $NetBSD: uthum.c,v 1.5 2010/03/12 09:02:15 jdc Exp $ */ 2 /* $OpenBSD: uthum.c,v 1.6 2010/01/03 18:43:02 deraadt Exp $ */ 3 4 /* 5 * Copyright (c) 2009 Yojiro UO <yuo (at) nui.org> 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 /* Driver for TEMPer and TEMPerHUM HID */ 21 22 #include <sys/param.h> 23 #include <sys/proc.h> 24 #include <sys/systm.h> 25 #include <sys/kernel.h> 26 #include <sys/malloc.h> 27 #include <sys/device.h> 28 #include <sys/conf.h> 29 30 #include <dev/sysmon/sysmonvar.h> 31 32 #include <dev/usb/usb.h> 33 #include <dev/usb/usbhid.h> 34 #include <dev/usb/usbdi.h> 35 #include <dev/usb/usbdi_util.h> 36 #include <dev/usb/usbdevs.h> 37 #include <dev/usb/uhidev.h> 38 #include <dev/usb/hid.h> 39 40 #ifdef USB_DEBUG 41 #define UTHUM_DEBUG 42 #endif 43 44 #ifdef UTHUM_DEBUG 45 int uthumdebug = 0; 46 #define DPRINTFN(n, x) do { if (uthumdebug > (n)) printf x; } while (0) 47 #else 48 #define DPRINTFN(n, x) 49 #endif 50 51 #define DPRINTF(x) DPRINTFN(0, x) 52 53 54 /* TEMPerHUM */ 55 #define CMD_DEVTYPE 0x52 /* XXX */ 56 #define CMD_GETDATA 0x48 /* XXX */ 57 #define CMD_GETTEMP 0x54 /* XXX */ 58 static uint8_t cmd_start[8] = 59 { 0x0a, 0x0b, 0x0c, 0x0d, 0x00, 0x00, 0x02, 0x00 }; 60 static uint8_t cmd_end[8] = 61 { 0x0a, 0x0b, 0x0c, 0x0d, 0x00, 0x00, 0x01, 0x00 }; 62 63 /* sensors */ 64 #define UTHUM_TEMP 0 65 #define UTHUM_HUMIDITY 1 66 #define UTHUM_MAX_SENSORS 2 67 68 #define UTHUM_TYPE_UNKNOWN 0 69 #define UTHUM_TYPE_SHT1x 1 70 #define UTHUM_TYPE_TEMPER 2 71 72 struct uthum_softc { 73 struct uhidev sc_hdev; 74 usbd_device_handle sc_udev; 75 u_char sc_dying; 76 uint16_t sc_flag; 77 int sc_sensortype; 78 79 /* uhidev parameters */ 80 size_t sc_flen; /* feature report length */ 81 size_t sc_ilen; /* input report length */ 82 size_t sc_olen; /* output report length */ 83 84 /* sensor framework */ 85 struct sysmon_envsys *sc_sme; 86 envsys_data_t sc_sensor[UTHUM_MAX_SENSORS]; 87 88 uint8_t sc_num_sensors; 89 }; 90 91 92 const struct usb_devno uthum_devs[] = { 93 /* XXX: various TEMPer variants using same VID/PID */ 94 { USB_VENDOR_TENX, USB_PRODUCT_TENX_TEMPER}, 95 }; 96 #define uthum_lookup(v, p) usb_lookup(uthum_devs, v, p) 97 98 int uthum_match(device_t, cfdata_t, void *); 99 void uthum_attach(device_t, device_t, void *); 100 void uthum_childdet(device_t, device_t); 101 int uthum_detach(device_t, int); 102 int uthum_activate(device_t, enum devact); 103 104 int uthum_read_data(struct uthum_softc *, uint8_t, uint8_t *, size_t, int); 105 int uthum_check_sensortype(struct uthum_softc *); 106 int uthum_temper_temp(uint8_t, uint8_t); 107 int uthum_sht1x_temp(uint8_t, uint8_t); 108 int uthum_sht1x_rh(unsigned int, int); 109 110 void uthum_intr(struct uhidev *, void *, u_int); 111 static void uthum_refresh(struct sysmon_envsys *, envsys_data_t *); 112 113 extern struct cfdriver uthum_cd; 114 CFATTACH_DECL_NEW(uthum, sizeof(struct uthum_softc), uthum_match, uthum_attach, 115 uthum_detach, uthum_activate); 116 117 USB_MATCH(uthum) 118 { 119 USB_MATCH_START(uthum, uaa); 120 struct uhidev_attach_arg *uha = (struct uhidev_attach_arg *)uaa; 121 122 return (uthum_lookup(uha->uaa->vendor, uha->uaa->product) != NULL ? 123 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 124 } 125 126 USB_ATTACH(uthum) 127 { 128 USB_ATTACH_START(uthum, sc, uaa); 129 struct uhidev_attach_arg *uha = (struct uhidev_attach_arg *)uaa; 130 usbd_device_handle dev = uha->parent->sc_udev; 131 int size, repid; 132 void *desc; 133 134 sc->sc_udev = dev; 135 sc->sc_hdev.sc_dev = self; 136 sc->sc_hdev.sc_intr = uthum_intr; 137 sc->sc_hdev.sc_parent = uha->parent; 138 sc->sc_hdev.sc_report_id = uha->reportid; 139 sc->sc_num_sensors = 0; 140 141 aprint_normal("\n"); 142 aprint_naive("\n"); 143 144 uhidev_get_report_desc(uha->parent, &desc, &size); 145 repid = uha->reportid; 146 sc->sc_ilen = hid_report_size(desc, size, hid_input, repid); 147 sc->sc_olen = hid_report_size(desc, size, hid_output, repid); 148 sc->sc_flen = hid_report_size(desc, size, hid_feature, repid); 149 150 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 151 sc->sc_hdev.sc_dev); 152 153 if (sc->sc_flen < 32) { 154 /* not sensor interface, just attach */ 155 return; 156 } 157 158 sc->sc_sensortype = uthum_check_sensortype(sc); 159 160 /* attach sensor */ 161 sc->sc_sme = sysmon_envsys_create(); 162 sc->sc_sme->sme_name = device_xname(self); 163 164 switch (sc->sc_sensortype) { 165 case UTHUM_TYPE_SHT1x: 166 (void)strlcpy(sc->sc_sensor[UTHUM_TEMP].desc, "temp", 167 sizeof(sc->sc_sensor[UTHUM_TEMP].desc)); 168 sc->sc_sensor[UTHUM_TEMP].units = ENVSYS_STEMP; 169 sc->sc_sensor[UTHUM_TEMP].state = ENVSYS_SINVALID; 170 171 (void)strlcpy(sc->sc_sensor[UTHUM_HUMIDITY].desc, 172 "relative humidity", 173 sizeof(sc->sc_sensor[UTHUM_HUMIDITY].desc)); 174 sc->sc_sensor[UTHUM_HUMIDITY].units = ENVSYS_INTEGER; 175 sc->sc_sensor[UTHUM_HUMIDITY].value_cur = 0; 176 sc->sc_sensor[UTHUM_HUMIDITY].state = ENVSYS_SINVALID; 177 178 sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor[UTHUM_TEMP]); 179 sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor[UTHUM_HUMIDITY]); 180 sc->sc_num_sensors = 2; 181 DPRINTF(("sensor type: SHT1x\n")); 182 break; 183 case UTHUM_TYPE_TEMPER: 184 (void)strlcpy(sc->sc_sensor[UTHUM_TEMP].desc, "temp", 185 sizeof(sc->sc_sensor[UTHUM_TEMP].desc)); 186 sc->sc_sensor[UTHUM_TEMP].units = ENVSYS_STEMP; 187 sc->sc_sensor[UTHUM_TEMP].state = ENVSYS_SINVALID; 188 189 sysmon_envsys_sensor_attach(sc->sc_sme, &sc->sc_sensor[UTHUM_TEMP]); 190 sc->sc_num_sensors = 1; 191 DPRINTF(("sensor type: TEMPer\n")); 192 break; 193 case UTHUM_TYPE_UNKNOWN: 194 DPRINTF(("sensor type: unknown, give up to attach sensors\n")); 195 default: 196 break; 197 } 198 199 if (sc->sc_num_sensors > 0) { 200 sc->sc_sme->sme_cookie = sc; 201 sc->sc_sme->sme_refresh = uthum_refresh; 202 203 if (sysmon_envsys_register(sc->sc_sme)) { 204 aprint_error_dev(self, "unable to register with sysmon\n"); 205 sysmon_envsys_destroy(sc->sc_sme); 206 } 207 } else { 208 sysmon_envsys_destroy(sc->sc_sme); 209 } 210 211 DPRINTF(("uthum_attach: complete\n")); 212 } 213 214 USB_DETACH(uthum) 215 { 216 USB_DETACH_START(uthum, sc); 217 int rv = 0; 218 219 sc->sc_dying = 1; 220 221 if (sc->sc_num_sensors > 0) { 222 sysmon_envsys_unregister(sc->sc_sme); 223 } 224 225 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 226 sc->sc_hdev.sc_dev); 227 228 return (rv); 229 } 230 231 int 232 uthum_activate(device_t self, enum devact act) 233 { 234 struct uthum_softc *sc = device_private(self); 235 236 switch (act) { 237 case DVACT_DEACTIVATE: 238 sc->sc_dying = 1; 239 break; 240 } 241 return (0); 242 } 243 244 void 245 uthum_intr(struct uhidev *addr, void *ibuf, u_int len) 246 { 247 /* do nothing */ 248 } 249 250 int 251 uthum_read_data(struct uthum_softc *sc, uint8_t target_cmd, uint8_t *buf, 252 size_t len, int need_delay) 253 { 254 int i; 255 uint8_t cmdbuf[32], report[256]; 256 257 /* if return buffer is null, do nothing */ 258 if ((buf == NULL) || len == 0) 259 return 0; 260 261 /* issue query */ 262 bzero(cmdbuf, sizeof(cmdbuf)); 263 memcpy(cmdbuf, cmd_start, sizeof(cmd_start)); 264 if (uhidev_set_report(&sc->sc_hdev, UHID_OUTPUT_REPORT, 265 cmdbuf, sc->sc_olen)) 266 return EIO; 267 268 bzero(cmdbuf, sizeof(cmdbuf)); 269 cmdbuf[0] = target_cmd; 270 if (uhidev_set_report(&sc->sc_hdev, UHID_OUTPUT_REPORT, 271 cmdbuf, sc->sc_olen)) 272 return EIO; 273 274 bzero(cmdbuf, sizeof(cmdbuf)); 275 for (i = 0; i < 7; i++) { 276 if (uhidev_set_report(&sc->sc_hdev, UHID_OUTPUT_REPORT, 277 cmdbuf, sc->sc_olen)) 278 return EIO; 279 } 280 memcpy(cmdbuf, cmd_end, sizeof(cmd_end)); 281 if (uhidev_set_report(&sc->sc_hdev, UHID_OUTPUT_REPORT, 282 cmdbuf, sc->sc_olen)) 283 return EIO; 284 285 /* wait if required */ 286 if (need_delay > 1) 287 tsleep(&sc->sc_sme, 0, "uthum", (need_delay*hz+999)/1000 + 1); 288 289 /* get answer */ 290 if (uhidev_get_report(&sc->sc_hdev, UHID_FEATURE_REPORT, 291 report, sc->sc_flen)) 292 return EIO; 293 memcpy(buf, report, len); 294 return 0; 295 } 296 297 int 298 uthum_check_sensortype(struct uthum_softc *sc) 299 { 300 uint8_t buf[8]; 301 static uint8_t sht1x_sig0[] = 302 { 0x57, 0x5a, 0x13, 0x00, 0x14, 0x00, 0x53, 0x00 }; 303 static uint8_t sht1x_sig1[] = 304 { 0x57, 0x5a, 0x14, 0x00, 0x14, 0x00, 0x53, 0x00 }; 305 static uint8_t temper_sig[] = 306 { 0x57, 0x58, 0x14, 0x00, 0x14, 0x00, 0x53, 0x00 }; 307 308 if (uthum_read_data(sc, CMD_DEVTYPE, buf, sizeof(buf), 0) != 0) { 309 DPRINTF(("uthum: read fail\n")); 310 return UTHUM_TYPE_UNKNOWN; 311 } 312 313 /* 314 * currently we have not enough information about the return value, 315 * therefore, compare full bytes. 316 * TEMPerHUM HID (SHT1x version) will return: 317 * { 0x57, 0x5a, 0x13, 0x00, 0x14, 0x00, 0x53, 0x00 } 318 * { 0x57, 0x5a, 0x14, 0x00, 0x14, 0x00, 0x53, 0x00 } 319 * TEMPer HID (TEMPer version) will return: 320 * { 0x57, 0x58, 0x14, 0x00, 0x14, 0x00, 0x53, 0x00 } 321 */ 322 DPRINTF(("uthum: device signature: " 323 "0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x\n", 324 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7])); 325 if (0 == memcmp(buf, sht1x_sig0, sizeof(sht1x_sig0))) 326 return UTHUM_TYPE_SHT1x; 327 if (0 == memcmp(buf, sht1x_sig1, sizeof(sht1x_sig1))) 328 return UTHUM_TYPE_SHT1x; 329 if (0 == memcmp(buf, temper_sig, sizeof(temper_sig))) 330 return UTHUM_TYPE_TEMPER; 331 332 return UTHUM_TYPE_UNKNOWN; 333 } 334 335 336 static void 337 uthum_refresh(struct sysmon_envsys *sme, envsys_data_t *edata) 338 { 339 struct uthum_softc *sc = sme->sme_cookie; 340 uint8_t buf[8]; 341 unsigned int humidity_tick; 342 int temp, rh; 343 344 switch (sc->sc_sensortype) { 345 case UTHUM_TYPE_SHT1x: 346 if (uthum_read_data(sc, CMD_GETDATA, buf, sizeof(buf), 1000) != 0) { 347 DPRINTF(("uthum: data read fail\n")); 348 sc->sc_sensor[UTHUM_TEMP].state = ENVSYS_SINVALID; 349 sc->sc_sensor[UTHUM_HUMIDITY].state = ENVSYS_SINVALID; 350 return; 351 } 352 DPRINTF(("%s: read SHT1x data " 353 "0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x\n", 354 sc->sc_sme->sme_name, buf[0], buf[1], buf[2], buf[3], 355 buf[4], buf[5], buf[6], buf[7])); 356 357 humidity_tick = (buf[2] * 256 + buf[3]) & 0x0fff; 358 359 temp = uthum_sht1x_temp(buf[0], buf[1]); 360 rh = uthum_sht1x_rh(humidity_tick, temp); 361 362 sc->sc_sensor[UTHUM_HUMIDITY].value_cur = rh / 1000; 363 sc->sc_sensor[UTHUM_HUMIDITY].state = ENVSYS_SVALID; 364 break; 365 case UTHUM_TYPE_TEMPER: 366 if (uthum_read_data(sc, CMD_GETTEMP, buf, sizeof(buf), 0) != 0) { 367 DPRINTF(("uthum: data read fail\n")); 368 sc->sc_sensor[UTHUM_TEMP].state = ENVSYS_SINVALID; 369 return; 370 } 371 DPRINTF(("%s: read TEMPER data " 372 "0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x 0x%0x\n", 373 sc->sc_sme->sme_name, buf[0], buf[1], buf[2], buf[3], 374 buf[4], buf[5], buf[6], buf[7])); 375 temp = uthum_temper_temp(buf[0], buf[1]); 376 break; 377 default: 378 /* do nothing */ 379 return; 380 } 381 382 sc->sc_sensor[UTHUM_TEMP].value_cur = (temp * 10000) + 273150000; 383 sc->sc_sensor[UTHUM_TEMP].state = ENVSYS_SVALID; 384 } 385 386 /* return C-degree * 100 value */ 387 int 388 uthum_temper_temp(uint8_t msb, uint8_t lsb) 389 { 390 int val; 391 392 val = (msb << 8) | lsb; 393 if (val >= 32768) { 394 val = val - 65536; 395 } 396 val = (val * 100) >> 8; 397 return val; 398 } 399 400 /* return C-degree * 100 value */ 401 int 402 uthum_sht1x_temp(uint8_t msb, uint8_t lsb) 403 { 404 int val; 405 406 val = ((msb << 8) + lsb) - 4096; 407 return val; 408 } 409 410 /* return %RH * 1000 */ 411 int 412 uthum_sht1x_rh(unsigned int ticks, int temp) 413 { 414 int rh_l, rh; 415 416 rh_l = (-40000 + 405 * ticks) - ((7 * ticks * ticks) / 250); 417 rh = ((temp - 2500) * (1 + (ticks >> 7)) + rh_l) / 10; 418 return rh; 419 } 420
Indexes created Wed Sep 24 15:09:51 GMT 2025