2 * This file is part of the sigrok project.
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>
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.
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.
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/>.
22 #include <sys/types.h>
28 #include "libsigrok.h"
29 #include "libsigrok-internal.h"
32 static const int hwopts[] = {
38 static const int hwcaps[] = {
40 SR_HWCAP_LIMIT_SAMPLES,
45 static const char *probe_names[] = {
50 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
51 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
52 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
53 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
54 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
55 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
56 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
57 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
58 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
59 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
60 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
62 SR_PRIV struct dmm_info dmms[] = {
64 "Digitek", "DT4000ZC", "2400/8n1", 2400,
65 FS9721_PACKET_SIZE, NULL,
66 sr_fs9721_packet_valid, sr_fs9721_parse,
68 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
71 "TekPower", "TP4000ZC", "2400/8n1", 2400,
72 FS9721_PACKET_SIZE, NULL,
73 sr_fs9721_packet_valid, sr_fs9721_parse,
75 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
78 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
79 METEX14_PACKET_SIZE, sr_metex14_packet_request,
80 sr_metex14_packet_valid, sr_metex14_parse,
82 &metex_me31_driver_info, receive_data_METEX_ME31,
85 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
86 METEX14_PACKET_SIZE, sr_metex14_packet_request,
87 sr_metex14_packet_valid, sr_metex14_parse,
89 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
92 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
93 METEX14_PACKET_SIZE, sr_metex14_packet_request,
94 sr_metex14_packet_valid, sr_metex14_parse,
96 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
99 "V&A", "VA18B", "2400/8n1", 2400,
100 FS9721_PACKET_SIZE, NULL,
101 sr_fs9721_packet_valid, sr_fs9721_parse,
103 &va_va18b_driver_info, receive_data_VA_VA18B,
106 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
107 METEX14_PACKET_SIZE, sr_metex14_packet_request,
108 sr_metex14_packet_valid, sr_metex14_parse,
110 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
113 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
114 METEX14_PACKET_SIZE, sr_metex14_packet_request,
115 sr_metex14_packet_valid, sr_metex14_parse,
117 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
120 "PCE", "PCE-DM32", "2400/8n1", 2400,
121 FS9721_PACKET_SIZE, NULL,
122 sr_fs9721_packet_valid, sr_fs9721_parse,
123 dmm_details_pce_dm32,
124 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
127 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
128 METEX14_PACKET_SIZE, sr_metex14_packet_request,
129 sr_metex14_packet_valid, sr_metex14_parse,
131 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
134 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
135 RS9LCD_PACKET_SIZE, NULL,
136 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
138 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
142 /* Properly close and free all devices. */
143 static int clear_instances(int dmm)
145 struct sr_dev_inst *sdi;
146 struct drv_context *drvc;
147 struct dev_context *devc;
149 struct sr_dev_driver *di;
153 if (!(drvc = di->priv))
157 for (l = drvc->instances; l; l = l->next) {
158 if (!(sdi = l->data))
160 if (!(devc = sdi->priv))
162 sr_serial_dev_inst_free(devc->serial);
163 sr_dev_inst_free(sdi);
165 g_slist_free(drvc->instances);
166 drvc->instances = NULL;
171 static int hw_init(struct sr_context *sr_ctx, int dmm)
173 struct drv_context *drvc;
175 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
176 sr_err("Driver context malloc failed.");
177 return SR_ERR_MALLOC;
180 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
182 drvc->sr_ctx = sr_ctx;
183 dmms[dmm].di->priv = drvc;
188 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
190 struct sr_dev_inst *sdi;
191 struct drv_context *drvc;
192 struct dev_context *devc;
193 struct sr_probe *probe;
194 struct sr_serial_dev_inst *serial;
200 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
203 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
206 sr_info("Probing serial port %s.", conn);
208 drvc = dmms[dmm].di->priv;
210 serial_flush(serial);
212 /* Request a packet if the DMM requires this. */
213 if (dmms[dmm].packet_request) {
214 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
215 sr_err("Failed to request packet: %d.", ret);
221 * There's no way to get an ID from the multimeter. It just sends data
222 * periodically (or upon request), so the best we can do is check if
223 * the packets match the expected format.
226 /* Let's get a bit of data and see if we can find a packet. */
228 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
229 dmms[dmm].packet_valid, 1000,
235 * If we dropped more than two packets worth of data, something is
236 * wrong. We shouldn't quit however, since the dropped bytes might be
237 * just zeroes at the beginning of the stream. Those can occur as a
238 * combination of the nonstandard cable that ships with some devices
239 * and the serial port or USB to serial adapter.
241 dropped = len - dmms[dmm].packet_size;
242 if (dropped > 2 * dmms[dmm].packet_size)
243 sr_warn("Had to drop too much data.");
245 sr_info("Found device on port %s.", conn);
247 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
248 dmms[dmm].device, "")))
251 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
252 sr_err("Device context malloc failed.");
256 devc->serial = serial;
259 sdi->driver = dmms[dmm].di;
260 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
262 sdi->probes = g_slist_append(sdi->probes, probe);
263 drvc->instances = g_slist_append(drvc->instances, sdi);
264 devices = g_slist_append(devices, sdi);
267 serial_close(serial);
272 static GSList *hw_scan(GSList *options, int dmm)
274 struct sr_hwopt *opt;
276 const char *conn, *serialcomm;
278 conn = serialcomm = NULL;
279 for (l = options; l; l = l->next) {
281 switch (opt->hwopt) {
285 case SR_HWOPT_SERIALCOMM:
286 serialcomm = opt->value;
294 /* Use the provided comm specs. */
295 devices = scan(conn, serialcomm, dmm);
297 /* Try the default. */
298 devices = scan(conn, dmms[dmm].conn, dmm);
304 static GSList *hw_dev_list(int dmm)
306 struct drv_context *drvc;
308 drvc = dmms[dmm].di->priv;
310 return drvc->instances;
313 static int hw_dev_open(struct sr_dev_inst *sdi)
315 struct dev_context *devc;
317 if (!(devc = sdi->priv)) {
318 sr_err("sdi->priv was NULL.");
322 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
325 sdi->status = SR_ST_ACTIVE;
330 static int hw_dev_close(struct sr_dev_inst *sdi)
332 struct dev_context *devc;
334 if (!(devc = sdi->priv)) {
335 sr_err("sdi->priv was NULL.");
339 if (devc->serial && devc->serial->fd != -1) {
340 serial_close(devc->serial);
341 sdi->status = SR_ST_INACTIVE;
347 static int hw_cleanup(int dmm)
349 clear_instances(dmm);
354 static int hw_info_get(int info_id, const void **data,
355 const struct sr_dev_inst *sdi)
366 case SR_DI_NUM_PROBES:
367 *data = GINT_TO_POINTER(1);
369 case SR_DI_PROBE_NAMES:
379 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
382 struct dev_context *devc;
384 if (sdi->status != SR_ST_ACTIVE)
387 if (!(devc = sdi->priv)) {
388 sr_err("sdi->priv was NULL.");
393 case SR_HWCAP_LIMIT_SAMPLES:
394 devc->limit_samples = *(const uint64_t *)value;
395 sr_dbg("Setting sample limit to %" PRIu64 ".",
396 devc->limit_samples);
399 sr_err("Unknown capability: %d.", hwcap);
407 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
408 void *cb_data, int dmm)
410 struct sr_datafeed_packet packet;
411 struct sr_datafeed_header header;
412 struct sr_datafeed_meta_analog meta;
413 struct dev_context *devc;
415 if (!(devc = sdi->priv)) {
416 sr_err("sdi->priv was NULL.");
420 sr_dbg("Starting acquisition.");
422 devc->cb_data = cb_data;
425 * Reset the number of samples to take. If we've already collected our
426 * quota, but we start a new session, and don't reset this, we'll just
427 * quit without acquiring any new samples.
429 devc->num_samples = 0;
431 /* Send header packet to the session bus. */
432 sr_dbg("Sending SR_DF_HEADER.");
433 packet.type = SR_DF_HEADER;
434 packet.payload = (uint8_t *)&header;
435 header.feed_version = 1;
436 gettimeofday(&header.starttime, NULL);
437 sr_session_send(devc->cb_data, &packet);
439 /* Send metadata about the SR_DF_ANALOG packets to come. */
440 sr_dbg("Sending SR_DF_META_ANALOG.");
441 packet.type = SR_DF_META_ANALOG;
442 packet.payload = &meta;
444 sr_session_send(devc->cb_data, &packet);
446 /* Poll every 50ms, or whenever some data comes in. */
447 sr_source_add(devc->serial->fd, G_IO_IN, 50,
448 dmms[dmm].receive_data, (void *)sdi);
453 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
455 struct sr_datafeed_packet packet;
456 struct dev_context *devc;
458 if (sdi->status != SR_ST_ACTIVE)
461 if (!(devc = sdi->priv)) {
462 sr_err("sdi->priv was NULL.");
466 sr_dbg("Stopping acquisition.");
468 sr_source_remove(devc->serial->fd);
469 hw_dev_close((struct sr_dev_inst *)sdi);
471 /* Send end packet to the session bus. */
472 sr_dbg("Sending SR_DF_END.");
473 packet.type = SR_DF_END;
474 sr_session_send(cb_data, &packet);
479 /* Driver-specific API function wrappers */
481 static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
482 #define HW_CLEANUP(X) \
483 static int hw_cleanup_##X(void) { return hw_cleanup(X); }
485 static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
486 #define HW_DEV_LIST(X) \
487 static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
488 #define CLEAR_INSTANCES(X) \
489 static int clear_instances_##X(void) { return clear_instances(X); }
490 #define HW_DEV_ACQUISITION_START(X) \
491 static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
492 void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
494 /* Driver structs and API function wrappers */
495 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
497 HW_CLEANUP(ID_UPPER) \
499 HW_DEV_LIST(ID_UPPER) \
500 CLEAR_INSTANCES(ID_UPPER) \
501 HW_DEV_ACQUISITION_START(ID_UPPER) \
502 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
504 .longname = LONGNAME, \
506 .init = hw_init_##ID_UPPER, \
507 .cleanup = hw_cleanup_##ID_UPPER, \
508 .scan = hw_scan_##ID_UPPER, \
509 .dev_list = hw_dev_list_##ID_UPPER, \
510 .dev_clear = clear_instances_##ID_UPPER, \
511 .dev_open = hw_dev_open, \
512 .dev_close = hw_dev_close, \
513 .info_get = hw_info_get, \
514 .dev_config_set = hw_dev_config_set, \
515 .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
516 .dev_acquisition_stop = hw_dev_acquisition_stop, \
520 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
521 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
522 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
523 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
524 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
525 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
526 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
527 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
528 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
529 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
530 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")