]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/uni-t-dmm/api.c
Add initial Voltcraft VC-870 support.
[libsigrok.git] / src / hardware / uni-t-dmm / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012-2013 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 <stdlib.h>
22#include <string.h>
23#include "libsigrok.h"
24#include "libsigrok-internal.h"
25#include "protocol.h"
26
27#define UNI_T_UT_D04_NEW "1a86.e008"
28
29static const uint32_t scanopts[] = {
30 SR_CONF_CONN,
31};
32
33static const uint32_t devopts[] = {
34 SR_CONF_MULTIMETER,
35 SR_CONF_CONTINUOUS,
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
38};
39
40SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
41SR_PRIV struct sr_dev_driver uni_t_ut372_driver_info;
42SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
43SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
44SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
45SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
46SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
47SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
48SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
49SR_PRIV struct sr_dev_driver uni_t_ut71a_driver_info;
50SR_PRIV struct sr_dev_driver uni_t_ut71b_driver_info;
51SR_PRIV struct sr_dev_driver uni_t_ut71c_driver_info;
52SR_PRIV struct sr_dev_driver uni_t_ut71d_driver_info;
53SR_PRIV struct sr_dev_driver uni_t_ut71e_driver_info;
54SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
55SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
56SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
57SR_PRIV struct sr_dev_driver voltcraft_vc870_driver_info;
58SR_PRIV struct sr_dev_driver voltcraft_vc920_driver_info;
59SR_PRIV struct sr_dev_driver voltcraft_vc940_driver_info;
60SR_PRIV struct sr_dev_driver voltcraft_vc960_driver_info;
61SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
62SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
63
64SR_PRIV struct dmm_info udmms[] = {
65 {
66 "Tecpel", "DMM-8061", 2400,
67 FS9721_PACKET_SIZE,
68 sr_fs9721_packet_valid, sr_fs9721_parse,
69 sr_fs9721_00_temp_c,
70 &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
71 },
72 {
73 "UNI-T", "UT372", 2400,
74 UT372_PACKET_SIZE,
75 sr_ut372_packet_valid, sr_ut372_parse,
76 NULL,
77 &uni_t_ut372_driver_info, receive_data_UNI_T_UT372,
78 },
79 {
80 "UNI-T", "UT60A", 2400,
81 FS9721_PACKET_SIZE,
82 sr_fs9721_packet_valid, sr_fs9721_parse,
83 NULL,
84 &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
85 },
86 {
87 "UNI-T", "UT60E", 2400,
88 FS9721_PACKET_SIZE,
89 sr_fs9721_packet_valid, sr_fs9721_parse,
90 sr_fs9721_00_temp_c,
91 &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
92 },
93 {
94 /* The baudrate is actually 19230, see "Note 1" below. */
95 "UNI-T", "UT60G", 19200,
96 ES519XX_11B_PACKET_SIZE,
97 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
98 NULL,
99 &uni_t_ut60g_driver_info, receive_data_UNI_T_UT60G,
100 },
101 {
102 "UNI-T", "UT61B", 2400,
103 FS9922_PACKET_SIZE,
104 sr_fs9922_packet_valid, sr_fs9922_parse,
105 NULL,
106 &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
107 },
108 {
109 "UNI-T", "UT61C", 2400,
110 FS9922_PACKET_SIZE,
111 sr_fs9922_packet_valid, sr_fs9922_parse,
112 NULL,
113 &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
114 },
115 {
116 "UNI-T", "UT61D", 2400,
117 FS9922_PACKET_SIZE,
118 sr_fs9922_packet_valid, sr_fs9922_parse,
119 NULL,
120 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
121 },
122 {
123 /* The baudrate is actually 19230, see "Note 1" below. */
124 "UNI-T", "UT61E", 19200,
125 ES519XX_14B_PACKET_SIZE,
126 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
127 NULL,
128 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
129 },
130 {
131 "UNI-T", "UT71A", 2400, UT71X_PACKET_SIZE,
132 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
133 &uni_t_ut71a_driver_info, receive_data_UNI_T_UT71A,
134 },
135 {
136 "UNI-T", "UT71B", 2400, UT71X_PACKET_SIZE,
137 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
138 &uni_t_ut71b_driver_info, receive_data_UNI_T_UT71B,
139 },
140 {
141 "UNI-T", "UT71C", 2400, UT71X_PACKET_SIZE,
142 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
143 &uni_t_ut71c_driver_info, receive_data_UNI_T_UT71C,
144 },
145 {
146 "UNI-T", "UT71D", 2400, UT71X_PACKET_SIZE,
147 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
148 &uni_t_ut71d_driver_info, receive_data_UNI_T_UT71D,
149 },
150 {
151 "UNI-T", "UT71E", 2400, UT71X_PACKET_SIZE,
152 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
153 &uni_t_ut71e_driver_info, receive_data_UNI_T_UT71E,
154 },
155 {
156 "Voltcraft", "VC-820", 2400,
157 FS9721_PACKET_SIZE,
158 sr_fs9721_packet_valid, sr_fs9721_parse,
159 NULL,
160 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
161 },
162 {
163 /*
164 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
165 * the FS9922 protocol. Instead, it only sets the user-defined
166 * bit "z1" to indicate "diode mode" and "voltage".
167 */
168 "Voltcraft", "VC-830", 2400,
169 FS9922_PACKET_SIZE,
170 sr_fs9922_packet_valid, sr_fs9922_parse,
171 &sr_fs9922_z1_diode,
172 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
173 },
174 {
175 "Voltcraft", "VC-840", 2400,
176 FS9721_PACKET_SIZE,
177 sr_fs9721_packet_valid, sr_fs9721_parse,
178 sr_fs9721_00_temp_c,
179 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
180 },
181 {
182 "Voltcraft", "VC-870", 9600, VC870_PACKET_SIZE,
183 sr_vc870_packet_valid, sr_vc870_parse, NULL,
184 &voltcraft_vc870_driver_info, receive_data_VOLTCRAFT_VC870,
185 },
186 {
187 "Voltcraft", "VC-920", 2400, UT71X_PACKET_SIZE,
188 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
189 &voltcraft_vc920_driver_info, receive_data_VOLTCRAFT_VC920,
190 },
191 {
192 "Voltcraft", "VC-940", 2400, UT71X_PACKET_SIZE,
193 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
194 &voltcraft_vc940_driver_info, receive_data_VOLTCRAFT_VC940,
195 },
196 {
197 "Voltcraft", "VC-960", 2400, UT71X_PACKET_SIZE,
198 sr_ut71x_packet_valid, sr_ut71x_parse, NULL,
199 &voltcraft_vc960_driver_info, receive_data_VOLTCRAFT_VC960,
200 },
201 {
202 "Tenma", "72-7745", 2400,
203 FS9721_PACKET_SIZE,
204 sr_fs9721_packet_valid, sr_fs9721_parse,
205 sr_fs9721_00_temp_c,
206 &tenma_72_7745_driver_info, receive_data_TENMA_72_7745,
207 },
208 {
209 /* The baudrate is actually 19230, see "Note 1" below. */
210 "Tenma", "72-7750", 19200,
211 ES519XX_11B_PACKET_SIZE,
212 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
213 NULL,
214 &tenma_72_7750_driver_info, receive_data_TENMA_72_7750,
215 },
216};
217
218/*
219 * Note 1: The actual baudrate of the Cyrustek ES519xx chip used in this DMM
220 * is 19230. However, the WCH CH9325 chip (UART to USB/HID) used in (some
221 * versions of) the UNI-T UT-D04 cable doesn't support 19230 baud. It only
222 * supports 19200, and setting an unsupported baudrate will result in the
223 * default of 2400 being used (which will not work with this DMM, of course).
224 */
225
226static int dev_clear(int dmm)
227{
228 return std_dev_clear(udmms[dmm].di, NULL);
229}
230
231static int init(struct sr_context *sr_ctx, int dmm)
232{
233 return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
234}
235
236static GSList *scan(GSList *options, int dmm)
237{
238 GSList *usb_devices, *devices, *l;
239 struct sr_dev_inst *sdi;
240 struct dev_context *devc;
241 struct drv_context *drvc;
242 struct sr_usb_dev_inst *usb;
243 struct sr_config *src;
244 const char *conn;
245
246 drvc = udmms[dmm].di->priv;
247
248 conn = NULL;
249 for (l = options; l; l = l->next) {
250 src = l->data;
251 switch (src->key) {
252 case SR_CONF_CONN:
253 conn = g_variant_get_string(src->data, NULL);
254 break;
255 }
256 }
257 if (!conn)
258 return NULL;
259
260 devices = NULL;
261 if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
262 g_slist_free_full(usb_devices, g_free);
263 return NULL;
264 }
265
266 for (l = usb_devices; l; l = l->next) {
267 usb = l->data;
268 devc = g_malloc0(sizeof(struct dev_context));
269 devc->first_run = TRUE;
270 sdi = g_malloc0(sizeof(struct sr_dev_inst));
271 sdi->status = SR_ST_INACTIVE;
272 sdi->vendor = g_strdup(udmms[dmm].vendor);
273 sdi->model = g_strdup(udmms[dmm].device);
274 sdi->priv = devc;
275 sdi->driver = udmms[dmm].di;
276 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
277 sdi->inst_type = SR_INST_USB;
278 sdi->conn = usb;
279 drvc->instances = g_slist_append(drvc->instances, sdi);
280 devices = g_slist_append(devices, sdi);
281 }
282
283 return devices;
284}
285
286static GSList *dev_list(int dmm)
287{
288 return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
289}
290
291static int dev_open(struct sr_dev_inst *sdi, int dmm)
292{
293 struct drv_context *drvc;
294 struct sr_usb_dev_inst *usb;
295 int ret;
296
297 drvc = udmms[dmm].di->priv;
298 usb = sdi->conn;
299
300 if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
301 sdi->status = SR_ST_ACTIVE;
302
303 return ret;
304}
305
306static int dev_close(struct sr_dev_inst *sdi)
307{
308 /* TODO */
309
310 sdi->status = SR_ST_INACTIVE;
311
312 return SR_OK;
313}
314
315static int cleanup(int dmm)
316{
317 return dev_clear(dmm);
318}
319
320static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
321 const struct sr_channel_group *cg)
322{
323 struct dev_context *devc;
324
325 (void)cg;
326
327 devc = sdi->priv;
328
329 switch (key) {
330 case SR_CONF_LIMIT_MSEC:
331 if (g_variant_get_uint64(data) == 0) {
332 sr_err("Time limit cannot be 0.");
333 return SR_ERR;
334 }
335 devc->limit_msec = g_variant_get_uint64(data);
336 sr_dbg("Setting time limit to %" PRIu64 "ms.",
337 devc->limit_msec);
338 break;
339 case SR_CONF_LIMIT_SAMPLES:
340 if (g_variant_get_uint64(data) == 0) {
341 sr_err("Sample limit cannot be 0.");
342 return SR_ERR;
343 }
344 devc->limit_samples = g_variant_get_uint64(data);
345 sr_dbg("Setting sample limit to %" PRIu64 ".",
346 devc->limit_samples);
347 break;
348 default:
349 return SR_ERR_NA;
350 }
351
352 return SR_OK;
353}
354
355static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
356 const struct sr_channel_group *cg)
357{
358 (void)sdi;
359 (void)cg;
360
361 switch (key) {
362 case SR_CONF_SCAN_OPTIONS:
363 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
364 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
365 break;
366 case SR_CONF_DEVICE_OPTIONS:
367 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
368 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
369 break;
370 default:
371 return SR_ERR_NA;
372 }
373
374 return SR_OK;
375}
376
377static int dev_acquisition_start(const struct sr_dev_inst *sdi,
378 void *cb_data, int dmm)
379{
380 struct dev_context *devc;
381
382 devc = sdi->priv;
383
384 devc->cb_data = cb_data;
385
386 devc->starttime = g_get_monotonic_time();
387
388 /* Send header packet to the session bus. */
389 std_session_send_df_header(sdi, LOG_PREFIX);
390
391 sr_session_source_add(sdi->session, 0, 0, 10 /* poll_timeout */,
392 udmms[dmm].receive_data, (void *)sdi);
393
394 return SR_OK;
395}
396
397static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
398{
399 struct sr_datafeed_packet packet;
400
401 (void)cb_data;
402
403 sr_dbg("Stopping acquisition.");
404
405 /* Send end packet to the session bus. */
406 sr_dbg("Sending SR_DF_END.");
407 packet.type = SR_DF_END;
408 sr_session_send(sdi, &packet);
409
410 sr_session_source_remove(sdi->session, 0);
411
412 return SR_OK;
413}
414
415/* Driver-specific API function wrappers */
416#define HW_INIT(X) \
417static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
418#define HW_CLEANUP(X) \
419static int cleanup_##X(void) { return cleanup(X); }
420#define HW_SCAN(X) \
421static GSList *scan_##X(GSList *options) { return scan(options, X); }
422#define HW_DEV_LIST(X) \
423static GSList *dev_list_##X(void) { return dev_list(X); }
424#define HW_DEV_CLEAR(X) \
425static int dev_clear_##X(void) { return dev_clear(X); }
426#define HW_DEV_ACQUISITION_START(X) \
427static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
428void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
429#define HW_DEV_OPEN(X) \
430static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
431
432/* Driver structs and API function wrappers */
433#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
434HW_INIT(ID_UPPER) \
435HW_CLEANUP(ID_UPPER) \
436HW_SCAN(ID_UPPER) \
437HW_DEV_LIST(ID_UPPER) \
438HW_DEV_CLEAR(ID_UPPER) \
439HW_DEV_ACQUISITION_START(ID_UPPER) \
440HW_DEV_OPEN(ID_UPPER) \
441SR_PRIV struct sr_dev_driver ID##_driver_info = { \
442 .name = NAME, \
443 .longname = LONGNAME, \
444 .api_version = 1, \
445 .init = init_##ID_UPPER, \
446 .cleanup = cleanup_##ID_UPPER, \
447 .scan = scan_##ID_UPPER, \
448 .dev_list = dev_list_##ID_UPPER, \
449 .dev_clear = dev_clear_##ID_UPPER, \
450 .config_get = NULL, \
451 .config_set = config_set, \
452 .config_list = config_list, \
453 .dev_open = dev_open_##ID_UPPER, \
454 .dev_close = dev_close, \
455 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
456 .dev_acquisition_stop = dev_acquisition_stop, \
457 .priv = NULL, \
458};
459
460DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
461DRV(uni_t_ut372, UNI_T_UT372, "uni-t-ut372", "UNI-T UT372")
462DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
463DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
464DRV(uni_t_ut60g, UNI_T_UT60G, "uni-t-ut60g", "UNI-T UT60G")
465DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
466DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
467DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
468DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
469DRV(uni_t_ut71a, UNI_T_UT71A, "uni-t-ut71a", "UNI-T UT71A")
470DRV(uni_t_ut71b, UNI_T_UT71B, "uni-t-ut71b", "UNI-T UT71B")
471DRV(uni_t_ut71c, UNI_T_UT71C, "uni-t-ut71c", "UNI-T UT71C")
472DRV(uni_t_ut71d, UNI_T_UT71D, "uni-t-ut71d", "UNI-T UT71D")
473DRV(uni_t_ut71e, UNI_T_UT71E, "uni-t-ut71e", "UNI-T UT71E")
474DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
475DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
476DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
477DRV(voltcraft_vc870, VOLTCRAFT_VC870, "voltcraft-vc870", "Voltcraft VC-870")
478DRV(voltcraft_vc920, VOLTCRAFT_VC920, "voltcraft-vc920", "Voltcraft VC-920")
479DRV(voltcraft_vc940, VOLTCRAFT_VC940, "voltcraft-vc940", "Voltcraft VC-940")
480DRV(voltcraft_vc960, VOLTCRAFT_VC960, "voltcraft-vc960", "Voltcraft VC-960")
481DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")
482DRV(tenma_72_7750, TENMA_72_7750, "tenma-72-7750", "Tenma 72-7750")