src/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 extern struct dmm_info udmms[];
  28
  29 /*
  30  * Driver for various UNI-T multimeters (and rebranded ones).
  31  *
  32  * Most UNI-T DMMs can be used with two (three) different PC interface cables:
  33  *  - The UT-D04 USB/HID cable, old version with Hoitek HE2325U chip.
  34  *  - The UT-D04 USB/HID cable, new version with WCH CH9325 chip.
  35  *  - The UT-D02 RS232 cable.
  36  *
  37  * This driver is meant to support all USB/HID cables, and various DMMs that
  38  * can be attached to a PC via these cables. Currently only the UT-D04 cable
  39  * (new version) is supported/tested.
  40  * The UT-D02 RS232 cable is handled by the 'serial-dmm' driver.
  41  *
  42  * The data for one DMM packet (e.g. 14 bytes if the respective DMM uses a
  43  * Fortune Semiconductor FS9922-DMM4 chip) is spread across multiple
  44  * 8-byte chunks.
  45  *
  46  * An 8-byte chunk looks like this:
  47  *  - Byte 0: 0xfz, where z is the number of actual data bytes in this chunk.
  48  *  - Bytes 1-7: z data bytes, the rest of the bytes should be ignored.
  49  *
  50  * Example:
  51  *  f0 00 00 00 00 00 00 00 (no data bytes)
  52  *  f2 55 77 00 00 00 00 00 (2 data bytes, 0x55 and 0x77)
  53  *  f1 d1 00 00 00 00 00 00 (1 data byte, 0xd1)
  54  */
  55
  56 static void decode_packet(struct sr_dev_inst *sdi, int dmm, const uint8_t *buf,
  57                           void *info)
  58 {
  59         struct dev_context *devc;
  60         struct sr_datafeed_packet packet;
  61         struct sr_datafeed_analog analog;
  62         float floatval;
  63         int ret;
  64
  65         devc = sdi->priv;
  66         memset(&analog, 0, sizeof(struct sr_datafeed_analog));
  67
  68         /* Parse the protocol packet. */
  69         ret = udmms[dmm].packet_parse(buf, &floatval, &analog, info);
  70         if (ret != SR_OK) {
  71                 sr_dbg("Invalid DMM packet, ignoring.");
  72                 return;
  73         }
  74
  75         /* If this DMM needs additional handling, call the resp. function. */
  76         if (udmms[dmm].dmm_details)
  77                 udmms[dmm].dmm_details(&analog, info);
  78
  79         /* Send a sample packet with one analog value. */
  80         analog.channels = sdi->channels;
  81         analog.num_samples = 1;
  82         analog.data = &floatval;
  83         packet.type = SR_DF_ANALOG;
  84         packet.payload = &analog;
  85         sr_session_send(devc->cb_data, &packet);
  86
  87         /* Increase sample count. */
  88         devc->num_samples++;
  89 }
  90
  91 static int hid_chip_init(struct sr_dev_inst *sdi, uint16_t baudrate)
  92 {
  93         int ret;
  94         uint8_t buf[5];
  95         struct sr_usb_dev_inst *usb;
  96
  97         usb = sdi->conn;
  98
  99         /* Detach kernel drivers which grabbed this device (if any). */
 100         if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
 101                 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
 102                 if (ret < 0) {
 103                         sr_err("Failed to detach kernel driver: %s.",
 104                                libusb_error_name(ret));
 105                         return SR_ERR;
 106                 }
 107                 sr_dbg("Successfully detached kernel driver.");
 108         } else {
 109                 sr_dbg("No need to detach a kernel driver.");
 110         }
 111
 112         /* Claim interface 0. */
 113         if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
 114                 sr_err("Failed to claim interface 0: %s.",
 115                        libusb_error_name(ret));
 116                 return SR_ERR;
 117         }
 118         sr_dbg("Successfully claimed interface 0.");
 119
 120         /* Set data for the HID feature report (e.g. baudrate). */
 121         buf[0] = baudrate & 0xff;        /* Baudrate, LSB */
 122         buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
 123         buf[2] = 0x00;                   /* Unknown/unused (?) */
 124         buf[3] = 0x00;                   /* Unknown/unused (?) */
 125         buf[4] = 0x03;                   /* Unknown, always 0x03. */
 126
 127         /* Send HID feature report to setup the baudrate/chip. */
 128         sr_dbg("Sending initial HID feature report.");
 129         sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)",
 130                 buf[0], buf[1], buf[2], buf[3], buf[4], baudrate);
 131         ret = libusb_control_transfer(
 132                 usb->devhdl, /* libusb device handle */
 133                 LIBUSB_REQUEST_TYPE_CLASS |
 134                 LIBUSB_RECIPIENT_INTERFACE |
 135                 LIBUSB_ENDPOINT_OUT,
 136                 9, /* bRequest: HID set_report */
 137                 0x300, /* wValue: HID feature, report number 0 */
 138                 0, /* wIndex: interface 0 */
 139                 (unsigned char *)&buf, /* payload buffer */
 140                 5, /* wLength: 5 bytes payload */
 141                 1000 /* timeout (ms) */);
 142
 143         if (ret < 0) {
 144                 sr_err("HID feature report error: %s.", libusb_error_name(ret));
 145                 return SR_ERR;
 146         }
 147
 148         if (ret != 5) {
 149                 /* TODO: Handle better by also sending the remaining bytes. */
 150                 sr_err("Short packet: sent %d/5 bytes.", ret);
 151                 return SR_ERR;
 152         }
 153
 154         sr_dbg("Successfully sent initial HID feature report.");
 155
 156         return SR_OK;
 157 }
 158
 159 static void log_8byte_chunk(const uint8_t *buf)
 160 {
 161         sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
 162                 "(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
 163                 buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
 164 }
 165
 166 static void log_dmm_packet(const uint8_t *buf)
 167 {
 168         sr_dbg("DMM packet:   %02x %02x %02x %02x %02x %02x %02x"
 169                " %02x %02x %02x %02x %02x %02x %02x",
 170                buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
 171                buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
 172 }
 173
 174 static int get_and_handle_data(struct sr_dev_inst *sdi, int dmm, void *info)
 175 {
 176         struct dev_context *devc;
 177         uint8_t buf[CHUNK_SIZE], *pbuf;
 178         int i, ret, len, num_databytes_in_chunk;
 179         struct sr_usb_dev_inst *usb;
 180
 181         devc = sdi->priv;
 182         usb = sdi->conn;
 183         pbuf = devc->protocol_buf;
 184
 185         /* On the first run, we need to init the HID chip. */
 186         if (devc->first_run) {
 187                 if ((ret = hid_chip_init(sdi, udmms[dmm].baudrate)) != SR_OK) {
 188                         sr_err("HID chip init failed: %d.", ret);
 189                         return SR_ERR;
 190                 }
 191                 memset(pbuf, 0x00, DMM_BUFSIZE);
 192                 devc->first_run = FALSE;
 193         }
 194
 195         memset(&buf, 0x00, CHUNK_SIZE);
 196
 197         /* Get data from EP2 using an interrupt transfer. */
 198         ret = libusb_interrupt_transfer(
 199                 usb->devhdl, /* libusb device handle */
 200                 LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */
 201                 (unsigned char *)&buf, /* receive buffer */
 202                 CHUNK_SIZE, /* wLength */
 203                 &len, /* actually received byte count */
 204                 1000 /* timeout (ms) */);
 205
 206         if (ret < 0) {
 207                 sr_err("USB receive error: %s.", libusb_error_name(ret));
 208                 return SR_ERR;
 209         }
 210
 211         if (len != CHUNK_SIZE) {
 212                 sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
 213                 /* TODO: Print the bytes? */
 214                 return SR_ERR;
 215         }
 216
 217         log_8byte_chunk((const uint8_t *)&buf);
 218
 219         /* If there are no data bytes just return (without error). */
 220         if (buf[0] == 0xf0)
 221                 return SR_OK;
 222
 223         devc->bufoffset = 0;
 224
 225         /*
 226          * Append the 1-7 data bytes of this chunk to pbuf.
 227          *
 228          * Special case:
 229          * DMMs with Cyrustek ES51922 chip need serial settings of
 230          * 19230/7o1. The WCH CH9325 UART to USB/HID chip used in (some
 231          * versions of) the UNI-T UT-D04 cable however, will also send
 232          * the parity bit to the host in the 8-byte data chunks. This bit
 233          * is encoded in bit 7 of each of the 1-7 data bytes and must thus
 234          * be removed in order for the actual ES51922 protocol parser to
 235          * work properly.
 236          */
 237         num_databytes_in_chunk = buf[0] & 0x0f;
 238         for (i = 0; i < num_databytes_in_chunk; i++, devc->buflen++) {
 239                 pbuf[devc->buflen] = buf[1 + i];
 240                 if (udmms[dmm].packet_parse == sr_es519xx_19200_14b_parse)
 241                         pbuf[devc->buflen] &= ~(1 << 7);
 242         }
 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         int64_t time_ms;
 269
 270         (void)fd;
 271         (void)revents;
 272
 273         sdi = cb_data;
 274         devc = sdi->priv;
 275
 276         if ((ret = get_and_handle_data(sdi, dmm, info)) != SR_OK)
 277                 return FALSE;
 278
 279         /* Abort acquisition if we acquired enough samples. */
 280         if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
 281                 sr_info("Requested number of samples reached.");
 282                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 283         }
 284
 285         if (devc->limit_msec) {
 286                 time_ms = (g_get_monotonic_time() - devc->starttime) / 1000;
 287                 if (time_ms > (int64_t)devc->limit_msec) {
 288                         sr_info("Requested time limit reached.");
 289                         sdi->driver->dev_acquisition_stop(sdi, cb_data);
 290                         return TRUE;
 291                 }
 292         }
 293
 294         return TRUE;
 295 }
 296
 297 #define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
 298 SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
 299         struct DMM_DRIVER##_info info; \
 300         return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
 301
 302 /* Driver-specific receive_data() wrappers */
 303 RECEIVE_DATA(TECPEL_DMM_8061, fs9721)
 304 RECEIVE_DATA(UNI_T_UT60A, fs9721)
 305 RECEIVE_DATA(UNI_T_UT60E, fs9721)
 306 RECEIVE_DATA(UNI_T_UT60G, es519xx)
 307 RECEIVE_DATA(UNI_T_UT61B, fs9922)
 308 RECEIVE_DATA(UNI_T_UT61C, fs9922)
 309 RECEIVE_DATA(UNI_T_UT61D, fs9922)
 310 RECEIVE_DATA(UNI_T_UT61E, es519xx)
 311 RECEIVE_DATA(VOLTCRAFT_VC820, fs9721)
 312 RECEIVE_DATA(VOLTCRAFT_VC830, fs9922)
 313 RECEIVE_DATA(VOLTCRAFT_VC840, fs9721)
 314 RECEIVE_DATA(TENMA_72_7745, es519xx)
 315 RECEIVE_DATA(TENMA_72_7750, es519xx)