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