]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/serial-dmm/api.c
projects / libsigrok.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
configure.ac: Fix build when libusb-1.0 not available.
[libsigrok.git] / hardware / serial-dmm / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
6 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#include <sys/types.h>
23#include <sys/stat.h>
24#include <fcntl.h>
25#include <string.h>
26#include <errno.h>
27#include <glib.h>
28#include "libsigrok.h"
29#include "libsigrok-internal.h"
30#include "protocol.h"
31
32static const int32_t hwopts[] = {
33 SR_CONF_CONN,
34 SR_CONF_SERIALCOMM,
35};
36
37static const int32_t hwcaps[] = {
38 SR_CONF_MULTIMETER,
39 SR_CONF_LIMIT_SAMPLES,
40 SR_CONF_LIMIT_MSEC,
41 SR_CONF_CONTINUOUS,
42};
43
44SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
45SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
46SR_PRIV struct sr_dev_driver metex_me31_driver_info;
47SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
48SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
49SR_PRIV struct sr_dev_driver va_va18b_driver_info;
50SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
51SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
52SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
53SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
54SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
55SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
56SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
57SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
58SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
59SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
60SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
61SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
62SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
63SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
64SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
65
66SR_PRIV struct dmm_info dmms[] = {
67 {
68 "Digitek", "DT4000ZC", "2400/8n1", 2400,
69 FS9721_PACKET_SIZE, NULL,
70 sr_fs9721_packet_valid, sr_fs9721_parse,
71 sr_fs9721_10_temp_c,
72 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
73 },
74 {
75 "TekPower", "TP4000ZC", "2400/8n1", 2400,
76 FS9721_PACKET_SIZE, NULL,
77 sr_fs9721_packet_valid, sr_fs9721_parse,
78 sr_fs9721_10_temp_c,
79 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
80 },
81 {
82 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
83 METEX14_PACKET_SIZE, sr_metex14_packet_request,
84 sr_metex14_packet_valid, sr_metex14_parse,
85 NULL,
86 &metex_me31_driver_info, receive_data_METEX_ME31,
87 },
88 {
89 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
90 METEX14_PACKET_SIZE, sr_metex14_packet_request,
91 sr_metex14_packet_valid, sr_metex14_parse,
92 NULL,
93 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
94 },
95 {
96 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
97 METEX14_PACKET_SIZE, sr_metex14_packet_request,
98 sr_metex14_packet_valid, sr_metex14_parse,
99 NULL,
100 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
101 },
102 {
103 "V&A", "VA18B", "2400/8n1", 2400,
104 FS9721_PACKET_SIZE, NULL,
105 sr_fs9721_packet_valid, sr_fs9721_parse,
106 sr_fs9721_01_temp_c,
107 &va_va18b_driver_info, receive_data_VA_VA18B,
108 },
109 {
110 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
111 METEX14_PACKET_SIZE, sr_metex14_packet_request,
112 sr_metex14_packet_valid, sr_metex14_parse,
113 NULL,
114 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
115 },
116 {
117 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
118 METEX14_PACKET_SIZE, sr_metex14_packet_request,
119 sr_metex14_packet_valid, sr_metex14_parse,
120 NULL,
121 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
122 },
123 {
124 "PCE", "PCE-DM32", "2400/8n1", 2400,
125 FS9721_PACKET_SIZE, NULL,
126 sr_fs9721_packet_valid, sr_fs9721_parse,
127 sr_fs9721_01_10_temp_f_c,
128 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
129 },
130 {
131 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
132 METEX14_PACKET_SIZE, sr_metex14_packet_request,
133 sr_metex14_packet_valid, sr_metex14_parse,
134 NULL,
135 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
136 },
137 {
138 "RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
139 METEX14_PACKET_SIZE, sr_metex14_packet_request,
140 sr_metex14_packet_valid, sr_metex14_parse,
141 NULL,
142 &radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
143 },
144 {
145 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
146 RS9LCD_PACKET_SIZE, NULL,
147 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
148 NULL,
149 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
150 },
151 {
152 "Tecpel", "DMM-8061 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
153 2400, FS9721_PACKET_SIZE, NULL,
154 sr_fs9721_packet_valid, sr_fs9721_parse,
155 sr_fs9721_00_temp_c,
156 &tecpel_dmm_8061_ser_driver_info,
157 receive_data_TECPEL_DMM_8061_SER,
158 },
159 {
160 "Voltcraft", "M-3650D", "1200/7n2/rts=0/dtr=1", 1200,
161 METEX14_PACKET_SIZE, sr_metex14_packet_request,
162 sr_metex14_packet_valid, sr_metex14_parse,
163 NULL,
164 &voltcraft_m3650d_driver_info, receive_data_VOLTCRAFT_M3650D,
165 },
166 {
167 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
168 2400, FS9721_PACKET_SIZE, NULL,
169 sr_fs9721_packet_valid, sr_fs9721_parse,
170 NULL,
171 &voltcraft_vc820_ser_driver_info,
172 receive_data_VOLTCRAFT_VC820_SER,
173 },
174 {
175 "Voltcraft", "VC-830 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
176 2400, FS9922_PACKET_SIZE, NULL,
177 sr_fs9922_packet_valid, sr_fs9922_parse,
178 NULL,
179 &voltcraft_vc830_ser_driver_info,
180 receive_data_VOLTCRAFT_VC830_SER,
181 },
182 {
183 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
184 2400, FS9721_PACKET_SIZE, NULL,
185 sr_fs9721_packet_valid, sr_fs9721_parse,
186 sr_fs9721_00_temp_c,
187 &voltcraft_vc840_ser_driver_info,
188 receive_data_VOLTCRAFT_VC840_SER,
189 },
190 {
191 "UNI-T", "UT60A (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
192 2400, FS9721_PACKET_SIZE, NULL,
193 sr_fs9721_packet_valid, sr_fs9721_parse,
194 NULL,
195 &uni_t_ut60a_ser_driver_info,
196 receive_data_UNI_T_UT60A_SER,
197 },
198 {
199 "UNI-T", "UT60E (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
200 2400, FS9721_PACKET_SIZE, NULL,
201 sr_fs9721_packet_valid, sr_fs9721_parse,
202 sr_fs9721_00_temp_c,
203 &uni_t_ut60e_ser_driver_info,
204 receive_data_UNI_T_UT60E_SER,
205 },
206 {
207 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
208 2400, FS9922_PACKET_SIZE, NULL,
209 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
210 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
211 },
212 {
213 /* Note: ES51922 baudrate is actually 19230! */
214 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
215 19200, ES51922_PACKET_SIZE, NULL,
216 sr_es51922_packet_valid, sr_es51922_parse, NULL,
217 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
218 },
219};
220
221static int dev_clear(int dmm)
222{
223 return std_dev_clear(dmms[dmm].di, NULL);
224}
225
226static int init(struct sr_context *sr_ctx, int dmm)
227{
228 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
229
230 return std_init(sr_ctx, dmms[dmm].di, LOG_PREFIX);
231}
232
233static GSList *sdmm_scan(const char *conn, const char *serialcomm, int dmm)
234{
235 struct sr_dev_inst *sdi;
236 struct drv_context *drvc;
237 struct dev_context *devc;
238 struct sr_probe *probe;
239 struct sr_serial_dev_inst *serial;
240 GSList *devices;
241 int dropped, ret;
242 size_t len;
243 uint8_t buf[128];
244
245 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
246 return NULL;
247
248 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
249 return NULL;
250
251 sr_info("Probing serial port %s.", conn);
252
253 drvc = dmms[dmm].di->priv;
254 devices = NULL;
255 serial_flush(serial);
256
257 /* Request a packet if the DMM requires this. */
258 if (dmms[dmm].packet_request) {
259 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
260 sr_err("Failed to request packet: %d.", ret);
261 return FALSE;
262 }
263 }
264
265 /*
266 * There's no way to get an ID from the multimeter. It just sends data
267 * periodically (or upon request), so the best we can do is check if
268 * the packets match the expected format.
269 */
270
271 /* Let's get a bit of data and see if we can find a packet. */
272 len = sizeof(buf);
273 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
274 dmms[dmm].packet_valid, 1000,
275 dmms[dmm].baudrate);
276 if (ret != SR_OK)
277 goto scan_cleanup;
278
279 /*
280 * If we dropped more than two packets worth of data, something is
281 * wrong. We shouldn't quit however, since the dropped bytes might be
282 * just zeroes at the beginning of the stream. Those can occur as a
283 * combination of the nonstandard cable that ships with some devices
284 * and the serial port or USB to serial adapter.
285 */
286 dropped = len - dmms[dmm].packet_size;
287 if (dropped > 2 * dmms[dmm].packet_size)
288 sr_warn("Had to drop too much data.");
289
290 sr_info("Found device on port %s.", conn);
291
292 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
293 dmms[dmm].device, "")))
294 goto scan_cleanup;
295
296 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
297 sr_err("Device context malloc failed.");
298 goto scan_cleanup;
299 }
300
301 sdi->inst_type = SR_INST_SERIAL;
302 sdi->conn = serial;
303
304 sdi->priv = devc;
305 sdi->driver = dmms[dmm].di;
306 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
307 goto scan_cleanup;
308 sdi->probes = g_slist_append(sdi->probes, probe);
309 drvc->instances = g_slist_append(drvc->instances, sdi);
310 devices = g_slist_append(devices, sdi);
311
312scan_cleanup:
313 serial_close(serial);
314
315 return devices;
316}
317
318static GSList *scan(GSList *options, int dmm)
319{
320 struct sr_config *src;
321 GSList *l, *devices;
322 const char *conn, *serialcomm;
323
324 conn = serialcomm = NULL;
325 for (l = options; l; l = l->next) {
326 src = l->data;
327 switch (src->key) {
328 case SR_CONF_CONN:
329 conn = g_variant_get_string(src->data, NULL);
330 break;
331 case SR_CONF_SERIALCOMM:
332 serialcomm = g_variant_get_string(src->data, NULL);
333 break;
334 }
335 }
336 if (!conn)
337 return NULL;
338
339 if (serialcomm) {
340 /* Use the provided comm specs. */
341 devices = sdmm_scan(conn, serialcomm, dmm);
342 } else {
343 /* Try the default. */
344 devices = sdmm_scan(conn, dmms[dmm].conn, dmm);
345 }
346
347 return devices;
348}
349
350static GSList *dev_list(int dmm)
351{
352 return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
353}
354
355static int dev_open(struct sr_dev_inst *sdi)
356{
357 struct sr_serial_dev_inst *serial;
358
359 serial = sdi->conn;
360 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
361 return SR_ERR;
362
363 sdi->status = SR_ST_ACTIVE;
364
365 return SR_OK;
366}
367
368static int dev_close(struct sr_dev_inst *sdi)
369{
370 struct sr_serial_dev_inst *serial;
371
372 serial = sdi->conn;
373 if (serial && serial->fd != -1) {
374 serial_close(serial);
375 sdi->status = SR_ST_INACTIVE;
376 }
377
378 return SR_OK;
379}
380
381static int cleanup(int dmm)
382{
383 return dev_clear(dmm);
384}
385
386static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
387{
388 struct dev_context *devc;
389
390 if (sdi->status != SR_ST_ACTIVE)
391 return SR_ERR_DEV_CLOSED;
392
393 if (!(devc = sdi->priv)) {
394 sr_err("sdi->priv was NULL.");
395 return SR_ERR_BUG;
396 }
397
398 switch (id) {
399 case SR_CONF_LIMIT_SAMPLES:
400 devc->limit_samples = g_variant_get_uint64(data);
401 sr_dbg("Setting sample limit to %" PRIu64 ".",
402 devc->limit_samples);
403 break;
404 case SR_CONF_LIMIT_MSEC:
405 devc->limit_msec = g_variant_get_uint64(data);
406 sr_dbg("Setting time limit to %" PRIu64 "ms.",
407 devc->limit_msec);
408 break;
409 default:
410 return SR_ERR_NA;
411 }
412
413 return SR_OK;
414}
415
416static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
417{
418
419 (void)sdi;
420
421 switch (key) {
422 case SR_CONF_SCAN_OPTIONS:
423 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
424 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
425 break;
426 case SR_CONF_DEVICE_OPTIONS:
427 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
428 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
429 break;
430 default:
431 return SR_ERR_NA;
432 }
433
434 return SR_OK;
435}
436
437static int dev_acquisition_start(const struct sr_dev_inst *sdi,
438 void *cb_data, int dmm)
439{
440 struct dev_context *devc;
441 struct sr_serial_dev_inst *serial;
442
443 if (sdi->status != SR_ST_ACTIVE)
444 return SR_ERR_DEV_CLOSED;
445
446 if (!(devc = sdi->priv)) {
447 sr_err("sdi->priv was NULL.");
448 return SR_ERR_BUG;
449 }
450
451 devc->cb_data = cb_data;
452
453 /*
454 * Reset the number of samples to take. If we've already collected our
455 * quota, but we start a new session, and don't reset this, we'll just
456 * quit without acquiring any new samples.
457 */
458 devc->num_samples = 0;
459 devc->starttime = g_get_monotonic_time();
460
461 /* Send header packet to the session bus. */
462 std_session_send_df_header(cb_data, LOG_PREFIX);
463
464 /* Poll every 50ms, or whenever some data comes in. */
465 serial = sdi->conn;
466 sr_source_add(serial->fd, G_IO_IN, 50,
467 dmms[dmm].receive_data, (void *)sdi);
468
469 return SR_OK;
470}
471
472static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
473{
474 return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
475 sdi->conn, LOG_PREFIX);
476}
477
478/* Driver-specific API function wrappers */
479#define HW_INIT(X) \
480static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
481#define HW_CLEANUP(X) \
482static int cleanup_##X(void) { return cleanup(X); }
483#define HW_SCAN(X) \
484static GSList *scan_##X(GSList *options) { return scan(options, X); }
485#define HW_DEV_LIST(X) \
486static GSList *dev_list_##X(void) { return dev_list(X); }
487#define HW_DEV_CLEAR(X) \
488static int dev_clear_##X(void) { return dev_clear(X); }
489#define HW_DEV_ACQUISITION_START(X) \
490static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
491void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
492
493/* Driver structs and API function wrappers */
494#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
495HW_INIT(ID_UPPER) \
496HW_CLEANUP(ID_UPPER) \
497HW_SCAN(ID_UPPER) \
498HW_DEV_LIST(ID_UPPER) \
499HW_DEV_CLEAR(ID_UPPER) \
500HW_DEV_ACQUISITION_START(ID_UPPER) \
501SR_PRIV struct sr_dev_driver ID##_driver_info = { \
502 .name = NAME, \
503 .longname = LONGNAME, \
504 .api_version = 1, \
505 .init = init_##ID_UPPER, \
506 .cleanup = cleanup_##ID_UPPER, \
507 .scan = scan_##ID_UPPER, \
508 .dev_list = dev_list_##ID_UPPER, \
509 .dev_clear = dev_clear_##ID_UPPER, \
510 .config_get = NULL, \
511 .config_set = config_set, \
512 .config_list = config_list, \
513 .dev_open = dev_open, \
514 .dev_close = dev_close, \
515 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
516 .dev_acquisition_stop = dev_acquisition_stop, \
517 .priv = NULL, \
518};
519
520DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
521DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
522DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
523DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
524DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
525DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
526DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
527DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
528DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
529DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
530DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
531DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
532DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
533DRV(voltcraft_m3650d, VOLTCRAFT_M3650D, "voltcraft-m3650d", "Voltcraft M-3650D")
534DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
535DRV(voltcraft_vc830_ser, VOLTCRAFT_VC830_SER, "voltcraft-vc830-ser", "Voltcraft VC-830 (UT-D02 cable)")
536DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
537DRV(uni_t_ut60a_ser, UNI_T_UT60A_SER, "uni-t-ut60a-ser", "UNI-T UT60A (UT-D02 cable)")
538DRV(uni_t_ut60e_ser, UNI_T_UT60E_SER, "uni-t-ut60e-ser", "UNI-T UT60E (UT-D02 cable)")
539DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
540DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")
Hardware access and backend lib