hardware/uni-t-dmm/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <string.h>
  22 #include <glib.h>
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 /*
  28  * Driver for various UNI-T multimeters (and rebranded ones).
  29  *
  30  * Most UNI-T DMMs can be used with two (three) different PC interface cables:
  31  *  - The UT-D04 USB/HID cable, old version with Hoitek HE2325U chip.
  32  *  - The UT-D04 USB/HID cable, new version with WCH CH9325 chip.
  33  *  - The UT-D02 RS232 cable.
  34  *
  35  * This driver is meant to support all USB/HID cables, and various DMMs that
  36  * can be attached to a PC via these cables. Currently only the UT-D04 cable
  37  * (new version) is supported/tested.
  38  * The UT-D02 RS232 cable is handled by the 'serial-dmm' driver.
  39  *
  40  * The data for one DMM packet (e.g. 14 bytes if the respective DMM uses a
  41  * Fortune Semiconductor FS9922-DMM4 chip) is spread across multiple
  42  * 8-byte chunks.
  43  *
  44  * An 8-byte chunk looks like this:
  45  *  - Byte 0: 0xfz, where z is the number of actual data bytes in this chunk.
  46  *  - Bytes 1-7: z data bytes, the rest of the bytes should be ignored.
  47  *
  48  * Example:
  49  *  f0 00 00 00 00 00 00 00 (no data bytes)
  50  *  f2 55 77 00 00 00 00 00 (2 data bytes, 0x55 and 0x77)
  51  *  f1 d1 00 00 00 00 00 00 (1 data byte, 0xd1)
  52  *
  53  * Chips and serial settings used in UNI-T DMMs (and rebranded ones):
  54  *  - Tecpel DMM-8060: ? (very likely Fortune Semiconductor FS9721_LP3)
  55  *  - Tecpel DMM-8061: ? (very likely Fortune Semiconductor FS9721_LP3)
  56  *  - UNI-T UT108: ?
  57  *  - UNI-T UT109: ?
  58  *  - UNI-T UT30A: ?
  59  *  - UNI-T UT30E: ?
  60  *  - UNI-T UT60E: Fortune Semiconductor FS9721_LP3
  61  *  - UNI-T UT60G: ?
  62  *  - UNI-T UT61B: ?
  63  *  - UNI-T UT61C: ?
  64  *  - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4
  65  *  - UNI-T UT61E: Cyrustek ES51922
  66  *  - UNI-T UT70B: ?
  67  *  - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3
  68  *  - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3
  69  *  - ...
  70  */
  71
  72 static void decode_packet(struct sr_dev_inst *sdi, int dmm, const uint8_t *buf,
  73                           void *info)
  74 {
  75         struct dev_context *devc;
  76         struct sr_datafeed_packet packet;
  77         struct sr_datafeed_analog analog;
  78         float floatval;
  79         int ret;
  80
  81         devc = sdi->priv;
  82         memset(&analog, 0, sizeof(struct sr_datafeed_analog));
  83
  84         /* Parse the protocol packet. */
  85         ret = udmms[dmm].packet_parse(buf, &floatval, &analog, info);
  86         if (ret != SR_OK) {
  87                 sr_dbg("Invalid DMM packet, ignoring.");
  88                 return;
  89         }
  90
  91         /* If this DMM needs additional handling, call the resp. function. */
  92         if (udmms[dmm].dmm_details)
  93                 udmms[dmm].dmm_details(&analog, info);
  94
  95         /* Send a sample packet with one analog value. */
  96         analog.probes = sdi->probes;
  97         analog.num_samples = 1;
  98         analog.data = &floatval;
  99         packet.type = SR_DF_ANALOG;
 100         packet.payload = &analog;
 101         sr_session_send(devc->cb_data, &packet);
 102
 103         /* Increase sample count. */
 104         devc->num_samples++;
 105 }
 106
 107 static int hid_chip_init(struct sr_dev_inst *sdi, uint16_t baudrate)
 108 {
 109         int ret;
 110         uint8_t buf[5];
 111         struct sr_usb_dev_inst *usb;
 112
 113         usb = sdi->conn;
 114
 115         /* Detach kernel drivers which grabbed this device (if any). */
 116         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 117                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 118                 if (ret < 0) {
 119                         sr_err("Failed to detach kernel driver: %s.",
 120                                libusb_error_name(ret));
 121                         return SR_ERR;
 122                 }
 123                 sr_dbg("Successfully detached kernel driver.");
 124         } else {
 125                 sr_dbg("No need to detach a kernel driver.");
 126         }
 127
 128         /* Claim interface 0. */
 129         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 130                 sr_err("Failed to claim interface 0: %s.",
 131                        libusb_error_name(ret));
 132                 return SR_ERR;
 133         }
 134         sr_dbg("Successfully claimed interface 0.");
 135
 136         /* Set data for the HID feature report (e.g. baudrate). */
 137         buf[0] = baudrate & 0xff;        /* Baudrate, LSB */
 138         buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
 139         buf[2] = 0x00;                   /* Unknown/unused (?) */
 140         buf[3] = 0x00;                   /* Unknown/unused (?) */
 141         buf[4] = 0x03;                   /* Unknown, always 0x03. */
 142
 143         /* Send HID feature report to setup the baudrate/chip. */
 144         sr_dbg("Sending initial HID feature report.");
 145         sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)",
 146                 buf[0], buf[1], buf[2], buf[3], buf[4], baudrate);
 147         ret = libusb_control_transfer(
 148                 usb->devhdl, /* libusb device handle */
 149                 LIBUSB_REQUEST_TYPE_CLASS |
 150                 LIBUSB_RECIPIENT_INTERFACE |
 151                 LIBUSB_ENDPOINT_OUT,
 152                 9, /* bRequest: HID set_report */
 153                 0x300, /* wValue: HID feature, report number 0 */
 154                 0, /* wIndex: interface 0 */
 155                 (unsigned char *)&buf, /* payload buffer */
 156                 5, /* wLength: 5 bytes payload */
 157                 1000 /* timeout (ms) */);
 158
 159         if (ret < 0) {
 160                 sr_err("HID feature report error: %s.", libusb_error_name(ret));
 161                 return SR_ERR;
 162         }
 163
 164         if (ret != 5) {
 165                 /* TODO: Handle better by also sending the remaining bytes. */
 166                 sr_err("Short packet: sent %d/5 bytes.", ret);
 167                 return SR_ERR;
 168         }
 169
 170         sr_dbg("Successfully sent initial HID feature report.");
 171
 172         return SR_OK;
 173 }
 174
 175 static void log_8byte_chunk(const uint8_t *buf)
 176 {
 177         sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
 178                 "(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
 179                 buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
 180 }
 181
 182 static void log_dmm_packet(const uint8_t *buf)
 183 {
 184         sr_dbg("DMM packet:   %02x %02x %02x %02x %02x %02x %02x"
 185                " %02x %02x %02x %02x %02x %02x %02x",
 186                buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
 187                buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
 188 }
 189
 190 static int get_and_handle_data(struct sr_dev_inst *sdi, int dmm, void *info)
 191 {
 192         struct dev_context *devc;
 193         uint8_t buf[CHUNK_SIZE], *pbuf;
 194         int i, ret, len, num_databytes_in_chunk;
 195         struct sr_usb_dev_inst *usb;
 196
 197         devc = sdi->priv;
 198         usb = sdi->conn;
 199         pbuf = devc->protocol_buf;
 200
 201         /* On the first run, we need to init the HID chip. */
 202         if (devc->first_run) {
 203                 if ((ret = hid_chip_init(sdi, udmms[dmm].baudrate)) != SR_OK) {
 204                         sr_err("HID chip init failed: %d.", ret);
 205                         return SR_ERR;
 206                 }
 207                 memset(pbuf, 0x00, DMM_BUFSIZE);
 208                 devc->first_run = FALSE;
 209         }
 210
 211         memset(&buf, 0x00, CHUNK_SIZE);
 212
 213         /* Get data from EP2 using an interrupt transfer. */
 214         ret = libusb_interrupt_transfer(
 215                 usb->devhdl, /* libusb device handle */
 216                 LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */
 217                 (unsigned char *)&buf, /* receive buffer */
 218                 CHUNK_SIZE, /* wLength */
 219                 &len, /* actually received byte count */
 220                 1000 /* timeout (ms) */);
 221
 222         if (ret < 0) {
 223                 sr_err("USB receive error: %s.", libusb_error_name(ret));
 224                 return SR_ERR;
 225         }
 226
 227         if (len != CHUNK_SIZE) {
 228                 sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
 229                 /* TODO: Print the bytes? */
 230                 return SR_ERR;
 231         }
 232
 233         log_8byte_chunk((const uint8_t *)&buf);
 234
 235         /* If there are no data bytes just return (without error). */
 236         if (buf[0] == 0xf0)
 237                 return SR_OK;
 238
 239         devc->bufoffset = 0;
 240
 241         /* Append the 1-7 data bytes of this chunk to pbuf. */
 242         num_databytes_in_chunk = buf[0] & 0x0f;
 243         for (i = 0; i < num_databytes_in_chunk; i++)
 244                 pbuf[devc->buflen++] = buf[1 + i];
 245
 246         /* Now look for packets in that data. */
 247         while ((devc->buflen - devc->bufoffset) >= udmms[dmm].packet_size) {
 248                 if (udmms[dmm].packet_valid(pbuf + devc->bufoffset)) {
 249                         log_dmm_packet(pbuf + devc->bufoffset);
 250                         decode_packet(sdi, dmm, pbuf + devc->bufoffset, info);
 251                         devc->bufoffset += udmms[dmm].packet_size;
 252                 } else {
 253                         devc->bufoffset++;
 254                 }
 255         }
 256
 257         /* Move remaining bytes to beginning of buffer. */
 258         for (i = 0; i < devc->buflen - devc->bufoffset; i++)
 259                 pbuf[i] = pbuf[devc->bufoffset + i];
 260         devc->buflen -= devc->bufoffset;
 261
 262         return SR_OK;
 263 }
 264
 265 static int receive_data(int fd, int revents, int dmm, void *info, void *cb_data)
 266 {
 267         int ret;
 268         struct sr_dev_inst *sdi;
 269         struct dev_context *devc;
 270         int64_t time_ms;
 271
 272         (void)fd;
 273         (void)revents;
 274
 275         sdi = cb_data;
 276         devc = sdi->priv;
 277
 278         if ((ret = get_and_handle_data(sdi, dmm, info)) != SR_OK)
 279                 return FALSE;
 280
 281         /* Abort acquisition if we acquired enough samples. */
 282         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 283                 sr_info("Requested number of samples reached.");
 284                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 285         }
 286
 287         if (devc->limit_msec) {
 288                 time_ms = (g_get_monotonic_time() - devc->starttime) / 1000;
 289                 if (time_ms > (int64_t)devc->limit_msec) {
 290                         sr_info("Requested time limit reached.");
 291                         sdi->driver->dev_acquisition_stop(sdi, cb_data);
 292                         return TRUE;
 293                 }
 294         }
 295
 296         return TRUE;
 297 }
 298
 299 #define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
 300 SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
 301         struct DMM_DRIVER##_info info; \
 302         return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
 303
 304 /* Driver-specific receive_data() wrappers */
 305 RECEIVE_DATA(TECPEL_DMM_8060, fs9721)
 306 RECEIVE_DATA(TECPEL_DMM_8061, fs9721)
 307 RECEIVE_DATA(UNI_T_UT61D, fs9922)
 308 RECEIVE_DATA(UNI_T_UT61E, es51922)
 309 RECEIVE_DATA(VOLTCRAFT_VC820, fs9721)
 310 RECEIVE_DATA(VOLTCRAFT_VC840, fs9721)