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)
113 sr_scpi_hw_info_free(hw_info);
114 sr_dev_inst_free(sdi);
120 static GSList *scan(struct sr_dev_driver *di, GSList *options)
122 return sr_scpi_scan(di->context, options, probe_usbtmc_device);
125 static void clear_helper(void *priv)
127 struct dev_context *devc;
131 dlm_scope_state_destroy(devc->model_state);
133 g_free(devc->analog_groups);
134 g_free(devc->digital_groups);
138 static int dev_clear(const struct sr_dev_driver *di)
140 return std_dev_clear(di, clear_helper);
143 static int dev_open(struct sr_dev_inst *sdi)
145 if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
148 if (dlm_scope_state_query(sdi) != SR_OK)
151 sdi->status = SR_ST_ACTIVE;
156 static int dev_close(struct sr_dev_inst *sdi)
158 if (sdi->status == SR_ST_INACTIVE)
161 sr_scpi_close(sdi->conn);
163 sdi->status = SR_ST_INACTIVE;
169 * Check which category a given channel group belongs to.
171 * @param devc Our internal device context.
172 * @param cg The channel group to check.
174 * @retval CG_NONE cg is NULL
175 * @retval CG_ANALOG cg is an analog group
176 * @retval CG_DIGITAL cg is a digital group
177 * @retval CG_INVALID cg is something else
179 static int check_channel_group(struct dev_context *devc,
180 const struct sr_channel_group *cg)
183 const struct scope_config *model;
185 model = devc->model_config;
190 for (i = 0; i < model->analog_channels; i++)
191 if (cg == devc->analog_groups[i])
194 for (i = 0; i < model->pods; i++)
195 if (cg == devc->digital_groups[i])
198 sr_err("Invalid channel group specified.");
202 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
203 const struct sr_channel_group *cg)
207 struct dev_context *devc;
208 const struct scope_config *model;
209 struct scope_state *state;
216 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
219 model = devc->model_config;
220 state = devc->model_state;
223 case SR_CONF_NUM_HDIV:
224 *data = g_variant_new_int32(model->num_xdivs);
227 case SR_CONF_TIMEBASE:
228 *data = g_variant_new("(tt)",
229 dlm_timebases[state->timebase][0],
230 dlm_timebases[state->timebase][1]);
233 case SR_CONF_NUM_VDIV:
234 if (cg_type == CG_NONE) {
235 sr_err("No channel group specified.");
236 return SR_ERR_CHANNEL_GROUP;
237 } else if (cg_type == CG_ANALOG) {
238 *data = g_variant_new_int32(model->num_ydivs);
247 if (cg_type == CG_NONE) {
248 sr_err("No channel group specified.");
249 return SR_ERR_CHANNEL_GROUP;
250 } else if (cg_type != CG_ANALOG)
253 for (i = 0; i < model->analog_channels; i++) {
254 if (cg != devc->analog_groups[i])
256 *data = g_variant_new("(tt)",
257 dlm_vdivs[state->analog_states[i].vdiv][0],
258 dlm_vdivs[state->analog_states[i].vdiv][1]);
263 case SR_CONF_TRIGGER_SOURCE:
264 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
267 case SR_CONF_TRIGGER_SLOPE:
268 *data = g_variant_new_string(dlm_trigger_slopes[state->trigger_slope]);
271 case SR_CONF_HORIZ_TRIGGERPOS:
272 *data = g_variant_new_double(state->horiz_triggerpos);
275 case SR_CONF_COUPLING:
277 if (cg_type == CG_NONE) {
278 sr_err("No channel group specified.");
279 return SR_ERR_CHANNEL_GROUP;
280 } else if (cg_type != CG_ANALOG)
283 for (i = 0; i < model->analog_channels; i++) {
284 if (cg != devc->analog_groups[i])
286 *data = g_variant_new_string((*model->coupling_options)[state->analog_states[i].coupling]);
291 case SR_CONF_SAMPLERATE:
292 *data = g_variant_new_uint64(state->sample_rate);
302 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
305 GVariant *rational[2];
308 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
310 for (i = 0; i < n; i++) {
311 rational[0] = g_variant_new_uint64((*array)[i][0]);
312 rational[1] = g_variant_new_uint64((*array)[i][1]);
314 /* FIXME: Valgrind reports a memory leak here. */
315 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
318 return g_variant_builder_end(&gvb);
321 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
322 const struct sr_channel_group *cg)
327 struct dev_context *devc;
328 const struct scope_config *model;
329 struct scope_state *state;
333 gboolean update_sample_rate;
335 if (!sdi || !(devc = sdi->priv))
338 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
341 model = devc->model_config;
342 state = devc->model_state;
343 update_sample_rate = FALSE;
348 case SR_CONF_LIMIT_FRAMES:
349 devc->frame_limit = g_variant_get_uint64(data);
352 case SR_CONF_TRIGGER_SOURCE:
353 tmp = g_variant_get_string(data, NULL);
354 for (i = 0; (*model->trigger_sources)[i]; i++) {
355 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
357 state->trigger_source = i;
358 /* TODO: A and B trigger support possible? */
359 ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[i]);
364 if (cg_type == CG_NONE) {
365 sr_err("No channel group specified.");
366 return SR_ERR_CHANNEL_GROUP;
369 g_variant_get(data, "(tt)", &p, &q);
371 for (i = 0; i < ARRAY_SIZE(dlm_vdivs); i++) {
372 if (p != dlm_vdivs[i][0] ||
373 q != dlm_vdivs[i][1])
375 for (j = 1; j <= model->analog_channels; j++) {
376 if (cg != devc->analog_groups[j - 1])
378 state->analog_states[j - 1].vdiv = i;
379 g_ascii_formatd(float_str, sizeof(float_str),
380 "%E", (float) p / q);
381 if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != SR_OK ||
382 sr_scpi_get_opc(sdi->conn) != SR_OK)
392 case SR_CONF_TIMEBASE:
393 g_variant_get(data, "(tt)", &p, &q);
395 for (i = 0; i < ARRAY_SIZE(dlm_timebases); i++) {
396 if (p != dlm_timebases[i][0] ||
397 q != dlm_timebases[i][1])
400 g_ascii_formatd(float_str, sizeof(float_str),
401 "%E", (float) p / q);
402 ret = dlm_timebase_set(sdi->conn, float_str);
403 update_sample_rate = TRUE;
407 case SR_CONF_HORIZ_TRIGGERPOS:
408 tmp_d = g_variant_get_double(data);
410 /* TODO: Check if the calculation makes sense for the DLM. */
411 if (tmp_d < 0.0 || tmp_d > 1.0)
414 state->horiz_triggerpos = tmp_d;
415 tmp_d = -(tmp_d - 0.5) *
416 ((double) dlm_timebases[state->timebase][0] /
417 dlm_timebases[state->timebase][1])
420 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
421 ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
423 case SR_CONF_TRIGGER_SLOPE:
424 tmp = g_variant_get_string(data, NULL);
426 if (!tmp || !(tmp[0] == 'f' || tmp[0] == 'r'))
429 /* Note: See dlm_trigger_slopes[] in protocol.c. */
430 state->trigger_slope = (tmp[0] == 'r') ?
431 SLOPE_POSITIVE : SLOPE_NEGATIVE;
433 ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
435 case SR_CONF_COUPLING:
436 if (cg_type == CG_NONE) {
437 sr_err("No channel group specified.");
438 return SR_ERR_CHANNEL_GROUP;
441 tmp = g_variant_get_string(data, NULL);
443 for (i = 0; (*model->coupling_options)[i]; i++) {
444 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
446 for (j = 1; j <= model->analog_channels; j++) {
447 if (cg != devc->analog_groups[j - 1])
449 state->analog_states[j-1].coupling = i;
451 if (dlm_analog_chan_coupl_set(sdi->conn, j, tmp) != SR_OK ||
452 sr_scpi_get_opc(sdi->conn) != SR_OK)
467 ret = sr_scpi_get_opc(sdi->conn);
469 if (ret == SR_OK && update_sample_rate)
470 ret = dlm_sample_rate_query(sdi);
475 static int config_channel_set(const struct sr_dev_inst *sdi,
476 struct sr_channel *ch, unsigned int changes)
478 /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
479 if (changes != SR_CHANNEL_SET_ENABLED)
482 return dlm_channel_state_set(sdi, ch->index, ch->enabled);
485 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
486 const struct sr_channel_group *cg)
488 int cg_type = CG_NONE;
489 struct dev_context *devc = NULL;
490 const struct scope_config *model = NULL;
492 /* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or probe group. */
493 if (key == SR_CONF_SCAN_OPTIONS) {
494 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
495 dlm_scanopts, ARRAY_SIZE(dlm_scanopts), sizeof(uint32_t));
499 /* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
500 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
501 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
502 dlm_drvopts, ARRAY_SIZE(dlm_drvopts), sizeof(uint32_t));
510 model = devc->model_config;
513 * If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
514 * specific to a probe group must be returned.
518 case SR_CONF_DEVICE_OPTIONS:
519 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
520 dlm_devopts, ARRAY_SIZE(dlm_devopts), sizeof(uint32_t));
522 case SR_CONF_TIMEBASE:
523 *data = build_tuples(&dlm_timebases, ARRAY_SIZE(dlm_timebases));
525 case SR_CONF_TRIGGER_SOURCE:
528 *data = g_variant_new_strv(*model->trigger_sources,
529 g_strv_length((char **)*model->trigger_sources));
531 case SR_CONF_TRIGGER_SLOPE:
532 *data = g_variant_new_strv(dlm_trigger_slopes,
533 g_strv_length((char **)dlm_trigger_slopes));
535 case SR_CONF_NUM_HDIV:
536 *data = g_variant_new_uint32(model->num_xdivs);
543 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
547 case SR_CONF_DEVICE_OPTIONS:
548 if (cg_type == CG_ANALOG) {
549 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
550 dlm_analog_devopts, ARRAY_SIZE(dlm_analog_devopts), sizeof(uint32_t));
551 } else if (cg_type == CG_DIGITAL) {
552 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
553 dlm_digital_devopts, ARRAY_SIZE(dlm_digital_devopts), sizeof(uint32_t));
555 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
556 NULL, 0, sizeof(uint32_t));
559 case SR_CONF_COUPLING:
560 if (cg_type == CG_NONE)
561 return SR_ERR_CHANNEL_GROUP;
562 *data = g_variant_new_strv(*model->coupling_options,
563 g_strv_length((char **)*model->coupling_options));
566 if (cg_type == CG_NONE)
567 return SR_ERR_CHANNEL_GROUP;
568 *data = build_tuples(&dlm_vdivs, ARRAY_SIZE(dlm_vdivs));
577 static int dlm_check_channels(GSList *channels)
580 struct sr_channel *ch;
581 gboolean enabled_pod1, enabled_chan4;
583 enabled_pod1 = enabled_chan4 = FALSE;
585 /* Note: On the DLM2000, CH4 and Logic are shared. */
586 /* TODO Handle non-DLM2000 models. */
587 for (l = channels; l; l = l->next) {
590 case SR_CHANNEL_ANALOG:
592 enabled_chan4 = TRUE;
594 case SR_CHANNEL_LOGIC:
602 if (enabled_pod1 && enabled_chan4)
608 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
611 gboolean digital_added;
612 struct sr_channel *ch;
613 struct dev_context *devc;
614 struct sr_scpi_dev_inst *scpi;
616 if (sdi->status != SR_ST_ACTIVE)
617 return SR_ERR_DEV_CLOSED;
621 digital_added = FALSE;
623 g_slist_free(devc->enabled_channels);
624 devc->enabled_channels = NULL;
626 for (l = sdi->channels; l; l = l->next) {
630 /* Only add a single digital channel. */
631 if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
632 devc->enabled_channels = g_slist_append(
633 devc->enabled_channels, ch);
634 if (ch->type == SR_CHANNEL_LOGIC)
635 digital_added = TRUE;
639 if (!devc->enabled_channels)
642 if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
643 sr_err("Invalid channel configuration specified!");
647 /* Request data for the first enabled channel. */
648 devc->current_channel = devc->enabled_channels;
649 dlm_channel_data_request(sdi);
651 /* Call our callback when data comes in or after 5ms. */
652 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
653 dlm_data_receive, (void *)sdi);
658 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
660 struct dev_context *devc;
662 std_session_send_df_end(sdi);
664 if (sdi->status != SR_ST_ACTIVE)
665 return SR_ERR_DEV_CLOSED;
669 devc->num_frames = 0;
670 g_slist_free(devc->enabled_channels);
671 devc->enabled_channels = NULL;
673 sr_scpi_source_remove(sdi->session, sdi->conn);
678 static struct sr_dev_driver yokogawa_dlm_driver_info = {
679 .name = "yokogawa-dlm",
680 .longname = "Yokogawa DL/DLM",
683 .cleanup = std_cleanup,
685 .dev_list = std_dev_list,
686 .dev_clear = dev_clear,
687 .config_get = config_get,
688 .config_set = config_set,
689 .config_channel_set = config_channel_set,
690 .config_list = config_list,
691 .dev_open = dev_open,
692 .dev_close = dev_close,
693 .dev_acquisition_start = dev_acquisition_start,
694 .dev_acquisition_stop = dev_acquisition_stop,
697 SR_REGISTER_DEV_DRIVER(yokogawa_dlm_driver_info);