]>
Commit | Line | Data |
---|---|---|
79081ec8 UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de> | |
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. | |
33 | * - The UT-D01 RS232 cable. | |
34 | * | |
35 | * This driver is meant to support all three cables, and various DMMs that | |
36 | * can be attached to a PC via these cables. Currently only the UT-D04 cable | |
37 | * (new version) is supported. | |
38 | * | |
39 | * The data for one DMM packet (e.g. 14 bytes if the respective DMM uses a | |
40 | * Fortune Semiconductor FS9922-DMM4 chip) is spread across multiple | |
41 | * 8-byte chunks. | |
42 | * | |
43 | * An 8-byte chunk looks like this: | |
44 | * - Byte 0: 0xfz, where z is the number of actual data bytes in this chunk. | |
45 | * - Bytes 1-7: z data bytes, the rest of the bytes should be ignored. | |
46 | * | |
47 | * Example: | |
48 | * f0 00 00 00 00 00 00 00 (no data bytes) | |
49 | * f2 55 77 00 00 00 00 00 (2 data bytes, 0x55 and 0x77) | |
50 | * f1 d1 00 00 00 00 00 00 (1 data byte, 0xd1) | |
51 | * | |
52 | * Chips and serial settings used in UNI-T DMMs (and rebranded ones): | |
53 | * - UNI-T UT108: ? | |
54 | * - UNI-T UT109: ? | |
55 | * - UNI-T UT30A: ? | |
56 | * - UNI-T UT30E: ? | |
57 | * - UNI-T UT60E: Fortune Semiconductor FS9721_LP3 | |
58 | * - UNI-T UT60G: ? | |
59 | * - UNI-T UT61B: ? | |
60 | * - UNI-T UT61C: ? | |
61 | * - UNI-T UT61D: Fortune Semiconductor FS9922-DMM4 | |
62 | * - UNI-T UT61E: Cyrustek ES51922 | |
63 | * - UNI-T UT70B: ? | |
64 | * - Voltcraft VC-820: Fortune Semiconductor FS9721_LP3 | |
65 | * - Voltcraft VC-840: Fortune Semiconductor FS9721_LP3 | |
66 | * - ... | |
67 | */ | |
68 | ||
fdbcb86d | 69 | static void decode_packet(struct dev_context *devc, int dmm, const uint8_t *buf) |
79081ec8 UH |
70 | { |
71 | struct sr_datafeed_packet packet; | |
72 | struct sr_datafeed_analog analog; | |
8c1adf37 | 73 | struct fs9721_info info; |
79081ec8 UH |
74 | float floatval; |
75 | int ret; | |
76 | ||
77 | memset(&analog, 0, sizeof(struct sr_datafeed_analog)); | |
78 | ||
79 | /* Parse the protocol packet. */ | |
811155da | 80 | ret = SR_ERR; |
fdbcb86d UH |
81 | if (dmm == UNI_T_UT61D) |
82 | ret = sr_dmm_parse_fs9922(buf, &floatval, &analog); | |
83 | else if (dmm == VOLTCRAFT_VC820) | |
8c1adf37 | 84 | ret = sr_fs9721_parse(buf, &floatval, &analog, &info); |
fdbcb86d | 85 | if (ret != SR_OK) { |
79081ec8 UH |
86 | sr_err("Invalid DMM packet, ignoring."); |
87 | return; | |
88 | } | |
89 | ||
90 | /* Send a sample packet with one analog value. */ | |
91 | analog.num_samples = 1; | |
92 | analog.data = &floatval; | |
93 | packet.type = SR_DF_ANALOG; | |
94 | packet.payload = &analog; | |
95 | sr_session_send(devc->cb_data, &packet); | |
96 | ||
97 | /* Increase sample count. */ | |
98 | devc->num_samples++; | |
99 | } | |
100 | ||
101 | static int hid_chip_init(struct dev_context *devc, uint16_t baudrate) | |
102 | { | |
103 | int ret; | |
104 | uint8_t buf[5]; | |
105 | ||
106 | /* Detach kernel drivers which grabbed this device (if any). */ | |
107 | if (libusb_kernel_driver_active(devc->usb->devhdl, 0) == 1) { | |
108 | ret = libusb_detach_kernel_driver(devc->usb->devhdl, 0); | |
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 | } | |
114 | sr_dbg("Successfully detached kernel driver."); | |
115 | } else { | |
116 | sr_dbg("No need to detach a kernel driver."); | |
117 | } | |
118 | ||
119 | /* Claim interface 0. */ | |
120 | if ((ret = libusb_claim_interface(devc->usb->devhdl, 0)) < 0) { | |
d4928d71 PS |
121 | sr_err("Failed to claim interface 0: %s.", |
122 | libusb_error_name(ret)); | |
79081ec8 UH |
123 | return SR_ERR; |
124 | } | |
125 | sr_dbg("Successfully claimed interface 0."); | |
126 | ||
127 | /* Baudrate example: 19230 baud -> HEX(19230) == 0x4b1e */ | |
128 | buf[0] = baudrate & 0xff; /* Baudrate, LSB */ | |
129 | buf[1] = (baudrate >> 8) & 0xff; /* Baudrate, MSB */ | |
130 | buf[2] = 0x00; /* Unknown/unused (?) */ | |
131 | buf[3] = 0x00; /* Unknown/unused (?) */ | |
132 | buf[4] = 0x03; /* Unknown, always 0x03. */ | |
133 | ||
134 | /* Send HID feature report to setup the baudrate/chip. */ | |
135 | sr_dbg("Sending initial HID feature report."); | |
136 | sr_spew("HID init = 0x%02x 0x%02x 0x%02x 0x%02x 0x%02x (%d baud)", | |
137 | buf[0], buf[1], buf[2], buf[3], buf[4], baudrate); | |
138 | ret = libusb_control_transfer( | |
139 | devc->usb->devhdl, /* libusb device handle */ | |
140 | LIBUSB_REQUEST_TYPE_CLASS | | |
141 | LIBUSB_RECIPIENT_INTERFACE | | |
142 | LIBUSB_ENDPOINT_OUT, | |
143 | 9, /* bRequest: HID set_report */ | |
144 | 0x300, /* wValue: HID feature, report number 0 */ | |
145 | 0, /* wIndex: interface 0 */ | |
146 | (unsigned char *)&buf, /* payload buffer */ | |
147 | 5, /* wLength: 5 bytes payload */ | |
148 | 1000 /* timeout (ms) */); | |
149 | ||
150 | if (ret < 0) { | |
d4928d71 | 151 | sr_err("HID feature report error: %s.", libusb_error_name(ret)); |
79081ec8 UH |
152 | return SR_ERR; |
153 | } | |
154 | ||
155 | if (ret != 5) { | |
156 | /* TODO: Handle better by also sending the remaining bytes. */ | |
157 | sr_err("Short packet: sent %d/5 bytes.", ret); | |
158 | return SR_ERR; | |
159 | } | |
160 | ||
161 | sr_dbg("Successfully sent initial HID feature report."); | |
162 | ||
163 | return SR_OK; | |
164 | } | |
165 | ||
166 | static void log_8byte_chunk(const uint8_t *buf) | |
167 | { | |
168 | sr_spew("8-byte chunk: %02x %02x %02x %02x %02x %02x %02x %02x " | |
169 | "(%d data bytes)", buf[0], buf[1], buf[2], buf[3], | |
170 | buf[4], buf[5], buf[6], buf[7], (buf[0] & 0x0f)); | |
171 | } | |
172 | ||
173 | static void log_dmm_packet(const uint8_t *buf) | |
174 | { | |
175 | sr_dbg("DMM packet: %02x %02x %02x %02x %02x %02x %02x" | |
176 | " %02x %02x %02x %02x %02x %02x %02x", | |
177 | buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], | |
178 | buf[7], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13]); | |
179 | } | |
180 | ||
fdbcb86d | 181 | static int uni_t_dmm_receive_data(int fd, int revents, int dmm, void *cb_data) |
79081ec8 UH |
182 | { |
183 | struct sr_dev_inst *sdi; | |
184 | struct dev_context *devc; | |
185 | int i, ret, len, num_databytes_in_chunk; | |
186 | uint8_t buf[CHUNK_SIZE]; | |
187 | uint8_t *pbuf; | |
188 | static gboolean first_run = TRUE, synced_on_first_packet = FALSE; | |
189 | static uint64_t data_byte_counter = 0; | |
190 | ||
191 | (void)fd; | |
192 | (void)revents; | |
193 | ||
194 | sdi = cb_data; | |
195 | devc = sdi->priv; | |
196 | ||
197 | pbuf = devc->protocol_buf; | |
198 | ||
199 | /* On the first run, we need to init the HID chip. */ | |
200 | if (first_run) { | |
201 | /* TODO: The baudrate is DMM-specific (UT61D: 19230). */ | |
202 | if ((ret = hid_chip_init(devc, 19230)) != SR_OK) { | |
203 | sr_err("HID chip init failed: %d.", ret); | |
204 | return FALSE; | |
205 | } | |
206 | memset(pbuf, 0x00, NUM_DATA_BYTES); | |
207 | first_run = FALSE; | |
208 | } | |
209 | ||
210 | memset(&buf, 0x00, CHUNK_SIZE); | |
211 | ||
212 | /* Get data from EP2 using an interrupt transfer. */ | |
213 | ret = libusb_interrupt_transfer( | |
214 | devc->usb->devhdl, /* libusb device handle */ | |
215 | LIBUSB_ENDPOINT_IN | 2, /* EP2, IN */ | |
216 | (unsigned char *)&buf, /* receive buffer */ | |
217 | CHUNK_SIZE, /* wLength */ | |
218 | &len, /* actually received byte count */ | |
219 | 1000 /* timeout (ms) */); | |
220 | ||
221 | if (ret < 0) { | |
d4928d71 | 222 | sr_err("USB receive error: %s.", libusb_error_name(ret)); |
79081ec8 UH |
223 | return FALSE; |
224 | } | |
225 | ||
226 | if (len != CHUNK_SIZE) { | |
227 | sr_err("Short packet: received %d/%d bytes.", len, CHUNK_SIZE); | |
228 | /* TODO: Print the bytes? */ | |
229 | return FALSE; | |
230 | } | |
231 | ||
232 | log_8byte_chunk((const uint8_t *)&buf); | |
233 | ||
234 | if (buf[0] != 0xf0) { | |
235 | /* First time: Synchronize to the start of a packet. */ | |
236 | if (!synced_on_first_packet) { | |
fdbcb86d UH |
237 | if (dmm == UNI_T_UT61D) { |
238 | /* Valid packets start with '+' or '-'. */ | |
239 | if ((buf[1] != '+') && buf[1] != '-') | |
240 | return TRUE; | |
241 | } else if (dmm == VOLTCRAFT_VC820) { | |
242 | /* Valid packets have 0x1 as high nibble. */ | |
8c1adf37 | 243 | if (!sr_fs9721_is_packet_start(buf[1])) |
fdbcb86d UH |
244 | return TRUE; |
245 | } | |
79081ec8 UH |
246 | synced_on_first_packet = TRUE; |
247 | sr_spew("Successfully synchronized on first packet."); | |
248 | } | |
249 | ||
250 | num_databytes_in_chunk = buf[0] & 0x0f; | |
251 | for (i = 0; i < num_databytes_in_chunk; i++) | |
252 | pbuf[data_byte_counter++] = buf[1 + i]; | |
253 | ||
254 | /* TODO: Handle > 14 bytes in pbuf? Can this happen? */ | |
255 | if (data_byte_counter == NUM_DATA_BYTES) { | |
256 | log_dmm_packet(pbuf); | |
257 | data_byte_counter = 0; | |
9d8fde40 UH |
258 | if (dmm == VOLTCRAFT_VC820) { |
259 | if (!sr_fs9721_packet_valid(pbuf)) { | |
260 | sr_err("Invalid packet."); | |
261 | return TRUE; | |
262 | } | |
8c1adf37 | 263 | } |
fdbcb86d | 264 | decode_packet(devc, dmm, pbuf); |
79081ec8 UH |
265 | memset(pbuf, 0x00, NUM_DATA_BYTES); |
266 | } | |
267 | } | |
268 | ||
269 | /* Abort acquisition if we acquired enough samples. */ | |
35e199da | 270 | if (devc->limit_samples && devc->num_samples >= devc->limit_samples) { |
79081ec8 UH |
271 | sr_info("Requested number of samples reached."); |
272 | sdi->driver->dev_acquisition_stop(sdi, cb_data); | |
273 | } | |
274 | ||
275 | return TRUE; | |
276 | } | |
fdbcb86d UH |
277 | |
278 | SR_PRIV int uni_t_ut61d_receive_data(int fd, int revents, void *cb_data) | |
279 | { | |
280 | return uni_t_dmm_receive_data(fd, revents, UNI_T_UT61D, cb_data); | |
281 | } | |
282 | ||
283 | SR_PRIV int voltcraft_vc820_receive_data(int fd, int revents, void *cb_data) | |
284 | { | |
285 | return uni_t_dmm_receive_data(fd, revents, VOLTCRAFT_VC820, cb_data); | |
286 | } |