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