hardware/uni-t-dmm/protocol.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2012 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-D01 RS232 cable.
  34  *
  35  * This driver is meant to support all three 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.
  38  *
  39  * The data for one DMM packet (e.g. 14 bytes if the respective DMM uses a
  40  * Fortune Semiconductor FS9922-DMM4 chip) is spread across multiple
  41  * 8-byte chunks.
  42  *
  43  * An 8-byte chunk looks like this:
  44  *  - Byte 0: 0xfz, where z is the number of actual data bytes in this chunk.
  45  *  - Bytes 1-7: z data bytes, the rest of the bytes should be ignored.
  46  *
  47  * Example:
  48  *  f0 00 00 00 00 00 00 00 (no data bytes)
  49  *  f2 55 77 00 00 00 00 00 (2 data bytes, 0x55 and 0x77)
  50  *  f1 d1 00 00 00 00 00 00 (1 data byte, 0xd1)
  51  *
  52  * Chips and serial settings used in UNI-T DMMs (and rebranded ones):
  53  *  - UNI-T UT108: ?
  54  *  - UNI-T UT109: ?
  55  *  - UNI-T UT30A: ?
  56  *  - UNI-T UT30E: ?
  57  *  - UNI-T UT60E: Fortune Semiconductor FS9721_LP3
  58  *  - UNI-T UT60G: ?
  59  *  - UNI-T UT61B: ?
  60  *  - UNI-T UT61C: ?
  61  *  - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4
  62  *  - UNI-T UT61E: Cyrustek ES51922
  63  *  - UNI-T UT70B: ?
  64  *  - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3
  65  *  - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3
  66  *  - ...
  67  */
  68
  69 static void decode_packet(struct dev_context *devc, const uint8_t *buf)
  70 {
  71         struct sr_datafeed_packet packet;
  72         struct sr_datafeed_analog analog;
  73         float floatval;
  74         int ret;
  75
  76         memset(&analog, 0, sizeof(struct sr_datafeed_analog));
  77
  78         /* Parse the protocol packet. */
  79         if ((ret = sr_dmm_parse_fs9922(buf, &floatval, &analog)) != SR_OK) {
  80                 sr_err("Invalid DMM packet, ignoring.");
  81                 return;
  82         }
  83
  84         /* Send a sample packet with one analog value. */
  85         analog.num_samples = 1;
  86         analog.data = &floatval;
  87         packet.type = SR_DF_ANALOG;
  88         packet.payload = &analog;
  89         sr_session_send(devc->cb_data, &packet);
  90
  91         /* Increase sample count. */
  92         devc->num_samples++;
  93 }
  94
  95 static int hid_chip_init(struct dev_context *devc, uint16_t baudrate)
  96 {
  97         int ret;
  98         uint8_t buf[5];
  99
 100         /* Detach kernel drivers which grabbed this device (if any). */
 101         if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) {
 102                 ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0);
 103                 if (ret < 0) {
 104                         sr_err("Failed to detach kernel driver: %d.", 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(devc->usb->devhdl, 0)) < 0) {
 114                 sr_err("Failed to claim interface 0: %d.", ret);
 115                 return SR_ERR;
 116         }
 117         sr_dbg("Successfully claimed interface 0.");
 118
 119         /* Baudrate example: 19230 baud -> HEX(19230) == 0x4b1e */
 120         buf[0] = baudrate & 0xff;        /* Baudrate, LSB */
 121         buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
 122         buf[2] = 0x00;                   /* Unknown/unused (?) */
 123         buf[3] = 0x00;                   /* Unknown/unused (?) */
 124         buf[4] = 0x03;                   /* Unknown, always 0x03. */
 125
 126         /* Send HID feature report to setup the baudrate/chip. */
 127         sr_dbg("Sending initial HID feature report.");
 128         sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)",
 129                 buf[0], buf[1], buf[2], buf[3], buf[4], baudrate);
 130         ret = libusb_control_transfer(
 131                 devc->usb->devhdl, /* libusb device handle */
 132                 LIBUSB_REQUEST_TYPE_CLASS |
 133                 LIBUSB_RECIPIENT_INTERFACE |
 134                 LIBUSB_ENDPOINT_OUT,
 135                 9, /* bRequest: HID set_report */
 136                 0x300, /* wValue: HID feature, report number 0 */
 137                 0, /* wIndex: interface 0 */
 138                 (unsigned char *)&buf, /* payload buffer */
 139                 5, /* wLength: 5 bytes payload */
 140                 1000 /* timeout (ms) */);
 141
 142         if (ret < 0) {
 143                 sr_err("HID feature report error: %d.", ret);
 144                 return SR_ERR;
 145         }
 146
 147         if (ret != 5) {
 148                 /* TODO: Handle better by also sending the remaining bytes. */
 149                 sr_err("Short packet: sent %d/5 bytes.", ret);
 150                 return SR_ERR;
 151         }
 152
 153         sr_dbg("Successfully sent initial HID feature report.");
 154
 155         return SR_OK;
 156 }
 157
 158 static void log_8byte_chunk(const uint8_t *buf)
 159 {
 160         sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
 161                 "(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
 162                 buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
 163 }
 164
 165 static void log_dmm_packet(const uint8_t *buf)
 166 {
 167         sr_dbg("DMM packet:   %02x %02x %02x %02x %02x %02x %02x"
 168                " %02x %02x %02x %02x %02x %02x %02x",
 169                buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
 170                buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
 171 }
 172
 173 SR_PRIV int uni_t_dmm_receive_data(int fd, int revents, void *cb_data)
 174 {
 175         struct sr_dev_inst *sdi;
 176         struct dev_context *devc;
 177         int i, ret, len, num_databytes_in_chunk;
 178         uint8_t buf[CHUNK_SIZE];
 179         uint8_t *pbuf;
 180         static gboolean first_run = TRUE, synced_on_first_packet = FALSE;
 181         static uint64_t data_byte_counter = 0;
 182
 183         (void)fd;
 184         (void)revents;
 185
 186         sdi = cb_data;
 187         devc = sdi->priv;
 188
 189         pbuf = devc->protocol_buf;
 190
 191         /* On the first run, we need to init the HID chip. */
 192         if (first_run) {
 193                 /* TODO: The baudrate is DMM-specific (UT61D: 19230). */
 194                 if ((ret = hid_chip_init(devc, 19230)) != SR_OK) {
 195                         sr_err("HID chip init failed: %d.", ret);
 196                         return FALSE;
 197                 }
 198                 memset(pbuf, 0x00, NUM_DATA_BYTES);
 199                 first_run = FALSE;
 200         }
 201
 202         memset(&buf, 0x00, CHUNK_SIZE);
 203
 204         /* Get data from EP2 using an interrupt transfer. */
 205         ret = libusb_interrupt_transfer(
 206                 devc->usb->devhdl, /* libusb device handle */
 207                 LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */
 208                 (unsigned char *)&buf, /* receive buffer */
 209                 CHUNK_SIZE, /* wLength */
 210                 &len, /* actually received byte count */
 211                 1000 /* timeout (ms) */);
 212
 213         if (ret < 0) {
 214                 sr_err("USB receive error: %d.", ret);
 215                 return FALSE;
 216         }
 217
 218         if (len != CHUNK_SIZE) {
 219                 sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
 220                 /* TODO: Print the bytes? */
 221                 return FALSE;
 222         }
 223
 224         log_8byte_chunk((const uint8_t *)&buf);
 225
 226         if (buf[0] != 0xf0) {
 227                 /* First time: Synchronize to the start of a packet. */
 228                 if (!synced_on_first_packet) {
 229                         /* Valid packets start with '+' or '-'. */
 230                         if ((buf[1] != '+') && buf[1] != '-')
 231                                 return TRUE;
 232                         synced_on_first_packet = TRUE;
 233                         sr_spew("Successfully synchronized on first packet.");
 234                 }
 235
 236                 num_databytes_in_chunk = buf[0] & 0x0f;
 237                 for (i = 0; i < num_databytes_in_chunk; i++)
 238                         pbuf[data_byte_counter++] = buf[1 + i];
 239
 240                 /* TODO: Handle > 14 bytes in pbuf? Can this happen? */
 241                 if (data_byte_counter == NUM_DATA_BYTES) {
 242                         log_dmm_packet(pbuf);
 243                         data_byte_counter = 0;
 244                         decode_packet(devc, pbuf);
 245                         memset(pbuf, 0x00, NUM_DATA_BYTES);
 246                 }
 247         }
 248
 249         /* Abort acquisition if we acquired enough samples. */
 250         if (devc->num_samples >= devc->limit_samples && devc->limit_samples > 0) {
 251                 sr_info("Requested number of samples reached.");
 252                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 253         }
 254
 255         return TRUE;
 256 }