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