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