2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
23 #include "libsigrok.h"
24 #include "libsigrok-internal.h"
28 * Driver for various UNI-T multimeters (and rebranded ones).
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.
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.
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
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.
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)
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)
60 * - UNI-T UT60E: Fortune Semiconductor FS9721_LP3
64 * - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4
65 * - UNI-T UT61E: Cyrustek ES51922
67 * - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3
68 * - Voltcraft VC-830: Fortune Semiconductor FS9922-DMM4
69 * - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3
73 static void decode_packet(struct sr_dev_inst *sdi, int dmm, const uint8_t *buf,
76 struct dev_context *devc;
77 struct sr_datafeed_packet packet;
78 struct sr_datafeed_analog analog;
83 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
85 /* Parse the protocol packet. */
86 ret = udmms[dmm].packet_parse(buf, &floatval, &analog, info);
88 sr_dbg("Invalid DMM packet, ignoring.");
92 /* If this DMM needs additional handling, call the resp. function. */
93 if (udmms[dmm].dmm_details)
94 udmms[dmm].dmm_details(&analog, info);
96 /* Send a sample packet with one analog value. */
97 analog.probes = sdi->probes;
98 analog.num_samples = 1;
99 analog.data = &floatval;
100 packet.type = SR_DF_ANALOG;
101 packet.payload = &analog;
102 sr_session_send(devc->cb_data, &packet);
104 /* Increase sample count. */
108 static int hid_chip_init(struct sr_dev_inst *sdi, uint16_t baudrate)
112 struct sr_usb_dev_inst *usb;
116 /* Detach kernel drivers which grabbed this device (if any). */
117 if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
118 ret = libusb_detach_kernel_driver(usb->devhdl, 0);
120 sr_err("Failed to detach kernel driver: %s.",
121 libusb_error_name(ret));
124 sr_dbg("Successfully detached kernel driver.");
126 sr_dbg("No need to detach a kernel driver.");
129 /* Claim interface 0. */
130 if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) {
131 sr_err("Failed to claim interface 0: %s.",
132 libusb_error_name(ret));
135 sr_dbg("Successfully claimed interface 0.");
137 /* Set data for the HID feature report (e.g. baudrate). */
138 buf[0] = baudrate & 0xff; /* Baudrate, LSB */
139 buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */
140 buf[2] = 0x00; /* Unknown/unused (?) */
141 buf[3] = 0x00; /* Unknown/unused (?) */
142 buf[4] = 0x03; /* Unknown, always 0x03. */
144 /* Send HID feature report to setup the baudrate/chip. */
145 sr_dbg("Sending initial HID feature report.");
146 sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)",
147 buf[0], buf[1], buf[2], buf[3], buf[4], baudrate);
148 ret = libusb_control_transfer(
149 usb->devhdl, /* libusb device handle */
150 LIBUSB_REQUEST_TYPE_CLASS |
151 LIBUSB_RECIPIENT_INTERFACE |
153 9, /* bRequest: HID set_report */
154 0x300, /* wValue: HID feature, report number 0 */
155 0, /* wIndex: interface 0 */
156 (unsigned char *)&buf, /* payload buffer */
157 5, /* wLength: 5 bytes payload */
158 1000 /* timeout (ms) */);
161 sr_err("HID feature report error: %s.", libusb_error_name(ret));
166 /* TODO: Handle better by also sending the remaining bytes. */
167 sr_err("Short packet: sent %d/5 bytes.", ret);
171 sr_dbg("Successfully sent initial HID feature report.");
176 static void log_8byte_chunk(const uint8_t *buf)
178 sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x "
179 "(%d data bytes)", buf[0], buf[1], buf[2], buf[3],
180 buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f));
183 static void log_dmm_packet(const uint8_t *buf)
185 sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x"
186 " %02x %02x %02x %02x %02x %02x %02x",
187 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
188 buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]);
191 static int get_and_handle_data(struct sr_dev_inst *sdi, int dmm, void *info)
193 struct dev_context *devc;
194 uint8_t buf[CHUNK_SIZE], *pbuf;
195 int i, ret, len, num_databytes_in_chunk;
196 struct sr_usb_dev_inst *usb;
200 pbuf = devc->protocol_buf;
202 /* On the first run, we need to init the HID chip. */
203 if (devc->first_run) {
204 if ((ret = hid_chip_init(sdi, udmms[dmm].baudrate)) != SR_OK) {
205 sr_err("HID chip init failed: %d.", ret);
208 memset(pbuf, 0x00, DMM_BUFSIZE);
209 devc->first_run = FALSE;
212 memset(&buf, 0x00, CHUNK_SIZE);
214 /* Get data from EP2 using an interrupt transfer. */
215 ret = libusb_interrupt_transfer(
216 usb->devhdl, /* libusb device handle */
217 LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */
218 (unsigned char *)&buf, /* receive buffer */
219 CHUNK_SIZE, /* wLength */
220 &len, /* actually received byte count */
221 1000 /* timeout (ms) */);
224 sr_err("USB receive error: %s.", libusb_error_name(ret));
228 if (len != CHUNK_SIZE) {
229 sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE);
230 /* TODO: Print the bytes? */
234 log_8byte_chunk((const uint8_t *)&buf);
236 /* If there are no data bytes just return (without error). */
242 /* Append the 1-7 data bytes of this chunk to pbuf. */
243 num_databytes_in_chunk = buf[0] & 0x0f;
244 for (i = 0; i < num_databytes_in_chunk; i++)
245 pbuf[devc->buflen++] = buf[1 + i];
247 /* Now look for packets in that data. */
248 while ((devc->buflen - devc->bufoffset) >= udmms[dmm].packet_size) {
249 if (udmms[dmm].packet_valid(pbuf + devc->bufoffset)) {
250 log_dmm_packet(pbuf + devc->bufoffset);
251 decode_packet(sdi, dmm, pbuf + devc->bufoffset, info);
252 devc->bufoffset += udmms[dmm].packet_size;
258 /* Move remaining bytes to beginning of buffer. */
259 for (i = 0; i < devc->buflen - devc->bufoffset; i++)
260 pbuf[i] = pbuf[devc->bufoffset + i];
261 devc->buflen -= devc->bufoffset;
266 static int receive_data(int fd, int revents, int dmm, void *info, void *cb_data)
269 struct sr_dev_inst *sdi;
270 struct dev_context *devc;
279 if ((ret = get_and_handle_data(sdi, dmm, info)) != SR_OK)
282 /* Abort acquisition if we acquired enough samples. */
283 if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
284 sr_info("Requested number of samples reached.");
285 sdi->driver->dev_acquisition_stop(sdi, cb_data);
288 if (devc->limit_msec) {
289 time_ms = (g_get_monotonic_time() - devc->starttime) / 1000;
290 if (time_ms > (int64_t)devc->limit_msec) {
291 sr_info("Requested time limit reached.");
292 sdi->driver->dev_acquisition_stop(sdi, cb_data);
300 #define RECEIVE_DATA(ID_UPPER, DMM_DRIVER) \
301 SR_PRIV int receive_data_##ID_UPPER(int fd, int revents, void *cb_data) { \
302 struct DMM_DRIVER##_info info; \
303 return receive_data(fd, revents, ID_UPPER, &info, cb_data); }
305 /* Driver-specific receive_data() wrappers */
306 RECEIVE_DATA(TECPEL_DMM_8060, fs9721)
307 RECEIVE_DATA(TECPEL_DMM_8061, fs9721)
308 RECEIVE_DATA(UNI_T_UT61D, fs9922)
309 RECEIVE_DATA(UNI_T_UT61E, es51922)
310 RECEIVE_DATA(VOLTCRAFT_VC820, fs9721)
311 RECEIVE_DATA(VOLTCRAFT_VC830, fs9922)
312 RECEIVE_DATA(VOLTCRAFT_VC840, fs9721)