]>
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 | |
2ea1fdf1 | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
79081ec8 UH |
18 | */ |
19 | ||
6ec6c43b | 20 | #include <config.h> |
79081ec8 UH |
21 | #include <string.h> |
22 | #include <glib.h> | |
c1aae900 | 23 | #include <libsigrok/libsigrok.h> |
79081ec8 UH |
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 | ||
f0540611 | 54 | static void decode_packet(struct sr_dev_inst *sdi, const uint8_t *buf) |
79081ec8 | 55 | { |
bc653a56 | 56 | struct dev_context *devc; |
f0540611 | 57 | struct dmm_info *dmm; |
79081ec8 | 58 | struct sr_datafeed_packet packet; |
dff60e3c UH |
59 | struct sr_datafeed_analog analog; |
60 | struct sr_analog_encoding encoding; | |
61 | struct sr_analog_meaning meaning; | |
62 | struct sr_analog_spec spec; | |
79081ec8 | 63 | float floatval; |
f0540611 | 64 | void *info; |
79081ec8 UH |
65 | int ret; |
66 | ||
69e19dd7 | 67 | devc = sdi->priv; |
f0540611 | 68 | dmm = (struct dmm_info *)sdi->driver; |
869c8375 | 69 | /* Note: digits/spec_digits will be overridden by the DMM parsers. */ |
dff60e3c | 70 | sr_analog_init(&analog, &encoding, &meaning, &spec, 0); |
f0540611 | 71 | info = g_malloc(dmm->info_size); |
79081ec8 UH |
72 | |
73 | /* Parse the protocol packet. */ | |
f0540611 | 74 | ret = dmm->packet_parse(buf, &floatval, &analog, info); |
fdbcb86d | 75 | if (ret != SR_OK) { |
bc653a56 | 76 | sr_dbg("Invalid DMM packet, ignoring."); |
f0540611 | 77 | g_free(info); |
79081ec8 UH |
78 | return; |
79 | } | |
80 | ||
c8852687 | 81 | /* If this DMM needs additional handling, call the resp. function. */ |
f0540611 ML |
82 | if (dmm->dmm_details) |
83 | dmm->dmm_details(&analog, info); | |
84 | ||
85 | g_free(info); | |
c8852687 | 86 | |
79081ec8 | 87 | /* Send a sample packet with one analog value. */ |
dff60e3c | 88 | analog.meaning->channels = sdi->channels; |
79081ec8 UH |
89 | analog.num_samples = 1; |
90 | analog.data = &floatval; | |
dff60e3c | 91 | packet.type = SR_DF_ANALOG; |
79081ec8 | 92 | packet.payload = &analog; |
695dc859 | 93 | sr_session_send(sdi, &packet); |
79081ec8 | 94 | |
8a63a406 | 95 | sr_sw_limits_update_samples_read(&devc->limits, 1); |
79081ec8 UH |
96 | } |
97 | ||
3ece1dff | 98 | static int hid_chip_init(struct sr_dev_inst *sdi, uint16_t baudrate) |
79081ec8 UH |
99 | { |
100 | int ret; | |
101 | uint8_t buf[5]; | |
3ece1dff | 102 | struct sr_usb_dev_inst *usb; |
79081ec8 | 103 | |
3ece1dff | 104 | usb = sdi->conn; |
176d785d | 105 | |
79081ec8 | 106 | /* Detach kernel drivers which grabbed this device (if any). */ |
3ece1dff UH |
107 | if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) { |
108 | ret = libusb_detach_kernel_driver(usb->devhdl, 0); | |
79081ec8 | 109 | if (ret < 0) { |
d4928d71 PS |
110 | sr_err("Failed to detach kernel driver: %s.", |
111 | libusb_error_name(ret)); | |
79081ec8 UH |
112 | return SR_ERR; |
113 | } | |
79081ec8 UH |
114 | } |
115 | ||
116 | /* Claim interface 0. */ | |
3ece1dff | 117 | if ((ret = libusb_claim_interface(usb->devhdl, 0)) < 0) { |
d4928d71 PS |
118 | sr_err("Failed to claim interface 0: %s.", |
119 | libusb_error_name(ret)); | |
79081ec8 UH |
120 | return SR_ERR; |
121 | } | |
79081ec8 | 122 | |
bc653a56 | 123 | /* Set data for the HID feature report (e.g. baudrate). */ |
79081ec8 UH |
124 | buf[0] = baudrate & 0xff; /* Baudrate, LSB */ |
125 | buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */ | |
126 | buf[2] = 0x00; /* Unknown/unused (?) */ | |
127 | buf[3] = 0x00; /* Unknown/unused (?) */ | |
128 | buf[4] = 0x03; /* Unknown, always 0x03. */ | |
129 | ||
130 | /* Send HID feature report to setup the baudrate/chip. */ | |
131 | sr_dbg("Sending initial HID feature report."); | |
132 | sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)", | |
133 | buf[0], buf[1], buf[2], buf[3], buf[4], baudrate); | |
134 | ret = libusb_control_transfer( | |
3ece1dff | 135 | usb->devhdl, /* libusb device handle */ |
79081ec8 UH |
136 | LIBUSB_REQUEST_TYPE_CLASS | |
137 | LIBUSB_RECIPIENT_INTERFACE | | |
138 | LIBUSB_ENDPOINT_OUT, | |
139 | 9, /* bRequest: HID set_report */ | |
140 | 0x300, /* wValue: HID feature, report number 0 */ | |
141 | 0, /* wIndex: interface 0 */ | |
142 | (unsigned char *)&buf, /* payload buffer */ | |
143 | 5, /* wLength: 5 bytes payload */ | |
144 | 1000 /* timeout (ms) */); | |
145 | ||
146 | if (ret < 0) { | |
d4928d71 | 147 | sr_err("HID feature report error: %s.", libusb_error_name(ret)); |
79081ec8 UH |
148 | return SR_ERR; |
149 | } | |
150 | ||
151 | if (ret != 5) { | |
152 | /* TODO: Handle better by also sending the remaining bytes. */ | |
153 | sr_err("Short packet: sent %d/5 bytes.", ret); | |
154 | return SR_ERR; | |
155 | } | |
156 | ||
79081ec8 UH |
157 | return SR_OK; |
158 | } | |
159 | ||
160 | static void log_8byte_chunk(const uint8_t *buf) | |
161 | { | |
162 | sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x " | |
163 | "(%d data bytes)", buf[0], buf[1], buf[2], buf[3], | |
164 | buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f)); | |
165 | } | |
166 | ||
167 | static void log_dmm_packet(const uint8_t *buf) | |
168 | { | |
169 | sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x" | |
170 | " %02x %02x %02x %02x %02x %02x %02x", | |
171 | buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], | |
172 | buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]); | |
173 | } | |
174 | ||
f0540611 | 175 | static int get_and_handle_data(struct sr_dev_inst *sdi) |
79081ec8 | 176 | { |
79081ec8 | 177 | struct dev_context *devc; |
f0540611 | 178 | struct dmm_info *dmm; |
bc653a56 | 179 | uint8_t buf[CHUNK_SIZE], *pbuf; |
79081ec8 | 180 | int i, ret, len, num_databytes_in_chunk; |
3ece1dff | 181 | struct sr_usb_dev_inst *usb; |
79081ec8 | 182 | |
79081ec8 | 183 | devc = sdi->priv; |
f0540611 | 184 | dmm = (struct dmm_info *)sdi->driver; |
3ece1dff | 185 | usb = sdi->conn; |
79081ec8 UH |
186 | pbuf = devc->protocol_buf; |
187 | ||
188 | /* On the first run, we need to init the HID chip. */ | |
bc653a56 | 189 | if (devc->first_run) { |
f0540611 | 190 | if ((ret = hid_chip_init(sdi, dmm->baudrate)) != SR_OK) { |
79081ec8 | 191 | sr_err("HID chip init failed: %d.", ret); |
bc653a56 | 192 | return SR_ERR; |
79081ec8 | 193 | } |
bc653a56 UH |
194 | memset(pbuf, 0x00, DMM_BUFSIZE); |
195 | devc->first_run = FALSE; | |
79081ec8 UH |
196 | } |
197 | ||
198 | memset(&buf, 0x00, CHUNK_SIZE); | |
199 | ||
200 | /* Get data from EP2 using an interrupt transfer. */ | |
201 | ret = libusb_interrupt_transfer( | |
3ece1dff | 202 | usb->devhdl, /* libusb device handle */ |
79081ec8 UH |
203 | LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */ |
204 | (unsigned char *)&buf, /* receive buffer */ | |
205 | CHUNK_SIZE, /* wLength */ | |
206 | &len, /* actually received byte count */ | |
207 | 1000 /* timeout (ms) */); | |
208 | ||
209 | if (ret < 0) { | |
d4928d71 | 210 | sr_err("USB receive error: %s.", libusb_error_name(ret)); |
bc653a56 | 211 | return SR_ERR; |
79081ec8 UH |
212 | } |
213 | ||
214 | if (len != CHUNK_SIZE) { | |
215 | sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE); | |
216 | /* TODO: Print the bytes? */ | |
bc653a56 | 217 | return SR_ERR; |
79081ec8 UH |
218 | } |
219 | ||
220 | log_8byte_chunk((const uint8_t *)&buf); | |
221 | ||
bc653a56 UH |
222 | /* If there are no data bytes just return (without error). */ |
223 | if (buf[0] == 0xf0) | |
224 | return SR_OK; | |
225 | ||
226 | devc->bufoffset = 0; | |
227 | ||
4d7ddff7 UH |
228 | /* |
229 | * Append the 1-7 data bytes of this chunk to pbuf. | |
230 | * | |
231 | * Special case: | |
8769478c UH |
232 | * DMMs with Cyrustek ES51922 chip and UT71x DMMs need serial settings |
233 | * of 7o1. The WCH CH9325 UART to USB/HID chip used in (some | |
4d7ddff7 UH |
234 | * versions of) the UNI-T UT-D04 cable however, will also send |
235 | * the parity bit to the host in the 8-byte data chunks. This bit | |
236 | * is encoded in bit 7 of each of the 1-7 data bytes and must thus | |
8769478c | 237 | * be removed in order for the actual protocol parser to work properly. |
4d7ddff7 | 238 | */ |
bc653a56 | 239 | num_databytes_in_chunk = buf[0] & 0x0f; |
4d7ddff7 UH |
240 | for (i = 0; i < num_databytes_in_chunk; i++, devc->buflen++) { |
241 | pbuf[devc->buflen] = buf[1 + i]; | |
f0540611 | 242 | if ((dmm->packet_parse == sr_es519xx_19200_14b_parse) || |
06f0872e UH |
243 | (dmm->packet_parse == sr_es519xx_19200_11b_parse) || |
244 | (dmm->packet_parse == sr_es519xx_2400_11b_parse) || | |
f0540611 | 245 | (dmm->packet_parse == sr_ut71x_parse)) { |
8769478c | 246 | /* Mask off the parity bit. */ |
4d7ddff7 | 247 | pbuf[devc->buflen] &= ~(1 << 7); |
8769478c | 248 | } |
4d7ddff7 | 249 | } |
bc653a56 UH |
250 | |
251 | /* Now look for packets in that data. */ | |
f0540611 ML |
252 | while ((devc->buflen - devc->bufoffset) >= dmm->packet_size) { |
253 | if (dmm->packet_valid(pbuf + devc->bufoffset)) { | |
bc653a56 | 254 | log_dmm_packet(pbuf + devc->bufoffset); |
f0540611 ML |
255 | decode_packet(sdi, pbuf + devc->bufoffset); |
256 | devc->bufoffset += dmm->packet_size; | |
bc653a56 UH |
257 | } else { |
258 | devc->bufoffset++; | |
79081ec8 | 259 | } |
bc653a56 | 260 | } |
79081ec8 | 261 | |
bc653a56 UH |
262 | /* Move remaining bytes to beginning of buffer. */ |
263 | for (i = 0; i < devc->buflen - devc->bufoffset; i++) | |
264 | pbuf[i] = pbuf[devc->bufoffset + i]; | |
265 | devc->buflen -= devc->bufoffset; | |
79081ec8 | 266 | |
bc653a56 UH |
267 | return SR_OK; |
268 | } | |
269 | ||
f0540611 | 270 | SR_PRIV int uni_t_dmm_receive_data(int fd, int revents, void *cb_data) |
bc653a56 UH |
271 | { |
272 | int ret; | |
273 | struct sr_dev_inst *sdi; | |
274 | struct dev_context *devc; | |
c8852687 | 275 | |
bc653a56 UH |
276 | (void)fd; |
277 | (void)revents; | |
c8852687 | 278 | |
bc653a56 UH |
279 | sdi = cb_data; |
280 | devc = sdi->priv; | |
c8852687 | 281 | |
f0540611 | 282 | if ((ret = get_and_handle_data(sdi)) != SR_OK) |
bc653a56 | 283 | return FALSE; |
79081ec8 UH |
284 | |
285 | /* Abort acquisition if we acquired enough samples. */ | |
8a63a406 | 286 | if (sr_sw_limits_check(&devc->limits)) |
d2f7c417 | 287 | sr_dev_acquisition_stop(sdi); |
c5ffac41 | 288 | |
79081ec8 UH |
289 | return TRUE; |
290 | } |