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  *  - UNI-T UT108: ?
  55  *  - UNI-T UT109: ?
  56  *  - UNI-T UT30A: ?
  57  *  - UNI-T UT30E: ?
  58  *  - UNI-T UT60E: Fortune Semiconductor FS9721_LP3
  59  *  - UNI-T UT60G: ?
  60  *  - UNI-T UT61B: ?
  61  *  - UNI-T UT61C: ?
  62  *  - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4
  63  *  - UNI-T UT61E: Cyrustek ES51922
  64  *  - UNI-T UT70B: ?
  65  *  - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3
  66  *  - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3
  67  *  - ...
  68  */
  69
  70 static void decode_packet(struct sr_dev_inst *sdi, int dmm, const uint8_t *buf,
  71                           void *info)
  72 {
  73         struct dev_context *devc;
  74         struct sr_datafeed_packet packet;
  75         struct sr_datafeed_analog analog;
  76         float floatval;
  77         int ret;
  78
  79         devc = sdi->priv;
  80         memset(&analog, 0, sizeof(struct sr_datafeed_analog));
  81
  82         /* Parse the protocol packet. */
  83         ret = udmms[dmm].packet_parse(buf, &floatval, &analog, info);
  84         if (ret != SR_OK) {
  85                 sr_dbg("Invalid DMM packet, ignoring.");
  86                 return;
  87         }
  88
  89         /* If this DMM needs additional handling, call the resp. function. */
  90         if (udmms[dmm].dmm_details)
  91                 udmms[dmm].dmm_details(&analog, info);
  92
  93         /* Send a sample packet with one analog value. */
  94         analog.probes = sdi->probes;
  95         analog.num_samples = 1;
  96         analog.data = &floatval;
  97         packet.type = SR_DF_ANALOG;
  98         packet.payload = &analog;
  99         sr_session_send(devc->cb_data, &packet);
 100
 101         /* Increase sample count. */
 102         devc->num_samples++;
 103 }
 104
 105 static int hid_chip_init(struct sr_dev_inst *sdi, uint16_t baudrate)
 106 {
 107         int ret;
 108         uint8_t buf[5];
 109         struct sr_usb_dev_inst *usb;
 110
 111         usb = sdi->conn;
 112
 113         /* Detach kernel drivers which grabbed this device (if any). */
 114         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 115                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 116                 if (ret < 0) {
 117                         sr_err("Failed to detach kernel driver: %s.",
 118                                libusb_error_name(ret));
 119                         return SR_ERR;
 120                 }
 121                 sr_dbg("Successfully detached kernel driver.");
 122         } else {
 123                 sr_dbg("No need to detach a kernel driver.");
 124         }
 125
 126         /* Claim interface 0. */
 127         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 128                 sr_err("Failed to claim interface 0: %s.",
 129                        libusb_error_name(ret));
 130                 return SR_ERR;
 131         }
 132         sr_dbg("Successfully claimed interface 0.");
 133
 134         /* Set data for the HID feature report (e.g. baudrate). */
 135         buf[0] = baudrate & 0xff;        /* Baudrate, LSB */
 136         buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
 137         buf[2] = 0x00;                   /* Unknown/unused (?) */
 138         buf[3] = 0x00;                   /* Unknown/unused (?) */
 139         buf[4] = 0x03;                   /* Unknown, always 0x03. */
 140
 141         /* Send HID feature report to setup the baudrate/chip. */
 142         sr_dbg("Sending initial HID feature report.");
 143         sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)",
 144                 buf[0], buf[1], buf[2], buf[3], buf[4], baudrate);
 145         ret = libusb_control_transfer(
 146                 usb->devhdl, /* libusb device handle */
 147                 LIBUSB_REQUEST_TYPE_CLASS |
 148                 LIBUSB_RECIPIENT_INTERFACE |
 149                 LIBUSB_ENDPOINT_OUT,
 150                 9, /* bRequest: HID set_report */
 151                 0x300, /* wValue: HID feature, report number 0 */
 152                 0, /* wIndex: interface 0 */
 153                 (unsigned char *)&buf, /* payload buffer */
 154                 5, /* wLength: 5 bytes payload */
 155                 1000 /* timeout (ms) */);
 156
 157         if (ret < 0) {
 158                 sr_err("HID feature report error: %s.", libusb_error_name(ret));
 159                 return SR_ERR;
 160         }
 161
 162         if (ret != 5) {
 163                 /* TODO: Handle better by also sending the remaining bytes. */
 164                 sr_err("Short packet: sent %d/5 bytes.", ret);
 165                 return SR_ERR;
 166         }
 167
 168         sr_dbg("Successfully sent initial HID feature report.");
 169
 170         return SR_OK;
 171 }
 172
 173 static void log_8byte_chunk(const uint8_t *buf)
 174 {
 175         sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
 176                 "(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
 177                 buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
 178 }
 179
 180 static void log_dmm_packet(const uint8_t *buf)
 181 {
 182         sr_dbg("DMM packet:   %02x %02x %02x %02x %02x %02x %02x"
 183                " %02x %02x %02x %02x %02x %02x %02x",
 184                buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
 185                buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
 186 }
 187
 188 static int get_and_handle_data(struct sr_dev_inst *sdi, int dmm, void *info)
 189 {
 190         struct dev_context *devc;
 191         uint8_t buf[CHUNK_SIZE], *pbuf;
 192         int i, ret, len, num_databytes_in_chunk;
 193         struct sr_usb_dev_inst *usb;
 194
 195         devc = sdi->priv;
 196         usb = sdi->conn;
 197         pbuf = devc->protocol_buf;
 198
 199         /* On the first run, we need to init the HID chip. */
 200         if (devc->first_run) {
 201                 if ((ret = hid_chip_init(sdi, udmms[dmm].baudrate)) != SR_OK) {
 202                         sr_err("HID chip init failed: %d.", ret);
 203                         return SR_ERR;
 204                 }
 205                 memset(pbuf, 0x00, DMM_BUFSIZE);
 206                 devc->first_run = FALSE;
 207         }
 208
 209         memset(&buf, 0x00, CHUNK_SIZE);
 210
 211         /* Get data from EP2 using an interrupt transfer. */
 212         ret = libusb_interrupt_transfer(
 213                 usb->devhdl, /* libusb device handle */
 214                 LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */
 215                 (unsigned char *)&buf, /* receive buffer */
 216                 CHUNK_SIZE, /* wLength */
 217                 &len, /* actually received byte count */
 218                 1000 /* timeout (ms) */);
 219
 220         if (ret < 0) {
 221                 sr_err("USB receive error: %s.", libusb_error_name(ret));
 222                 return SR_ERR;
 223         }
 224
 225         if (len != CHUNK_SIZE) {
 226                 sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
 227                 /* TODO: Print the bytes? */
 228                 return SR_ERR;
 229         }
 230
 231         log_8byte_chunk((const uint8_t *)&buf);
 232
 233         /* If there are no data bytes just return (without error). */
 234         if (buf[0] == 0xf0)
 235                 return SR_OK;
 236
 237         devc->bufoffset = 0;
 238
 239         /* Append the 1-7 data bytes of this chunk to pbuf. */
 240         num_databytes_in_chunk = buf[0] & 0x0f;
 241         for (i = 0; i < num_databytes_in_chunk; i++)
 242                 pbuf[devc->buflen++] = buf[1 + i];
 243
 244         /* Now look for packets in that data. */
 245         while ((devc->buflen - devc->bufoffset) >= udmms[dmm].packet_size) {
 246                 if (udmms[dmm].packet_valid(pbuf + devc->bufoffset)) {
 247                         log_dmm_packet(pbuf + devc->bufoffset);
 248                         decode_packet(sdi, dmm, pbuf + devc->bufoffset, info);
 249                         devc->bufoffset += udmms[dmm].packet_size;
 250                 } else {
 251                         devc->bufoffset++;
 252                 }
 253         }
 254
 255         /* Move remaining bytes to beginning of buffer. */
 256         for (i = 0; i < devc->buflen - devc->bufoffset; i++)
 257                 pbuf[i] = pbuf[devc->bufoffset + i];
 258         devc->buflen -= devc->bufoffset;
 259
 260         return SR_OK;
 261 }
 262
 263 static int receive_data(int fd, int revents, int dmm, void *info, void *cb_data)
 264 {
 265         int ret;
 266         struct sr_dev_inst *sdi;
 267         struct dev_context *devc;
 268
 269         (void)fd;
 270         (void)revents;
 271
 272         sdi = cb_data;
 273         devc = sdi->priv;
 274
 275         if ((ret = get_and_handle_data(sdi, dmm, info)) != SR_OK)
 276                 return FALSE;
 277
 278         /* Abort acquisition if we acquired enough samples. */
 279         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 280                 sr_info("Requested number of samples reached.");
 281                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 282         }
 283
 284         return TRUE;
 285 }
 286
 287 #define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
 288 SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
 289         struct DMM_DRIVER##_info info; \
 290         return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
 291
 292 /* Driver-specific receive_data() wrappers */
 293 RECEIVE_DATA(UNI_T_UT61D, fs9922)
 294 RECEIVE_DATA(UNI_T_UT61E, es51922)
 295 RECEIVE_DATA(VOLTCRAFT_VC820, fs9721)
 296 RECEIVE_DATA(VOLTCRAFT_VC840, fs9721)