1 /* $OpenBSD: ugold.c,v 1.7 2014/12/11 18:39:27 mpi Exp $ */ 2 3 /* 4 * Copyright (c) 2013 Takayoshi SASANO <sasano@openbsd.org> 5 * Copyright (c) 2013 Martin Pieuchot <mpi@openbsd.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 Microdia's HID based TEMPer Temperature sensor */ 21 22 #include <sys/cdefs.h> 23 __FBSDID("$FreeBSD$"); 24 25 #include <sys/stdint.h> 26 #include <sys/stddef.h> 27 #include <sys/param.h> 28 #include <sys/queue.h> 29 #include <sys/types.h> 30 #include <sys/systm.h> 31 #include <sys/kernel.h> 32 #include <sys/bus.h> 33 #include <sys/module.h> 34 #include <sys/lock.h> 35 #include <sys/mutex.h> 36 #include <sys/condvar.h> 37 #include <sys/sysctl.h> 38 #include <sys/sx.h> 39 #include <sys/unistd.h> 40 #include <sys/callout.h> 41 #include <sys/malloc.h> 42 #include <sys/priv.h> 43 #include <sys/conf.h> 44 45 #include <dev/usb/usb.h> 46 #include <dev/usb/usbdi.h> 47 #include <dev/usb/usbhid.h> 48 #include <dev/usb/usb_process.h> 49 #include <dev/usb/usbdi_util.h> 50 #include "usbdevs.h" 51 52 #define USB_DEBUG_VAR usb_debug 53 #include <dev/usb/usb_debug.h> 54 55 #define UGOLD_INNER 0 56 #define UGOLD_OUTER 1 57 #define UGOLD_MAX_SENSORS 2 58 59 #define UGOLD_CMD_DATA 0x80 60 #define UGOLD_CMD_INIT 0x82 61 62 enum { 63 UGOLD_INTR_DT, 64 UGOLD_N_TRANSFER, 65 }; 66 67 /* 68 * This driver only uses two of the three known commands for the 69 * TEMPerV1.2 device. 70 * 71 * The first byte of the answer corresponds to the command and the 72 * second one seems to be the size (in bytes) of the answer. 73 * 74 * The device always sends 8 bytes and if the length of the answer 75 * is less than that, it just leaves the last bytes untouched. That 76 * is why most of the time the last n bytes of the answers are the 77 * same. 78 * 79 * The third command below seems to generate two answers with a 80 * string corresponding to the device, for example: 81 * 'TEMPer1F' and '1.1Per1F' (here Per1F is repeated). 82 */ 83 static uint8_t cmd_data[8] = {0x01, 0x80, 0x33, 0x01, 0x00, 0x00, 0x00, 0x00}; 84 static uint8_t cmd_init[8] = {0x01, 0x82, 0x77, 0x01, 0x00, 0x00, 0x00, 0x00}; 85 86 #if 0 87 static uint8_t cmd_type[8] = {0x01, 0x86, 0xff, 0x01, 0x00, 0x00, 0x00, 0x00}; 88 89 #endif 90 91 struct ugold_softc; 92 struct ugold_readout_msg { 93 struct usb_proc_msg hdr; 94 struct ugold_softc *sc; 95 }; 96 97 struct ugold_softc { 98 struct usb_device *sc_udev; 99 struct usb_xfer *sc_xfer[UGOLD_N_TRANSFER]; 100 101 struct callout sc_callout; 102 struct mtx sc_mtx; 103 struct ugold_readout_msg sc_readout_msg[2]; 104 105 int sc_num_sensors; 106 int sc_sensor[UGOLD_MAX_SENSORS]; 107 int sc_calib[UGOLD_MAX_SENSORS]; 108 int sc_valid[UGOLD_MAX_SENSORS]; 109 uint8_t sc_report_id; 110 uint8_t sc_iface_index[2]; 111 }; 112 113 /* prototypes */ 114 115 static device_probe_t ugold_probe; 116 static device_attach_t ugold_attach; 117 static device_detach_t ugold_detach; 118 119 static usb_proc_callback_t ugold_readout_msg; 120 121 static usb_callback_t ugold_intr_callback; 122 123 static devclass_t ugold_devclass; 124 125 static device_method_t ugold_methods[] = { 126 DEVMETHOD(device_probe, ugold_probe), 127 DEVMETHOD(device_attach, ugold_attach), 128 DEVMETHOD(device_detach, ugold_detach), 129 130 DEVMETHOD_END 131 }; 132 133 static driver_t ugold_driver = { 134 .name = "ugold", 135 .methods = ugold_methods, 136 .size = sizeof(struct ugold_softc), 137 }; 138 139 DRIVER_MODULE(ugold, uhub, ugold_driver, ugold_devclass, NULL, NULL); 140 MODULE_DEPEND(ugold, usb, 1, 1, 1); 141 MODULE_VERSION(ugold, 1); 142 143 static const struct usb_config ugold_config[UGOLD_N_TRANSFER] = { 144 145 [UGOLD_INTR_DT] = { 146 .type = UE_INTERRUPT, 147 .endpoint = UE_ADDR_ANY, 148 .direction = UE_DIR_IN, 149 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 150 .bufsize = 0, /* use wMaxPacketSize */ 151 .callback = &ugold_intr_callback, 152 .if_index = 1, 153 }, 154 }; 155 156 static const STRUCT_USB_HOST_ID ugold_devs[] = { 157 {USB_VPI(USB_VENDOR_CHICONY2, USB_PRODUCT_CHICONY2_TEMPER, 0)}, 158 }; 159 160 static void 161 ugold_timeout(void *arg) 162 { 163 struct ugold_softc *sc = arg; 164 165 usb_proc_explore_lock(sc->sc_udev); 166 (void)usb_proc_explore_msignal(sc->sc_udev, 167 &sc->sc_readout_msg[0], &sc->sc_readout_msg[1]); 168 usb_proc_explore_unlock(sc->sc_udev); 169 170 callout_reset(&sc->sc_callout, 6 * hz, &ugold_timeout, sc); 171 } 172 173 static int 174 ugold_probe(device_t dev) 175 { 176 struct usb_attach_arg *uaa; 177 178 uaa = device_get_ivars(dev); 179 if (uaa->usb_mode != USB_MODE_HOST) 180 return (ENXIO); 181 if (uaa->info.bInterfaceClass != UICLASS_HID) 182 return (ENXIO); 183 if (uaa->info.bIfaceIndex != 0) 184 return (ENXIO); 185 186 return (usbd_lookup_id_by_uaa(ugold_devs, sizeof(ugold_devs), uaa)); 187 } 188 189 static int 190 ugold_attach(device_t dev) 191 { 192 struct ugold_softc *sc = device_get_softc(dev); 193 struct usb_attach_arg *uaa = device_get_ivars(dev); 194 struct sysctl_oid *sensor_tree; 195 uint16_t d_len; 196 void *d_ptr; 197 int error; 198 int i; 199 200 sc->sc_udev = uaa->device; 201 sc->sc_readout_msg[0].hdr.pm_callback = &ugold_readout_msg; 202 sc->sc_readout_msg[0].sc = sc; 203 sc->sc_readout_msg[1].hdr.pm_callback = &ugold_readout_msg; 204 sc->sc_readout_msg[1].sc = sc; 205 sc->sc_iface_index[0] = uaa->info.bIfaceIndex; 206 sc->sc_iface_index[1] = uaa->info.bIfaceIndex + 1; 207 208 device_set_usb_desc(dev); 209 mtx_init(&sc->sc_mtx, "ugold lock", NULL, MTX_DEF | MTX_RECURSE); 210 callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0); 211 212 /* grab all interfaces from other drivers */ 213 for (i = 0;; i++) { 214 if (i == uaa->info.bIfaceIndex) 215 continue; 216 if (usbd_get_iface(uaa->device, i) == NULL) 217 break; 218 219 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex); 220 } 221 222 /* figure out report ID */ 223 error = usbd_req_get_hid_desc(uaa->device, NULL, 224 &d_ptr, &d_len, M_TEMP, uaa->info.bIfaceIndex); 225 226 if (error) 227 goto detach; 228 229 (void)hid_report_size(d_ptr, d_len, hid_input, &sc->sc_report_id); 230 231 free(d_ptr, M_TEMP); 232 233 error = usbd_transfer_setup(uaa->device, 234 sc->sc_iface_index, sc->sc_xfer, ugold_config, 235 UGOLD_N_TRANSFER, sc, &sc->sc_mtx); 236 if (error) 237 goto detach; 238 239 sensor_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev), 240 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "sensors", 241 CTLFLAG_RD, NULL, ""); 242 243 if (sensor_tree == NULL) { 244 error = ENOMEM; 245 goto detach; 246 } 247 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev), 248 SYSCTL_CHILDREN(sensor_tree), 249 OID_AUTO, "inner", CTLFLAG_RD, &sc->sc_sensor[UGOLD_INNER], 0, 250 "Inner temperature in microCelcius"); 251 252 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev), 253 SYSCTL_CHILDREN(sensor_tree), 254 OID_AUTO, "inner_valid", CTLFLAG_RD, &sc->sc_valid[UGOLD_INNER], 0, 255 "Inner temperature is valid"); 256 257 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev), 258 SYSCTL_CHILDREN(sensor_tree), 259 OID_AUTO, "inner_calib", CTLFLAG_RWTUN, &sc->sc_calib[UGOLD_INNER], 0, 260 "Inner calibration temperature in microCelcius"); 261 262 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev), 263 SYSCTL_CHILDREN(sensor_tree), 264 OID_AUTO, "outer", CTLFLAG_RD, &sc->sc_sensor[UGOLD_OUTER], 0, 265 "Outer temperature in microCelcius"); 266 267 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev), 268 SYSCTL_CHILDREN(sensor_tree), 269 OID_AUTO, "outer_calib", CTLFLAG_RWTUN, &sc->sc_calib[UGOLD_OUTER], 0, 270 "Outer calibration temperature in microCelcius"); 271 272 SYSCTL_ADD_INT(device_get_sysctl_ctx(dev), 273 SYSCTL_CHILDREN(sensor_tree), 274 OID_AUTO, "outer_valid", CTLFLAG_RD, &sc->sc_valid[UGOLD_OUTER], 0, 275 "Outer temperature is valid"); 276 277 mtx_lock(&sc->sc_mtx); 278 usbd_transfer_start(sc->sc_xfer[UGOLD_INTR_DT]); 279 ugold_timeout(sc); 280 mtx_unlock(&sc->sc_mtx); 281 282 return (0); 283 284 detach: 285 DPRINTF("error=%s\n", usbd_errstr(error)); 286 ugold_detach(dev); 287 return (error); 288 } 289 290 static int 291 ugold_detach(device_t dev) 292 { 293 struct ugold_softc *sc = device_get_softc(dev); 294 295 callout_drain(&sc->sc_callout); 296 297 usb_proc_explore_lock(sc->sc_udev); 298 usb_proc_explore_mwait(sc->sc_udev, 299 &sc->sc_readout_msg[0], &sc->sc_readout_msg[1]); 300 usb_proc_explore_unlock(sc->sc_udev); 301 302 usbd_transfer_unsetup(sc->sc_xfer, UGOLD_N_TRANSFER); 303 304 mtx_destroy(&sc->sc_mtx); 305 306 return (0); 307 } 308 309 static int 310 ugold_ds75_temp(uint8_t msb, uint8_t lsb) 311 { 312 /* DS75: 12bit precision mode : 0.0625 degrees Celsius ticks */ 313 /* NOTE: MSB has a sign bit for negative temperatures */ 314 int32_t temp = (msb << 24) | ((lsb & 0xF0) << 16); 315 return (((int64_t)temp * (int64_t)1000000LL) >> 24); 316 } 317 318 319 static void 320 ugold_intr_callback(struct usb_xfer *xfer, usb_error_t error) 321 { 322 struct ugold_softc *sc = usbd_xfer_softc(xfer); 323 struct usb_page_cache *pc; 324 uint8_t buf[8]; 325 int temp; 326 int len; 327 328 usbd_xfer_status(xfer, &len, NULL, NULL, NULL); 329 330 switch (USB_GET_STATE(xfer)) { 331 case USB_ST_TRANSFERRED: 332 memset(buf, 0, sizeof(buf)); 333 334 pc = usbd_xfer_get_frame(xfer, 0); 335 usbd_copy_out(pc, 0, buf, MIN(len, sizeof(buf))); 336 337 switch (buf[0]) { 338 case UGOLD_CMD_INIT: 339 if (sc->sc_num_sensors) 340 break; 341 342 sc->sc_num_sensors = MIN(buf[1], UGOLD_MAX_SENSORS) /* XXX */ ; 343 344 DPRINTF("%d sensor%s type ds75/12bit (temperature)\n", 345 sc->sc_num_sensors, (sc->sc_num_sensors == 1) ? "" : "s"); 346 break; 347 case UGOLD_CMD_DATA: 348 switch (buf[1]) { 349 case 4: 350 temp = ugold_ds75_temp(buf[4], buf[5]); 351 sc->sc_sensor[UGOLD_OUTER] = temp + sc->sc_calib[UGOLD_OUTER]; 352 sc->sc_valid[UGOLD_OUTER] = 1; 353 /* FALLTHROUGH */ 354 case 2: 355 temp = ugold_ds75_temp(buf[2], buf[3]); 356 sc->sc_sensor[UGOLD_INNER] = temp + sc->sc_calib[UGOLD_INNER]; 357 sc->sc_valid[UGOLD_INNER] = 1; 358 break; 359 default: 360 DPRINTF("invalid data length (%d bytes)\n", buf[1]); 361 } 362 break; 363 default: 364 DPRINTF("unknown command 0x%02x\n", buf[0]); 365 break; 366 } 367 /* FALLTHROUGH */ 368 case USB_ST_SETUP: 369 tr_setup: 370 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 371 usbd_transfer_submit(xfer); 372 break; 373 default: /* Error */ 374 if (error != USB_ERR_CANCELLED) { 375 /* try clear stall first */ 376 usbd_xfer_set_stall(xfer); 377 goto tr_setup; 378 } 379 break; 380 } 381 } 382 383 static int 384 ugold_issue_cmd(struct ugold_softc *sc, uint8_t *cmd, int len) 385 { 386 return (usbd_req_set_report(sc->sc_udev, &sc->sc_mtx, cmd, len, 387 sc->sc_iface_index[1], UHID_OUTPUT_REPORT, sc->sc_report_id)); 388 } 389 390 static void 391 ugold_readout_msg(struct usb_proc_msg *pm) 392 { 393 struct ugold_softc *sc = ((struct ugold_readout_msg *)pm)->sc; 394 395 usb_proc_explore_unlock(sc->sc_udev); 396 397 mtx_lock(&sc->sc_mtx); 398 if (sc->sc_num_sensors == 0) 399 ugold_issue_cmd(sc, cmd_init, sizeof(cmd_init)); 400 401 ugold_issue_cmd(sc, cmd_data, sizeof(cmd_data)); 402 mtx_unlock(&sc->sc_mtx); 403 404 usb_proc_explore_lock(sc->sc_udev); 405 } 406