2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 abraxa (Soeren Apel) <soeren@apelpie.net>
5 * Based on the Hameg HMO driver by poljar (Damir Jelić) <poljarinho@gmail.com>
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/>.
26 static struct sr_dev_driver yokogawa_dlm_driver_info;
28 static const char *MANUFACTURER_ID = "YOKOGAWA";
29 static const char *MANUFACTURER_NAME = "Yokogawa";
31 static const uint32_t dlm_scanopts[] = {
35 static const uint32_t dlm_drvopts[] = {
36 SR_CONF_LOGIC_ANALYZER,
40 static const uint32_t dlm_devopts[] = {
41 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_SAMPLERATE | SR_CONF_GET,
43 SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 SR_CONF_NUM_HDIV | SR_CONF_GET,
45 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
47 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
50 static const uint32_t dlm_analog_devopts[] = {
51 SR_CONF_NUM_VDIV | SR_CONF_GET,
52 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
53 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
56 static const uint32_t dlm_digital_devopts[] = {
66 static struct sr_dev_inst *probe_usbtmc_device(struct sr_scpi_dev_inst *scpi)
68 struct sr_dev_inst *sdi;
69 struct dev_context *devc;
70 struct sr_scpi_hw_info *hw_info;
78 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
79 sr_info("Couldn't get IDN response.");
83 if (strcmp(hw_info->manufacturer, MANUFACTURER_ID) != 0)
86 if (dlm_model_get(hw_info->model, &model_name, &model_index) != SR_OK)
89 sdi = g_malloc0(sizeof(struct sr_dev_inst));
90 sdi->vendor = g_strdup(MANUFACTURER_NAME);
91 sdi->model = g_strdup(model_name);
92 sdi->version = g_strdup(hw_info->firmware_version);
94 sdi->serial_num = g_strdup(hw_info->serial_number);
96 sr_scpi_hw_info_free(hw_info);
99 devc = g_malloc0(sizeof(struct dev_context));
101 sdi->driver = &yokogawa_dlm_driver_info;
103 sdi->inst_type = SR_INST_SCPI;
106 if (dlm_device_init(sdi, model_index) != SR_OK)
112 sr_scpi_hw_info_free(hw_info);
113 sr_dev_inst_free(sdi);
119 static GSList *scan(struct sr_dev_driver *di, GSList *options)
121 return sr_scpi_scan(di->context, options, probe_usbtmc_device);
124 static void clear_helper(void *priv)
126 struct dev_context *devc;
130 dlm_scope_state_destroy(devc->model_state);
132 g_free(devc->analog_groups);
133 g_free(devc->digital_groups);
137 static int dev_clear(const struct sr_dev_driver *di)
139 return std_dev_clear(di, clear_helper);
142 static int dev_open(struct sr_dev_inst *sdi)
144 if (sr_scpi_open(sdi->conn) != SR_OK)
147 if (dlm_scope_state_query(sdi) != SR_OK)
153 static int dev_close(struct sr_dev_inst *sdi)
155 return sr_scpi_close(sdi->conn);
159 * Check which category a given channel group belongs to.
161 * @param devc Our internal device context.
162 * @param cg The channel group to check.
164 * @retval CG_NONE cg is NULL
165 * @retval CG_ANALOG cg is an analog group
166 * @retval CG_DIGITAL cg is a digital group
167 * @retval CG_INVALID cg is something else
169 static int check_channel_group(struct dev_context *devc,
170 const struct sr_channel_group *cg)
173 const struct scope_config *model;
175 model = devc->model_config;
180 for (i = 0; i < model->analog_channels; i++)
181 if (cg == devc->analog_groups[i])
184 for (i = 0; i < model->pods; i++)
185 if (cg == devc->digital_groups[i])
188 sr_err("Invalid channel group specified.");
192 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
193 const struct sr_channel_group *cg)
197 struct dev_context *devc;
198 const struct scope_config *model;
199 struct scope_state *state;
206 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
209 model = devc->model_config;
210 state = devc->model_state;
213 case SR_CONF_NUM_HDIV:
214 *data = g_variant_new_int32(model->num_xdivs);
217 case SR_CONF_TIMEBASE:
218 *data = g_variant_new("(tt)",
219 dlm_timebases[state->timebase][0],
220 dlm_timebases[state->timebase][1]);
223 case SR_CONF_NUM_VDIV:
224 if (cg_type == CG_NONE) {
225 sr_err("No channel group specified.");
226 return SR_ERR_CHANNEL_GROUP;
227 } else if (cg_type == CG_ANALOG) {
228 *data = g_variant_new_int32(model->num_ydivs);
237 if (cg_type == CG_NONE) {
238 sr_err("No channel group specified.");
239 return SR_ERR_CHANNEL_GROUP;
240 } else if (cg_type != CG_ANALOG)
243 for (i = 0; i < model->analog_channels; i++) {
244 if (cg != devc->analog_groups[i])
246 *data = g_variant_new("(tt)",
247 dlm_vdivs[state->analog_states[i].vdiv][0],
248 dlm_vdivs[state->analog_states[i].vdiv][1]);
253 case SR_CONF_TRIGGER_SOURCE:
254 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
257 case SR_CONF_TRIGGER_SLOPE:
258 *data = g_variant_new_string(dlm_trigger_slopes[state->trigger_slope]);
261 case SR_CONF_HORIZ_TRIGGERPOS:
262 *data = g_variant_new_double(state->horiz_triggerpos);
265 case SR_CONF_COUPLING:
267 if (cg_type == CG_NONE) {
268 sr_err("No channel group specified.");
269 return SR_ERR_CHANNEL_GROUP;
270 } else if (cg_type != CG_ANALOG)
273 for (i = 0; i < model->analog_channels; i++) {
274 if (cg != devc->analog_groups[i])
276 *data = g_variant_new_string((*model->coupling_options)[state->analog_states[i].coupling]);
281 case SR_CONF_SAMPLERATE:
282 *data = g_variant_new_uint64(state->sample_rate);
292 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
295 GVariant *rational[2];
298 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
300 for (i = 0; i < n; i++) {
301 rational[0] = g_variant_new_uint64((*array)[i][0]);
302 rational[1] = g_variant_new_uint64((*array)[i][1]);
304 /* FIXME: Valgrind reports a memory leak here. */
305 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
308 return g_variant_builder_end(&gvb);
311 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
312 const struct sr_channel_group *cg)
317 struct dev_context *devc;
318 const struct scope_config *model;
319 struct scope_state *state;
323 gboolean update_sample_rate;
325 if (!sdi || !(devc = sdi->priv))
328 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
331 model = devc->model_config;
332 state = devc->model_state;
333 update_sample_rate = FALSE;
338 case SR_CONF_LIMIT_FRAMES:
339 devc->frame_limit = g_variant_get_uint64(data);
342 case SR_CONF_TRIGGER_SOURCE:
343 tmp = g_variant_get_string(data, NULL);
344 for (i = 0; (*model->trigger_sources)[i]; i++) {
345 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
347 state->trigger_source = i;
348 /* TODO: A and B trigger support possible? */
349 ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[i]);
354 if (cg_type == CG_NONE) {
355 sr_err("No channel group specified.");
356 return SR_ERR_CHANNEL_GROUP;
359 g_variant_get(data, "(tt)", &p, &q);
361 for (i = 0; i < ARRAY_SIZE(dlm_vdivs); i++) {
362 if (p != dlm_vdivs[i][0] ||
363 q != dlm_vdivs[i][1])
365 for (j = 1; j <= model->analog_channels; j++) {
366 if (cg != devc->analog_groups[j - 1])
368 state->analog_states[j - 1].vdiv = i;
369 g_ascii_formatd(float_str, sizeof(float_str),
370 "%E", (float) p / q);
371 if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != SR_OK ||
372 sr_scpi_get_opc(sdi->conn) != SR_OK)
382 case SR_CONF_TIMEBASE:
383 g_variant_get(data, "(tt)", &p, &q);
385 for (i = 0; i < ARRAY_SIZE(dlm_timebases); i++) {
386 if (p != dlm_timebases[i][0] ||
387 q != dlm_timebases[i][1])
390 g_ascii_formatd(float_str, sizeof(float_str),
391 "%E", (float) p / q);
392 ret = dlm_timebase_set(sdi->conn, float_str);
393 update_sample_rate = TRUE;
397 case SR_CONF_HORIZ_TRIGGERPOS:
398 tmp_d = g_variant_get_double(data);
400 /* TODO: Check if the calculation makes sense for the DLM. */
401 if (tmp_d < 0.0 || tmp_d > 1.0)
404 state->horiz_triggerpos = tmp_d;
405 tmp_d = -(tmp_d - 0.5) *
406 ((double) dlm_timebases[state->timebase][0] /
407 dlm_timebases[state->timebase][1])
410 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
411 ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
413 case SR_CONF_TRIGGER_SLOPE:
414 tmp = g_variant_get_string(data, NULL);
416 if (!tmp || !(tmp[0] == 'f' || tmp[0] == 'r'))
419 /* Note: See dlm_trigger_slopes[] in protocol.c. */
420 state->trigger_slope = (tmp[0] == 'r') ?
421 SLOPE_POSITIVE : SLOPE_NEGATIVE;
423 ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
425 case SR_CONF_COUPLING:
426 if (cg_type == CG_NONE) {
427 sr_err("No channel group specified.");
428 return SR_ERR_CHANNEL_GROUP;
431 tmp = g_variant_get_string(data, NULL);
433 for (i = 0; (*model->coupling_options)[i]; i++) {
434 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
436 for (j = 1; j <= model->analog_channels; j++) {
437 if (cg != devc->analog_groups[j - 1])
439 state->analog_states[j-1].coupling = i;
441 if (dlm_analog_chan_coupl_set(sdi->conn, j, tmp) != SR_OK ||
442 sr_scpi_get_opc(sdi->conn) != SR_OK)
457 ret = sr_scpi_get_opc(sdi->conn);
459 if (ret == SR_OK && update_sample_rate)
460 ret = dlm_sample_rate_query(sdi);
465 static int config_channel_set(const struct sr_dev_inst *sdi,
466 struct sr_channel *ch, unsigned int changes)
468 /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
469 if (changes != SR_CHANNEL_SET_ENABLED)
472 return dlm_channel_state_set(sdi, ch->index, ch->enabled);
475 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
476 const struct sr_channel_group *cg)
478 int cg_type = CG_NONE;
479 struct dev_context *devc = NULL;
480 const struct scope_config *model = NULL;
482 /* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or channel group. */
483 if (key == SR_CONF_SCAN_OPTIONS) {
484 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
485 dlm_scanopts, ARRAY_SIZE(dlm_scanopts), sizeof(uint32_t));
489 /* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
490 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
491 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
492 dlm_drvopts, ARRAY_SIZE(dlm_drvopts), sizeof(uint32_t));
500 model = devc->model_config;
503 * If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
504 * specific to a channel group must be returned.
508 case SR_CONF_DEVICE_OPTIONS:
509 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
510 dlm_devopts, ARRAY_SIZE(dlm_devopts), sizeof(uint32_t));
512 case SR_CONF_TIMEBASE:
513 *data = build_tuples(&dlm_timebases, ARRAY_SIZE(dlm_timebases));
515 case SR_CONF_TRIGGER_SOURCE:
518 *data = g_variant_new_strv(*model->trigger_sources,
519 g_strv_length((char **)*model->trigger_sources));
521 case SR_CONF_TRIGGER_SLOPE:
522 *data = g_variant_new_strv(dlm_trigger_slopes,
523 g_strv_length((char **)dlm_trigger_slopes));
525 case SR_CONF_NUM_HDIV:
526 *data = g_variant_new_uint32(model->num_xdivs);
533 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
537 case SR_CONF_DEVICE_OPTIONS:
538 if (cg_type == CG_ANALOG) {
539 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
540 dlm_analog_devopts, ARRAY_SIZE(dlm_analog_devopts), sizeof(uint32_t));
541 } else if (cg_type == CG_DIGITAL) {
542 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
543 dlm_digital_devopts, ARRAY_SIZE(dlm_digital_devopts), sizeof(uint32_t));
545 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
546 NULL, 0, sizeof(uint32_t));
549 case SR_CONF_COUPLING:
550 if (cg_type == CG_NONE)
551 return SR_ERR_CHANNEL_GROUP;
552 *data = g_variant_new_strv(*model->coupling_options,
553 g_strv_length((char **)*model->coupling_options));
556 if (cg_type == CG_NONE)
557 return SR_ERR_CHANNEL_GROUP;
558 *data = build_tuples(&dlm_vdivs, ARRAY_SIZE(dlm_vdivs));
567 static int dlm_check_channels(GSList *channels)
570 struct sr_channel *ch;
571 gboolean enabled_pod1, enabled_chan4;
573 enabled_pod1 = enabled_chan4 = FALSE;
575 /* Note: On the DLM2000, CH4 and Logic are shared. */
576 /* TODO Handle non-DLM2000 models. */
577 for (l = channels; l; l = l->next) {
580 case SR_CHANNEL_ANALOG:
582 enabled_chan4 = TRUE;
584 case SR_CHANNEL_LOGIC:
592 if (enabled_pod1 && enabled_chan4)
598 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
601 gboolean digital_added;
602 struct sr_channel *ch;
603 struct dev_context *devc;
604 struct sr_scpi_dev_inst *scpi;
608 digital_added = FALSE;
610 g_slist_free(devc->enabled_channels);
611 devc->enabled_channels = NULL;
613 for (l = sdi->channels; l; l = l->next) {
617 /* Only add a single digital channel. */
618 if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
619 devc->enabled_channels = g_slist_append(
620 devc->enabled_channels, ch);
621 if (ch->type == SR_CHANNEL_LOGIC)
622 digital_added = TRUE;
626 if (!devc->enabled_channels)
629 if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
630 sr_err("Invalid channel configuration specified!");
634 /* Request data for the first enabled channel. */
635 devc->current_channel = devc->enabled_channels;
636 dlm_channel_data_request(sdi);
638 /* Call our callback when data comes in or after 5ms. */
639 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
640 dlm_data_receive, (void *)sdi);
645 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
647 struct dev_context *devc;
649 std_session_send_df_end(sdi);
653 devc->num_frames = 0;
654 g_slist_free(devc->enabled_channels);
655 devc->enabled_channels = NULL;
657 sr_scpi_source_remove(sdi->session, sdi->conn);
662 static struct sr_dev_driver yokogawa_dlm_driver_info = {
663 .name = "yokogawa-dlm",
664 .longname = "Yokogawa DL/DLM",
667 .cleanup = std_cleanup,
669 .dev_list = std_dev_list,
670 .dev_clear = dev_clear,
671 .config_get = config_get,
672 .config_set = config_set,
673 .config_channel_set = config_channel_set,
674 .config_list = config_list,
675 .dev_open = dev_open,
676 .dev_close = dev_close,
677 .dev_acquisition_start = dev_acquisition_start,
678 .dev_acquisition_stop = dev_acquisition_stop,
681 SR_REGISTER_DEV_DRIVER(yokogawa_dlm_driver_info);