sys/dev/usb/misc/ugold.c

   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 static const STRUCT_USB_HOST_ID ugold_devs[] = {
 140         {USB_VPI(USB_VENDOR_CHICONY2, USB_PRODUCT_CHICONY2_TEMPER, 0)},
 141 };
 142
 143 DRIVER_MODULE(ugold, uhub, ugold_driver, ugold_devclass, NULL, NULL);
 144 MODULE_DEPEND(ugold, usb, 1, 1, 1);
 145 MODULE_VERSION(ugold, 1);
 146 USB_PNP_HOST_INFO(ugold_devs);
 147
 148 static const struct usb_config ugold_config[UGOLD_N_TRANSFER] = {
 149
 150         [UGOLD_INTR_DT] = {
 151                 .type = UE_INTERRUPT,
 152                 .endpoint = UE_ADDR_ANY,
 153                 .direction = UE_DIR_IN,
 154                 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
 155                 .bufsize = 0,           /* use wMaxPacketSize */
 156                 .callback = &ugold_intr_callback,
 157                 .if_index = 1,
 158         },
 159 };
 160
 161 static void
 162 ugold_timeout(void *arg)
 163 {
 164         struct ugold_softc *sc = arg;
 165
 166         usb_proc_explore_lock(sc->sc_udev);
 167         (void)usb_proc_explore_msignal(sc->sc_udev,
 168             &sc->sc_readout_msg[0], &sc->sc_readout_msg[1]);
 169         usb_proc_explore_unlock(sc->sc_udev);
 170
 171         callout_reset(&sc->sc_callout, 6 * hz, &ugold_timeout, sc);
 172 }
 173
 174 static int
 175 ugold_probe(device_t dev)
 176 {
 177         struct usb_attach_arg *uaa;
 178
 179         uaa = device_get_ivars(dev);
 180         if (uaa->usb_mode != USB_MODE_HOST)
 181                 return (ENXIO);
 182         if (uaa->info.bInterfaceClass != UICLASS_HID)
 183                 return (ENXIO);
 184         if (uaa->info.bIfaceIndex != 0)
 185                 return (ENXIO);
 186
 187         return (usbd_lookup_id_by_uaa(ugold_devs, sizeof(ugold_devs), uaa));
 188 }
 189
 190 static int
 191 ugold_attach(device_t dev)
 192 {
 193         struct ugold_softc *sc = device_get_softc(dev);
 194         struct usb_attach_arg *uaa = device_get_ivars(dev);
 195         struct sysctl_oid *sensor_tree;
 196         uint16_t d_len;
 197         void *d_ptr;
 198         int error;
 199         int i;
 200
 201         sc->sc_udev = uaa->device;
 202         sc->sc_readout_msg[0].hdr.pm_callback = &ugold_readout_msg;
 203         sc->sc_readout_msg[0].sc = sc;
 204         sc->sc_readout_msg[1].hdr.pm_callback = &ugold_readout_msg;
 205         sc->sc_readout_msg[1].sc = sc;
 206         sc->sc_iface_index[0] = uaa->info.bIfaceIndex;
 207         sc->sc_iface_index[1] = uaa->info.bIfaceIndex + 1;
 208
 209         device_set_usb_desc(dev);
 210         mtx_init(&sc->sc_mtx, "ugold lock", NULL, MTX_DEF | MTX_RECURSE);
 211         callout_init_mtx(&sc->sc_callout, &sc->sc_mtx, 0);
 212
 213         /* grab all interfaces from other drivers */
 214         for (i = 0;; i++) {
 215                 if (i == uaa->info.bIfaceIndex)
 216                         continue;
 217                 if (usbd_get_iface(uaa->device, i) == NULL)
 218                         break;
 219
 220                 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
 221         }
 222
 223         /* figure out report ID */
 224         error = usbd_req_get_hid_desc(uaa->device, NULL,
 225             &d_ptr, &d_len, M_TEMP, uaa->info.bIfaceIndex);
 226
 227         if (error)
 228                 goto detach;
 229
 230         (void)hid_report_size(d_ptr, d_len, hid_input, &sc->sc_report_id);
 231
 232         free(d_ptr, M_TEMP);
 233
 234         error = usbd_transfer_setup(uaa->device,
 235             sc->sc_iface_index, sc->sc_xfer, ugold_config,
 236             UGOLD_N_TRANSFER, sc, &sc->sc_mtx);
 237         if (error)
 238                 goto detach;
 239
 240         sensor_tree = SYSCTL_ADD_NODE(device_get_sysctl_ctx(dev),
 241             SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO, "sensors",
 242             CTLFLAG_RD, NULL, "");
 243
 244         if (sensor_tree == NULL) {
 245                 error = ENOMEM;
 246                 goto detach;
 247         }
 248         SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 249             SYSCTL_CHILDREN(sensor_tree),
 250             OID_AUTO, "inner", CTLFLAG_RD, &sc->sc_sensor[UGOLD_INNER], 0,
 251             "Inner temperature in microCelcius");
 252
 253         SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 254             SYSCTL_CHILDREN(sensor_tree),
 255             OID_AUTO, "inner_valid", CTLFLAG_RD, &sc->sc_valid[UGOLD_INNER], 0,
 256             "Inner temperature is valid");
 257
 258         SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 259             SYSCTL_CHILDREN(sensor_tree),
 260             OID_AUTO, "inner_calib", CTLFLAG_RWTUN, &sc->sc_calib[UGOLD_INNER], 0,
 261             "Inner calibration temperature in microCelcius");
 262
 263         SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 264             SYSCTL_CHILDREN(sensor_tree),
 265             OID_AUTO, "outer", CTLFLAG_RD, &sc->sc_sensor[UGOLD_OUTER], 0,
 266             "Outer temperature in microCelcius");
 267
 268         SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 269             SYSCTL_CHILDREN(sensor_tree),
 270             OID_AUTO, "outer_calib", CTLFLAG_RWTUN, &sc->sc_calib[UGOLD_OUTER], 0,
 271             "Outer calibration temperature in microCelcius");
 272
 273         SYSCTL_ADD_INT(device_get_sysctl_ctx(dev),
 274             SYSCTL_CHILDREN(sensor_tree),
 275             OID_AUTO, "outer_valid", CTLFLAG_RD, &sc->sc_valid[UGOLD_OUTER], 0,
 276             "Outer temperature is valid");
 277
 278         mtx_lock(&sc->sc_mtx);
 279         usbd_transfer_start(sc->sc_xfer[UGOLD_INTR_DT]);
 280         ugold_timeout(sc);
 281         mtx_unlock(&sc->sc_mtx);
 282
 283         return (0);
 284
 285 detach:
 286         DPRINTF("error=%s\n", usbd_errstr(error));
 287         ugold_detach(dev);
 288         return (error);
 289 }
 290
 291 static int
 292 ugold_detach(device_t dev)
 293 {
 294         struct ugold_softc *sc = device_get_softc(dev);
 295
 296         callout_drain(&sc->sc_callout);
 297
 298         usb_proc_explore_lock(sc->sc_udev);
 299         usb_proc_explore_mwait(sc->sc_udev,
 300             &sc->sc_readout_msg[0], &sc->sc_readout_msg[1]);
 301         usb_proc_explore_unlock(sc->sc_udev);
 302
 303         usbd_transfer_unsetup(sc->sc_xfer, UGOLD_N_TRANSFER);
 304
 305         mtx_destroy(&sc->sc_mtx);
 306
 307         return (0);
 308 }
 309
 310 static int
 311 ugold_ds75_temp(uint8_t msb, uint8_t lsb)
 312 {
 313         /* DS75: 12bit precision mode : 0.0625 degrees Celsius ticks */
 314         /* NOTE: MSB has a sign bit for negative temperatures */
 315         int32_t temp = (msb << 24) | ((lsb & 0xF0) << 16);
 316         return (((int64_t)temp * (int64_t)1000000LL) >> 24);
 317 }
 318
 319
 320 static void
 321 ugold_intr_callback(struct usb_xfer *xfer, usb_error_t error)
 322 {
 323         struct ugold_softc *sc = usbd_xfer_softc(xfer);
 324         struct usb_page_cache *pc;
 325         uint8_t buf[8];
 326         int temp;
 327         int len;
 328
 329         usbd_xfer_status(xfer, &len, NULL, NULL, NULL);
 330
 331         switch (USB_GET_STATE(xfer)) {
 332         case USB_ST_TRANSFERRED:
 333                 memset(buf, 0, sizeof(buf));
 334
 335                 pc = usbd_xfer_get_frame(xfer, 0);
 336                 usbd_copy_out(pc, 0, buf, MIN(len, sizeof(buf)));
 337
 338                 switch (buf[0]) {
 339                 case UGOLD_CMD_INIT:
 340                         if (sc->sc_num_sensors)
 341                                 break;
 342
 343                         sc->sc_num_sensors = MIN(buf[1], UGOLD_MAX_SENSORS) /* XXX */ ;
 344
 345                         DPRINTF("%d sensor%s type ds75/12bit (temperature)\n",
 346                             sc->sc_num_sensors, (sc->sc_num_sensors == 1) ? "" : "s");
 347                         break;
 348                 case UGOLD_CMD_DATA:
 349                         switch (buf[1]) {
 350                         case 4:
 351                                 temp = ugold_ds75_temp(buf[4], buf[5]);
 352                                 sc->sc_sensor[UGOLD_OUTER] = temp + sc->sc_calib[UGOLD_OUTER];
 353                                 sc->sc_valid[UGOLD_OUTER] = 1;
 354                                 /* FALLTHROUGH */
 355                         case 2:
 356                                 temp = ugold_ds75_temp(buf[2], buf[3]);
 357                                 sc->sc_sensor[UGOLD_INNER] = temp + sc->sc_calib[UGOLD_INNER];
 358                                 sc->sc_valid[UGOLD_INNER] = 1;
 359                                 break;
 360                         default:
 361                                 DPRINTF("invalid data length (%d bytes)\n", buf[1]);
 362                         }
 363                         break;
 364                 default:
 365                         DPRINTF("unknown command 0x%02x\n", buf[0]);
 366                         break;
 367                 }
 368                 /* FALLTHROUGH */
 369         case USB_ST_SETUP:
 370 tr_setup:
 371                 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
 372                 usbd_transfer_submit(xfer);
 373                 break;
 374         default:                        /* Error */
 375                 if (error != USB_ERR_CANCELLED) {
 376                         /* try clear stall first */
 377                         usbd_xfer_set_stall(xfer);
 378                         goto tr_setup;
 379                 }
 380                 break;
 381         }
 382 }
 383
 384 static int
 385 ugold_issue_cmd(struct ugold_softc *sc, uint8_t *cmd, int len)
 386 {
 387         return (usbd_req_set_report(sc->sc_udev, &sc->sc_mtx, cmd, len,
 388             sc->sc_iface_index[1], UHID_OUTPUT_REPORT, sc->sc_report_id));
 389 }
 390
 391 static void
 392 ugold_readout_msg(struct usb_proc_msg *pm)
 393 {
 394         struct ugold_softc *sc = ((struct ugold_readout_msg *)pm)->sc;
 395
 396         usb_proc_explore_unlock(sc->sc_udev);
 397
 398         mtx_lock(&sc->sc_mtx);
 399         if (sc->sc_num_sensors == 0)
 400                 ugold_issue_cmd(sc, cmd_init, sizeof(cmd_init));
 401
 402         ugold_issue_cmd(sc, cmd_data, sizeof(cmd_data));
 403         mtx_unlock(&sc->sc_mtx);
 404
 405         usb_proc_explore_lock(sc->sc_udev);
 406 }