]> sigrok.org Git - libsigrok.git/blame - hardware/uni-t-dmm/api.c
Add initial support for the UNI-T UT60G.
[libsigrok.git] / hardware / uni-t-dmm / api.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 <stdlib.h>
22#include <string.h>
23#include "libsigrok.h"
24#include "libsigrok-internal.h"
25#include "protocol.h"
26
388f9d3e
UH
27#define UNI_T_UT_D04_NEW "1a86.e008"
28
7d93a62e 29static const int32_t hwopts[] = {
431ec7ca 30 SR_CONF_CONN,
73365eae
UH
31};
32
7d93a62e 33static const int32_t hwcaps[] = {
1953564a
BV
34 SR_CONF_MULTIMETER,
35 SR_CONF_LIMIT_SAMPLES,
36 SR_CONF_LIMIT_MSEC,
37 SR_CONF_CONTINUOUS,
79081ec8
UH
38};
39
b6bad47c 40SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
a7a163a7
FK
41SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
42SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
4104ef81 43SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
7cb69b18 44SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
5f985df2 45SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
fdbcb86d 46SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
bbef5e32 47SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
fdbcb86d 48SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
c1345749 49SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
695d0e1e 50SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
5e1f7c89 51SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
6ac5f892 52
c8852687 53SR_PRIV struct dmm_info udmms[] = {
b6bad47c
UH
54 {
55 "Tecpel", "DMM-8061", 2400,
26e0361c 56 FS9721_PACKET_SIZE,
b6bad47c
UH
57 sr_fs9721_packet_valid, sr_fs9721_parse,
58 sr_fs9721_00_temp_c,
59 &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
60 },
a7a163a7
FK
61 {
62 "UNI-T", "UT60A", 2400,
26e0361c 63 FS9721_PACKET_SIZE,
a7a163a7
FK
64 sr_fs9721_packet_valid, sr_fs9721_parse,
65 NULL,
66 &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
67 },
68 {
69 "UNI-T", "UT60E", 2400,
26e0361c 70 FS9721_PACKET_SIZE,
a7a163a7
FK
71 sr_fs9721_packet_valid, sr_fs9721_parse,
72 sr_fs9721_00_temp_c,
73 &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
74 },
4104ef81
UH
75 {
76 /*
77 * Important: The actual baudrate of the Cyrustek ES51986 chip
78 * used in this DMM is 19230. However, the WCH CH9325 chip
79 * (UART to USB/HID) used in (some versions of) the UNI-T
80 * UT-D04 cable doesn't support 19230 baud. It only supports
81 * 19200, and setting an unsupported baudrate will result in
82 * the default of 2400 being used (which will not work with
83 * this DMM, of course).
84 */
85 "UNI-T", "UT60G", 19200,
86 ES519XX_11B_PACKET_SIZE,
87 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
88 NULL,
89 &uni_t_ut60g_driver_info, receive_data_UNI_T_UT60G,
90 },
5f985df2 91 {
79bc9924 92 "UNI-T", "UT61B", 2400,
5f985df2
UH
93 FS9922_PACKET_SIZE,
94 sr_fs9922_packet_valid, sr_fs9922_parse,
95 NULL,
79bc9924 96 &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
5f985df2 97 },
7cb69b18 98 {
79bc9924 99 "UNI-T", "UT61C", 2400,
7cb69b18
UH
100 FS9922_PACKET_SIZE,
101 sr_fs9922_packet_valid, sr_fs9922_parse,
102 NULL,
79bc9924 103 &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
7cb69b18 104 },
c8852687 105 {
767aae30 106 "UNI-T", "UT61D", 2400,
26e0361c 107 FS9922_PACKET_SIZE,
c8852687
UH
108 sr_fs9922_packet_valid, sr_fs9922_parse,
109 NULL,
110 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
111 },
bbef5e32 112 {
4d7ddff7
UH
113 /*
114 * Important: The actual baudrate of the Cyrustek ES51922 chip
115 * used in this DMM is 19230. However, the WCH CH9325 chip
116 * (UART to USB/HID) used in (some versions of) the UNI-T
117 * UT-D04 cable doesn't support 19230 baud. It only supports
118 * 19200, and setting an unsupported baudrate will result in
119 * the default of 2400 being used (which will not work with
120 * this DMM, of course).
121 */
122 "UNI-T", "UT61E", 19200,
d97824e5
AJ
123 ES519XX_14B_PACKET_SIZE,
124 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
bbef5e32
UH
125 NULL,
126 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
127 },
c8852687 128 {
bc653a56 129 "Voltcraft", "VC-820", 2400,
26e0361c 130 FS9721_PACKET_SIZE,
c8852687
UH
131 sr_fs9721_packet_valid, sr_fs9721_parse,
132 NULL,
133 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
134 },
c1345749 135 {
e52bb9be
UH
136 /*
137 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
138 * the FS9922 protocol. Instead, it only sets the user-defined
139 * bit "z1" to indicate "diode mode" and "voltage".
140 */
c1345749 141 "Voltcraft", "VC-830", 2400,
26e0361c 142 FS9922_PACKET_SIZE,
c1345749 143 sr_fs9922_packet_valid, sr_fs9922_parse,
e52bb9be 144 &sr_fs9922_z1_diode,
c1345749
UH
145 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
146 },
695d0e1e
UH
147 {
148 "Voltcraft", "VC-840", 2400,
26e0361c 149 FS9721_PACKET_SIZE,
695d0e1e 150 sr_fs9721_packet_valid, sr_fs9721_parse,
2451a20f 151 sr_fs9721_00_temp_c,
695d0e1e
UH
152 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
153 },
5e1f7c89
BV
154 {
155 "Tenma", "72-7745", 2400,
156 FS9721_PACKET_SIZE,
157 sr_fs9721_packet_valid, sr_fs9721_parse,
158 sr_fs9721_00_temp_c,
159 &tenma_72_7745_driver_info,
160 /* This is a basic rebadge of the UT60E. */
161 receive_data_UNI_T_UT60E,
162 },
c8852687 163};
6ac5f892 164
3b412e3a 165static int dev_clear(int dmm)
79081ec8 166{
8dca646e 167 return std_dev_clear(udmms[dmm].di, NULL);
79081ec8
UH
168}
169
6078d2c9 170static int init(struct sr_context *sr_ctx, int dmm)
79081ec8 171{
c8852687 172 sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
6ac5f892 173
f6beaac5 174 return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
fdbcb86d
UH
175}
176
6078d2c9 177static GSList *scan(GSList *options, int dmm)
79081ec8 178{
388f9d3e 179 GSList *usb_devices, *devices, *l;
79081ec8 180 struct sr_dev_inst *sdi;
41d9427f 181 struct dev_context *devc;
79081ec8 182 struct drv_context *drvc;
388f9d3e 183 struct sr_usb_dev_inst *usb;
431ec7ca 184 struct sr_config *src;
41d9427f 185 struct sr_probe *probe;
388f9d3e 186 const char *conn;
79081ec8 187
c8852687 188 drvc = udmms[dmm].di->priv;
79081ec8 189
388f9d3e
UH
190 conn = NULL;
191 for (l = options; l; l = l->next) {
431ec7ca
BV
192 src = l->data;
193 switch (src->key) {
194 case SR_CONF_CONN:
7d93a62e 195 conn = g_variant_get_string(src->data, NULL);
388f9d3e
UH
196 break;
197 }
198 }
199 if (!conn)
56e76981 200 return NULL;
41d9427f 201
388f9d3e
UH
202 devices = NULL;
203 if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
204 g_slist_free_full(usb_devices, g_free);
79081ec8 205 return NULL;
388f9d3e 206 }
79081ec8 207
388f9d3e
UH
208 for (l = usb_devices; l; l = l->next) {
209 usb = l->data;
41d9427f
UH
210
211 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
212 sr_err("Device context malloc failed.");
213 return NULL;
214 }
215
bc653a56
UH
216 devc->first_run = TRUE;
217
388f9d3e 218 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
c8852687 219 udmms[dmm].vendor, udmms[dmm].device, NULL))) {
41d9427f
UH
220 sr_err("sr_dev_inst_new returned NULL.");
221 return NULL;
222 }
223 sdi->priv = devc;
c8852687 224 sdi->driver = udmms[dmm].di;
41d9427f
UH
225 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
226 return NULL;
227 sdi->probes = g_slist_append(sdi->probes, probe);
388f9d3e 228
3ece1dff
UH
229 sdi->inst_type = SR_INST_USB;
230 sdi->conn = usb;
388f9d3e
UH
231
232 drvc->instances = g_slist_append(drvc->instances, sdi);
41d9427f 233 devices = g_slist_append(devices, sdi);
79081ec8
UH
234 }
235
236 return devices;
237}
238
6078d2c9 239static GSList *dev_list(int dmm)
79081ec8 240{
bc653a56 241 return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
79081ec8
UH
242}
243
6078d2c9 244static int dev_open(struct sr_dev_inst *sdi, int dmm)
79081ec8 245{
388f9d3e 246 struct drv_context *drvc;
3ece1dff 247 struct sr_usb_dev_inst *usb;
bc653a56 248 int ret;
41d9427f 249
c8852687 250 drvc = udmms[dmm].di->priv;
3ece1dff 251 usb = sdi->conn;
41d9427f 252
3ece1dff 253 if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
bc653a56 254 sdi->status = SR_ST_ACTIVE;
e73ffd42 255
bc653a56 256 return ret;
79081ec8
UH
257}
258
6078d2c9 259static int dev_close(struct sr_dev_inst *sdi)
79081ec8
UH
260{
261 (void)sdi;
262
263 /* TODO */
264
bc653a56 265 sdi->status = SR_ST_INACTIVE;
e73ffd42 266
79081ec8
UH
267 return SR_OK;
268}
269
6078d2c9 270static int cleanup(int dmm)
79081ec8 271{
3b412e3a 272 return dev_clear(dmm);
79081ec8
UH
273}
274
8f996b89
ML
275static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
276 const struct sr_probe_group *probe_group)
79081ec8
UH
277{
278 struct dev_context *devc;
279
8f996b89
ML
280 (void)probe_group;
281
79081ec8
UH
282 devc = sdi->priv;
283
035a1078 284 switch (id) {
1953564a 285 case SR_CONF_LIMIT_MSEC:
7d93a62e 286 if (g_variant_get_uint64(data) == 0) {
79081ec8
UH
287 sr_err("Time limit cannot be 0.");
288 return SR_ERR;
289 }
7d93a62e 290 devc->limit_msec = g_variant_get_uint64(data);
79081ec8
UH
291 sr_dbg("Setting time limit to %" PRIu64 "ms.",
292 devc->limit_msec);
293 break;
1953564a 294 case SR_CONF_LIMIT_SAMPLES:
7d93a62e 295 if (g_variant_get_uint64(data) == 0) {
79081ec8
UH
296 sr_err("Sample limit cannot be 0.");
297 return SR_ERR;
298 }
7d93a62e 299 devc->limit_samples = g_variant_get_uint64(data);
79081ec8
UH
300 sr_dbg("Setting sample limit to %" PRIu64 ".",
301 devc->limit_samples);
302 break;
303 default:
bd6fbf62 304 return SR_ERR_NA;
79081ec8
UH
305 }
306
307 return SR_OK;
308}
309
8f996b89
ML
310static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
311 const struct sr_probe_group *probe_group)
a1c743fc 312{
a1c743fc 313 (void)sdi;
8f996b89 314 (void)probe_group;
a1c743fc
BV
315
316 switch (key) {
0d485e30 317 case SR_CONF_SCAN_OPTIONS:
7d93a62e
BV
318 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
319 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
0d485e30 320 break;
9a6517d1 321 case SR_CONF_DEVICE_OPTIONS:
7d93a62e
BV
322 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
323 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 324 break;
a1c743fc 325 default:
bd6fbf62 326 return SR_ERR_NA;
a1c743fc
BV
327 }
328
329 return SR_OK;
330}
331
6078d2c9 332static int dev_acquisition_start(const struct sr_dev_inst *sdi,
c8852687 333 void *cb_data, int dmm)
79081ec8 334{
79081ec8
UH
335 struct dev_context *devc;
336
337 devc = sdi->priv;
338
79081ec8
UH
339 devc->cb_data = cb_data;
340
c5ffac41
UH
341 devc->starttime = g_get_monotonic_time();
342
79081ec8 343 /* Send header packet to the session bus. */
29a27196 344 std_session_send_df_header(cb_data, LOG_PREFIX);
79081ec8 345
c8852687
UH
346 sr_source_add(0, 0, 10 /* poll_timeout */,
347 udmms[dmm].receive_data, (void *)sdi);
79081ec8
UH
348
349 return SR_OK;
350}
351
6078d2c9 352static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
79081ec8
UH
353{
354 struct sr_datafeed_packet packet;
355
356 (void)sdi;
357
358 sr_dbg("Stopping acquisition.");
359
360 /* Send end packet to the session bus. */
361 sr_dbg("Sending SR_DF_END.");
362 packet.type = SR_DF_END;
363 sr_session_send(cb_data, &packet);
364
365 /* TODO? */
366 sr_source_remove(0);
367
368 return SR_OK;
369}
370
c8852687
UH
371/* Driver-specific API function wrappers */
372#define HW_INIT(X) \
6078d2c9 373static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
c8852687 374#define HW_CLEANUP(X) \
6078d2c9 375static int cleanup_##X(void) { return cleanup(X); }
c8852687 376#define HW_SCAN(X) \
6078d2c9 377static GSList *scan_##X(GSList *options) { return scan(options, X); }
c8852687 378#define HW_DEV_LIST(X) \
6078d2c9 379static GSList *dev_list_##X(void) { return dev_list(X); }
3b412e3a
UH
380#define HW_DEV_CLEAR(X) \
381static int dev_clear_##X(void) { return dev_clear(X); }
c8852687 382#define HW_DEV_ACQUISITION_START(X) \
6078d2c9
UH
383static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
384void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
c8852687 385#define HW_DEV_OPEN(X) \
6078d2c9 386static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
c8852687
UH
387
388/* Driver structs and API function wrappers */
389#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
390HW_INIT(ID_UPPER) \
391HW_CLEANUP(ID_UPPER) \
392HW_SCAN(ID_UPPER) \
393HW_DEV_LIST(ID_UPPER) \
3b412e3a 394HW_DEV_CLEAR(ID_UPPER) \
c8852687
UH
395HW_DEV_ACQUISITION_START(ID_UPPER) \
396HW_DEV_OPEN(ID_UPPER) \
397SR_PRIV struct sr_dev_driver ID##_driver_info = { \
398 .name = NAME, \
399 .longname = LONGNAME, \
400 .api_version = 1, \
6078d2c9
UH
401 .init = init_##ID_UPPER, \
402 .cleanup = cleanup_##ID_UPPER, \
403 .scan = scan_##ID_UPPER, \
404 .dev_list = dev_list_##ID_UPPER, \
3b412e3a 405 .dev_clear = dev_clear_##ID_UPPER, \
c8852687
UH
406 .config_get = NULL, \
407 .config_set = config_set, \
408 .config_list = config_list, \
6078d2c9
UH
409 .dev_open = dev_open_##ID_UPPER, \
410 .dev_close = dev_close, \
411 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
412 .dev_acquisition_stop = dev_acquisition_stop, \
c8852687 413 .priv = NULL, \
fdbcb86d
UH
414};
415
b6bad47c 416DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
a7a163a7
FK
417DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
418DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
4104ef81 419DRV(uni_t_ut60g, UNI_T_UT60G, "uni-t-ut60g", "UNI-T UT60G")
7cb69b18 420DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
5f985df2 421DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
c8852687 422DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
bbef5e32 423DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
c8852687 424DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
c1345749 425DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
695d0e1e 426DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
5e1f7c89 427DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")