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);
136 static int dev_clear(const struct sr_dev_driver *di)
138 return std_dev_clear_with_callback(di, clear_helper);
141 static int dev_open(struct sr_dev_inst *sdi)
143 if (sr_scpi_open(sdi->conn) != SR_OK)
146 if (dlm_scope_state_query(sdi) != SR_OK)
152 static int dev_close(struct sr_dev_inst *sdi)
154 return sr_scpi_close(sdi->conn);
158 * Check which category a given channel group belongs to.
160 * @param devc Our internal device context.
161 * @param cg The channel group to check.
163 * @retval CG_NONE cg is NULL
164 * @retval CG_ANALOG cg is an analog group
165 * @retval CG_DIGITAL cg is a digital group
166 * @retval CG_INVALID cg is something else
168 static int check_channel_group(struct dev_context *devc,
169 const struct sr_channel_group *cg)
172 const struct scope_config *model;
174 model = devc->model_config;
179 for (i = 0; i < model->analog_channels; i++)
180 if (cg == devc->analog_groups[i])
183 for (i = 0; i < model->pods; i++)
184 if (cg == devc->digital_groups[i])
187 sr_err("Invalid channel group specified.");
191 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
192 const struct sr_channel_group *cg)
196 struct dev_context *devc;
197 const struct scope_config *model;
198 struct scope_state *state;
205 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
208 model = devc->model_config;
209 state = devc->model_state;
212 case SR_CONF_NUM_HDIV:
213 *data = g_variant_new_int32(model->num_xdivs);
216 case SR_CONF_TIMEBASE:
217 *data = g_variant_new("(tt)",
218 dlm_timebases[state->timebase][0],
219 dlm_timebases[state->timebase][1]);
222 case SR_CONF_NUM_VDIV:
223 if (cg_type == CG_NONE) {
224 sr_err("No channel group specified.");
225 return SR_ERR_CHANNEL_GROUP;
226 } else if (cg_type == CG_ANALOG) {
227 *data = g_variant_new_int32(model->num_ydivs);
236 if (cg_type == CG_NONE) {
237 sr_err("No channel group specified.");
238 return SR_ERR_CHANNEL_GROUP;
239 } else if (cg_type != CG_ANALOG)
242 for (i = 0; i < model->analog_channels; i++) {
243 if (cg != devc->analog_groups[i])
245 *data = g_variant_new("(tt)",
246 dlm_vdivs[state->analog_states[i].vdiv][0],
247 dlm_vdivs[state->analog_states[i].vdiv][1]);
252 case SR_CONF_TRIGGER_SOURCE:
253 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
256 case SR_CONF_TRIGGER_SLOPE:
257 *data = g_variant_new_string(dlm_trigger_slopes[state->trigger_slope]);
260 case SR_CONF_HORIZ_TRIGGERPOS:
261 *data = g_variant_new_double(state->horiz_triggerpos);
264 case SR_CONF_COUPLING:
266 if (cg_type == CG_NONE) {
267 sr_err("No channel group specified.");
268 return SR_ERR_CHANNEL_GROUP;
269 } else if (cg_type != CG_ANALOG)
272 for (i = 0; i < model->analog_channels; i++) {
273 if (cg != devc->analog_groups[i])
275 *data = g_variant_new_string((*model->coupling_options)[state->analog_states[i].coupling]);
280 case SR_CONF_SAMPLERATE:
281 *data = g_variant_new_uint64(state->sample_rate);
291 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
294 GVariant *rational[2];
297 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
299 for (i = 0; i < n; i++) {
300 rational[0] = g_variant_new_uint64((*array)[i][0]);
301 rational[1] = g_variant_new_uint64((*array)[i][1]);
303 /* FIXME: Valgrind reports a memory leak here. */
304 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
307 return g_variant_builder_end(&gvb);
310 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
311 const struct sr_channel_group *cg)
316 struct dev_context *devc;
317 const struct scope_config *model;
318 struct scope_state *state;
322 gboolean update_sample_rate;
324 if (!sdi || !(devc = sdi->priv))
327 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
330 model = devc->model_config;
331 state = devc->model_state;
332 update_sample_rate = FALSE;
337 case SR_CONF_LIMIT_FRAMES:
338 devc->frame_limit = g_variant_get_uint64(data);
341 case SR_CONF_TRIGGER_SOURCE:
342 tmp = g_variant_get_string(data, NULL);
343 for (i = 0; (*model->trigger_sources)[i]; i++) {
344 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
346 state->trigger_source = i;
347 /* TODO: A and B trigger support possible? */
348 ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[i]);
353 if (cg_type == CG_NONE) {
354 sr_err("No channel group specified.");
355 return SR_ERR_CHANNEL_GROUP;
358 g_variant_get(data, "(tt)", &p, &q);
360 for (i = 0; i < ARRAY_SIZE(dlm_vdivs); i++) {
361 if (p != dlm_vdivs[i][0] ||
362 q != dlm_vdivs[i][1])
364 for (j = 1; j <= model->analog_channels; j++) {
365 if (cg != devc->analog_groups[j - 1])
367 state->analog_states[j - 1].vdiv = i;
368 g_ascii_formatd(float_str, sizeof(float_str),
369 "%E", (float) p / q);
370 if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != SR_OK ||
371 sr_scpi_get_opc(sdi->conn) != SR_OK)
381 case SR_CONF_TIMEBASE:
382 g_variant_get(data, "(tt)", &p, &q);
384 for (i = 0; i < ARRAY_SIZE(dlm_timebases); i++) {
385 if (p != dlm_timebases[i][0] ||
386 q != dlm_timebases[i][1])
389 g_ascii_formatd(float_str, sizeof(float_str),
390 "%E", (float) p / q);
391 ret = dlm_timebase_set(sdi->conn, float_str);
392 update_sample_rate = TRUE;
396 case SR_CONF_HORIZ_TRIGGERPOS:
397 tmp_d = g_variant_get_double(data);
399 /* TODO: Check if the calculation makes sense for the DLM. */
400 if (tmp_d < 0.0 || tmp_d > 1.0)
403 state->horiz_triggerpos = tmp_d;
404 tmp_d = -(tmp_d - 0.5) *
405 ((double) dlm_timebases[state->timebase][0] /
406 dlm_timebases[state->timebase][1])
409 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
410 ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
412 case SR_CONF_TRIGGER_SLOPE:
413 tmp = g_variant_get_string(data, NULL);
415 if (!tmp || !(tmp[0] == 'f' || tmp[0] == 'r'))
418 /* Note: See dlm_trigger_slopes[] in protocol.c. */
419 state->trigger_slope = (tmp[0] == 'r') ?
420 SLOPE_POSITIVE : SLOPE_NEGATIVE;
422 ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
424 case SR_CONF_COUPLING:
425 if (cg_type == CG_NONE) {
426 sr_err("No channel group specified.");
427 return SR_ERR_CHANNEL_GROUP;
430 tmp = g_variant_get_string(data, NULL);
432 for (i = 0; (*model->coupling_options)[i]; i++) {
433 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
435 for (j = 1; j <= model->analog_channels; j++) {
436 if (cg != devc->analog_groups[j - 1])
438 state->analog_states[j-1].coupling = i;
440 if (dlm_analog_chan_coupl_set(sdi->conn, j, tmp) != SR_OK ||
441 sr_scpi_get_opc(sdi->conn) != SR_OK)
456 ret = sr_scpi_get_opc(sdi->conn);
458 if (ret == SR_OK && update_sample_rate)
459 ret = dlm_sample_rate_query(sdi);
464 static int config_channel_set(const struct sr_dev_inst *sdi,
465 struct sr_channel *ch, unsigned int changes)
467 /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
468 if (changes != SR_CHANNEL_SET_ENABLED)
471 return dlm_channel_state_set(sdi, ch->index, ch->enabled);
474 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
475 const struct sr_channel_group *cg)
477 int cg_type = CG_NONE;
478 struct dev_context *devc = NULL;
479 const struct scope_config *model = NULL;
481 /* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or channel group. */
482 if (key == SR_CONF_SCAN_OPTIONS) {
483 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
484 dlm_scanopts, ARRAY_SIZE(dlm_scanopts), sizeof(uint32_t));
488 /* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
489 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
490 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
491 dlm_drvopts, ARRAY_SIZE(dlm_drvopts), sizeof(uint32_t));
499 model = devc->model_config;
502 * If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
503 * specific to a channel group must be returned.
507 case SR_CONF_DEVICE_OPTIONS:
508 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
509 dlm_devopts, ARRAY_SIZE(dlm_devopts), sizeof(uint32_t));
511 case SR_CONF_TIMEBASE:
512 *data = build_tuples(&dlm_timebases, ARRAY_SIZE(dlm_timebases));
514 case SR_CONF_TRIGGER_SOURCE:
517 *data = g_variant_new_strv(*model->trigger_sources,
518 g_strv_length((char **)*model->trigger_sources));
520 case SR_CONF_TRIGGER_SLOPE:
521 *data = g_variant_new_strv(dlm_trigger_slopes,
522 g_strv_length((char **)dlm_trigger_slopes));
524 case SR_CONF_NUM_HDIV:
525 *data = g_variant_new_uint32(model->num_xdivs);
532 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
536 case SR_CONF_DEVICE_OPTIONS:
537 if (cg_type == CG_ANALOG) {
538 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
539 dlm_analog_devopts, ARRAY_SIZE(dlm_analog_devopts), sizeof(uint32_t));
540 } else if (cg_type == CG_DIGITAL) {
541 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
542 dlm_digital_devopts, ARRAY_SIZE(dlm_digital_devopts), sizeof(uint32_t));
544 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
545 NULL, 0, sizeof(uint32_t));
548 case SR_CONF_COUPLING:
549 if (cg_type == CG_NONE)
550 return SR_ERR_CHANNEL_GROUP;
551 *data = g_variant_new_strv(*model->coupling_options,
552 g_strv_length((char **)*model->coupling_options));
555 if (cg_type == CG_NONE)
556 return SR_ERR_CHANNEL_GROUP;
557 *data = build_tuples(&dlm_vdivs, ARRAY_SIZE(dlm_vdivs));
566 static int dlm_check_channels(GSList *channels)
569 struct sr_channel *ch;
570 gboolean enabled_pod1, enabled_chan4;
572 enabled_pod1 = enabled_chan4 = FALSE;
574 /* Note: On the DLM2000, CH4 and Logic are shared. */
575 /* TODO Handle non-DLM2000 models. */
576 for (l = channels; l; l = l->next) {
579 case SR_CHANNEL_ANALOG:
581 enabled_chan4 = TRUE;
583 case SR_CHANNEL_LOGIC:
591 if (enabled_pod1 && enabled_chan4)
597 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
600 gboolean digital_added;
601 struct sr_channel *ch;
602 struct dev_context *devc;
603 struct sr_scpi_dev_inst *scpi;
607 digital_added = FALSE;
609 g_slist_free(devc->enabled_channels);
610 devc->enabled_channels = NULL;
612 for (l = sdi->channels; l; l = l->next) {
616 /* Only add a single digital channel. */
617 if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
618 devc->enabled_channels = g_slist_append(
619 devc->enabled_channels, ch);
620 if (ch->type == SR_CHANNEL_LOGIC)
621 digital_added = TRUE;
625 if (!devc->enabled_channels)
628 if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
629 sr_err("Invalid channel configuration specified!");
633 /* Request data for the first enabled channel. */
634 devc->current_channel = devc->enabled_channels;
635 dlm_channel_data_request(sdi);
637 /* Call our callback when data comes in or after 5ms. */
638 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 5,
639 dlm_data_receive, (void *)sdi);
644 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
646 struct dev_context *devc;
648 std_session_send_df_end(sdi);
652 devc->num_frames = 0;
653 g_slist_free(devc->enabled_channels);
654 devc->enabled_channels = NULL;
656 sr_scpi_source_remove(sdi->session, sdi->conn);
661 static struct sr_dev_driver yokogawa_dlm_driver_info = {
662 .name = "yokogawa-dlm",
663 .longname = "Yokogawa DL/DLM",
666 .cleanup = std_cleanup,
668 .dev_list = std_dev_list,
669 .dev_clear = dev_clear,
670 .config_get = config_get,
671 .config_set = config_set,
672 .config_channel_set = config_channel_set,
673 .config_list = config_list,
674 .dev_open = dev_open,
675 .dev_close = dev_close,
676 .dev_acquisition_start = dev_acquisition_start,
677 .dev_acquisition_stop = dev_acquisition_stop,
680 SR_REGISTER_DEV_DRIVER(yokogawa_dlm_driver_info);