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