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