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