2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Janne Huttunen <jahuttun@gmail.com>
5 * Copyright (C) 2019 Gerhard Sittig <gerhard.sittig@gmx.net>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
30 static const uint32_t scanopts[] = {
35 static const uint32_t drvopts[] = {
39 static const uint32_t devopts[] = {
41 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
43 SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_LIST,
44 SR_CONF_EQUIV_CIRCUIT_MODEL | SR_CONF_GET | SR_CONF_LIST,
47 static struct sr_dev_inst *scan_packet_check_devinst;
49 static void scan_packet_check_setup(struct sr_dev_inst *sdi)
51 scan_packet_check_devinst = sdi;
54 static gboolean scan_packet_check_func(const uint8_t *buf)
56 struct sr_dev_inst *sdi;
57 struct dev_context *devc;
58 const struct lcr_info *lcr;
59 struct lcr_parse_info *info;
61 /* Get a reference to the LCR model that is getting checked. */
62 sdi = scan_packet_check_devinst;
72 /* Synchronize to the stream of LCR packets. */
73 if (!lcr->packet_valid(buf))
76 /* Have LCR packets _processed_, gather current configuration. */
77 info = &devc->parse_info;
78 memset(info, 0, sizeof(*info));
79 if (lcr->packet_parse(buf, NULL, NULL, info) == SR_OK) {
80 devc->output_freq = info->output_freq;
81 if (info->circuit_model)
82 devc->circuit_model = info->circuit_model;
88 static int scan_lcr_port(const struct lcr_info *lcr,
89 const char *conn, struct sr_serial_dev_inst *serial)
96 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
98 sr_info("Probing serial port %s.", conn);
101 * See if we can detect a device of specified type.
103 * No supported device provides a means to "identify" yet. No
104 * supported device requires "packet request" yet. They all just
105 * send data periodically. So we check if the packets match the
106 * probed device's expected format.
108 if (lcr->packet_request) {
109 ret = lcr->packet_request(serial);
111 sr_err("Failed to request packet: %d.", ret);
112 goto scan_port_cleanup;
116 ret = serial_stream_detect(serial, buf, &len,
117 lcr->packet_size, lcr->packet_valid, NULL, NULL, 3000);
119 goto scan_port_cleanup;
122 * If the packets were found to match after more than two packets
123 * got dropped, something is wrong. This is worth warning about,
124 * but isn't fatal. The dropped bytes might be due to nonstandard
125 * cables that ship with some devices.
127 dropped = len - lcr->packet_size;
128 if (dropped > 2 * lcr->packet_size)
129 sr_warn("Had to drop unexpected amounts of data.");
131 /* Create a device instance for the found device. */
132 sr_info("Found %s %s device on port %s.", lcr->vendor, lcr->model, conn);
135 /* Keep serial port open if probe succeeded. */
137 serial_close(serial);
142 static struct sr_dev_inst *create_lcr_sdi(struct lcr_info *lcr,
143 struct sr_serial_dev_inst *serial)
145 struct sr_dev_inst *sdi;
146 struct dev_context *devc;
148 const char **ch_fmts;
152 sdi = g_malloc0(sizeof(*sdi));
153 sdi->status = SR_ST_INACTIVE;
154 sdi->vendor = g_strdup(lcr->vendor);
155 sdi->model = g_strdup(lcr->model);
156 sdi->inst_type = SR_INST_SERIAL;
158 devc = g_malloc0(sizeof(*devc));
160 devc->lcr_info = lcr;
161 sr_sw_limits_init(&devc->limits);
162 ch_fmts = lcr->channel_formats;
163 for (ch_idx = 0; ch_idx < lcr->channel_count; ch_idx++) {
164 fmt = (ch_fmts && ch_fmts[ch_idx]) ? ch_fmts[ch_idx] : "P%zu";
165 snprintf(ch_name, sizeof(ch_name), fmt, ch_idx + 1);
166 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, ch_name);
172 static int read_lcr_port(struct sr_dev_inst *sdi,
173 const struct lcr_info *lcr, struct sr_serial_dev_inst *serial)
179 serial_flush(serial);
180 if (lcr->packet_request) {
181 ret = lcr->packet_request(serial);
183 sr_err("Failed to request packet: %d.", ret);
189 * Receive a few more packets (and process them!) to have the
190 * current output frequency and circuit model parameter values
191 * detected. The above "stream detect" phase only synchronized
192 * to the packets by checking their validity, but it cannot
193 * provide details. This phase here runs a modified "checker"
194 * routine which also extracts details from LCR packets after
195 * the device got detected and parameter storage was prepared.
197 sr_info("Retrieving current acquisition parameters.");
199 scan_packet_check_setup(sdi);
200 ret = serial_stream_detect(serial, buf, &len,
201 lcr->packet_size, scan_packet_check_func, NULL, NULL, 1500);
202 scan_packet_check_setup(NULL);
207 static GSList *scan(struct sr_dev_driver *di, GSList *options)
209 struct lcr_info *lcr;
210 struct sr_config *src;
212 const char *conn, *serialcomm;
213 struct sr_serial_dev_inst *serial;
215 struct sr_dev_inst *sdi;
217 lcr = (struct lcr_info *)di;
219 /* Get serial port name and communication parameters. */
221 serialcomm = lcr->comm;
222 for (l = options; l; l = l->next) {
226 conn = g_variant_get_string(src->data, NULL);
228 case SR_CONF_SERIALCOMM:
229 serialcomm = g_variant_get_string(src->data, NULL);
237 /* TODO Handle ambiguous conn= specs, see serial-dmm. */
239 /* Open the serial port, check data packets. */
240 serial = sr_serial_dev_inst_new(conn, serialcomm);
241 ret = scan_lcr_port(lcr, conn, serial);
243 /* Probe failed, release 'serial'. */
244 sr_serial_dev_inst_free(serial);
246 /* Create and return device instance, keep 'serial' alive. */
247 sdi = create_lcr_sdi(lcr, serial);
248 devices = g_slist_append(devices, sdi);
249 (void)read_lcr_port(sdi, lcr, serial);
250 serial_close(serial);
253 return std_scan_complete(di, devices);
256 static int config_get(uint32_t key, GVariant **data,
257 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
259 struct dev_context *devc;
260 const struct lcr_info *lcr;
267 case SR_CONF_LIMIT_FRAMES:
268 case SR_CONF_LIMIT_MSEC:
269 return sr_sw_limits_config_get(&devc->limits, key, data);
270 case SR_CONF_OUTPUT_FREQUENCY:
271 *data = g_variant_new_double(devc->output_freq);
273 case SR_CONF_EQUIV_CIRCUIT_MODEL:
274 if (!devc->circuit_model)
276 *data = g_variant_new_string(devc->circuit_model);
279 lcr = devc->lcr_info;
282 if (!lcr->config_get)
284 return lcr->config_get(key, data, sdi, cg);
289 static int config_set(uint32_t key, GVariant *data,
290 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
292 struct dev_context *devc;
293 const struct lcr_info *lcr;
300 case SR_CONF_LIMIT_FRAMES:
301 case SR_CONF_LIMIT_MSEC:
302 return sr_sw_limits_config_set(&devc->limits, key, data);
304 lcr = devc->lcr_info;
307 if (!lcr->config_set)
309 return lcr->config_set(key, data, sdi, cg);
314 static int config_list(uint32_t key, GVariant **data,
315 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
317 struct dev_context *devc;
318 const struct lcr_info *lcr;
321 case SR_CONF_SCAN_OPTIONS:
322 case SR_CONF_DEVICE_OPTIONS:
323 return STD_CONFIG_LIST(key, data, sdi, cg,
324 scanopts, drvopts, devopts);
334 lcr = devc->lcr_info;
335 if (!lcr || !lcr->config_list)
337 return lcr->config_list(key, data, sdi, cg);
342 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
344 struct dev_context *devc;
345 struct sr_serial_dev_inst *serial;
350 * Clear values that were gathered during scan or in a previous
351 * acquisition, so that this acquisition's data feed immediately
352 * starts with meta packets before first measurement values, and
353 * also communicates subsequent parameter changes.
355 devc->output_freq = 0;
356 devc->circuit_model = NULL;
358 sr_sw_limits_acquisition_start(&devc->limits);
359 std_session_send_df_header(sdi);
362 serial_source_add(sdi->session, serial, G_IO_IN, 50,
363 lcr_receive_data, (void *)sdi);
368 #define LCR_ES51919(id, vendor, model) \
369 &((struct lcr_info) { \
372 .longname = vendor " " model, \
375 .cleanup = std_cleanup, \
377 .dev_list = std_dev_list, \
378 .dev_clear = std_dev_clear, \
379 .config_get = config_get, \
380 .config_set = config_set, \
381 .config_list = config_list, \
382 .dev_open = std_serial_dev_open, \
383 .dev_close = std_serial_dev_close, \
384 .dev_acquisition_start = dev_acquisition_start, \
385 .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
388 vendor, model, ES51919_CHANNEL_COUNT, NULL, \
389 ES51919_COMM_PARAM, ES51919_PACKET_SIZE, \
391 es51919_packet_valid, es51919_packet_parse, \
392 NULL, NULL, es51919_config_list, \
395 SR_REGISTER_DEV_DRIVER_LIST(lcr_es51919_drivers,
396 LCR_ES51919("deree-de5000", "DER EE", "DE-5000"),
397 LCR_ES51919("mastech-ms5308", "MASTECH", "MS5308"),
398 LCR_ES51919("peaktech-2170", "PeakTech", "2170"),
399 LCR_ES51919("uni-t-ut612", "UNI-T", "UT612"),
402 #define LCR_VC4080(id, vendor, model) \
403 &((struct lcr_info) { \
406 .longname = vendor " " model, \
409 .cleanup = std_cleanup, \
411 .dev_list = std_dev_list, \
412 .dev_clear = std_dev_clear, \
413 .config_get = config_get, \
414 .config_set = config_set, \
415 .config_list = config_list, \
416 .dev_open = std_serial_dev_open, \
417 .dev_close = std_serial_dev_close, \
418 .dev_acquisition_start = dev_acquisition_start, \
419 .dev_acquisition_stop = std_serial_dev_acquisition_stop, \
423 VC4080_CHANNEL_COUNT, vc4080_channel_formats, \
424 VC4080_COMM_PARAM, VC4080_PACKET_SIZE, \
425 500, vc4080_packet_request, \
426 vc4080_packet_valid, vc4080_packet_parse, \
427 NULL, NULL, vc4080_config_list, \
430 SR_REGISTER_DEV_DRIVER_LIST(lcr_vc4080_drivers,
431 LCR_VC4080("peaktech-2165", "PeakTech", "2165"),
432 LCR_VC4080("voltcraft-4080", "Voltcraft", "4080"),