2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #define SERIALCOMM "115200/8n1/flow=1"
27 static struct sr_dev_driver hameg_hmo_driver_info;
29 static const char *manufacturers[] = {
34 static const uint32_t scanopts[] = {
39 static const uint32_t drvopts[] = {
50 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
52 struct sr_dev_inst *sdi;
53 struct dev_context *devc;
54 struct sr_scpi_hw_info *hw_info;
60 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
61 sr_info("Couldn't get IDN response.");
65 if (std_str_idx_s(hw_info->manufacturer, ARRAY_AND_SIZE(manufacturers)) < 0)
68 sdi = g_malloc0(sizeof(struct sr_dev_inst));
69 sdi->vendor = g_strdup(hw_info->manufacturer);
70 sdi->model = g_strdup(hw_info->model);
71 sdi->version = g_strdup(hw_info->firmware_version);
72 sdi->serial_num = g_strdup(hw_info->serial_number);
73 sdi->driver = &hameg_hmo_driver_info;
74 sdi->inst_type = SR_INST_SCPI;
77 sr_scpi_hw_info_free(hw_info);
80 devc = g_malloc0(sizeof(struct dev_context));
84 if (hmo_init_device(sdi) != SR_OK)
90 sr_scpi_hw_info_free(hw_info);
91 sr_dev_inst_free(sdi);
97 static GSList *scan(struct sr_dev_driver *di, GSList *options)
99 return sr_scpi_scan(di->context, options, probe_device);
102 static void clear_helper(struct dev_context *devc)
104 hmo_scope_state_free(devc->model_state);
105 g_free(devc->analog_groups);
106 g_free(devc->digital_groups);
109 static int dev_clear(const struct sr_dev_driver *di)
111 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
114 static int dev_open(struct sr_dev_inst *sdi)
116 if (sr_scpi_open(sdi->conn) != SR_OK)
119 if (hmo_scope_state_get(sdi) != SR_OK)
125 static int dev_close(struct sr_dev_inst *sdi)
127 return sr_scpi_close(sdi->conn);
130 static int check_channel_group(struct dev_context *devc,
131 const struct sr_channel_group *cg)
133 const struct scope_config *model;
135 model = devc->model_config;
140 if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) >= 0)
143 if (std_cg_idx(cg, devc->digital_groups, model->digital_pods) >= 0)
146 sr_err("Invalid channel group specified.");
151 static int config_get(uint32_t key, GVariant **data,
152 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
155 struct dev_context *devc;
156 const struct scope_config *model;
157 struct scope_state *state;
164 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
167 model = devc->model_config;
168 state = devc->model_state;
171 case SR_CONF_NUM_HDIV:
172 *data = g_variant_new_int32(model->num_xdivs);
174 case SR_CONF_TIMEBASE:
175 *data = g_variant_new("(tt)", (*model->timebases)[state->timebase][0],
176 (*model->timebases)[state->timebase][1]);
178 case SR_CONF_NUM_VDIV:
180 return SR_ERR_CHANNEL_GROUP;
181 if (cg_type != CG_ANALOG)
183 if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) < 0)
185 *data = g_variant_new_int32(model->num_ydivs);
189 return SR_ERR_CHANNEL_GROUP;
190 if (cg_type != CG_ANALOG)
192 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
194 *data = g_variant_new("(tt)",
195 (*model->vdivs)[state->analog_channels[idx].vdiv][0],
196 (*model->vdivs)[state->analog_channels[idx].vdiv][1]);
198 case SR_CONF_TRIGGER_SOURCE:
199 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
201 case SR_CONF_TRIGGER_SLOPE:
202 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
204 case SR_CONF_HORIZ_TRIGGERPOS:
205 *data = g_variant_new_double(state->horiz_triggerpos);
207 case SR_CONF_COUPLING:
209 return SR_ERR_CHANNEL_GROUP;
210 if (cg_type != CG_ANALOG)
212 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
214 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[idx].coupling]);
216 case SR_CONF_SAMPLERATE:
217 *data = g_variant_new_uint64(state->sample_rate);
226 static int config_set(uint32_t key, GVariant *data,
227 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
229 int ret, cg_type, idx, j;
230 char command[MAX_COMMAND_SIZE], float_str[30];
231 struct dev_context *devc;
232 const struct scope_config *model;
233 struct scope_state *state;
235 gboolean update_sample_rate;
242 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
245 model = devc->model_config;
246 state = devc->model_state;
247 update_sample_rate = FALSE;
250 case SR_CONF_LIMIT_FRAMES:
251 devc->frame_limit = g_variant_get_uint64(data);
254 case SR_CONF_TRIGGER_SOURCE:
255 if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
257 state->trigger_source = idx;
258 g_snprintf(command, sizeof(command),
259 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
260 (*model->trigger_sources)[idx]);
261 ret = sr_scpi_send(sdi->conn, command);
265 return SR_ERR_CHANNEL_GROUP;
266 if ((idx = std_u64_tuple_idx(data, *model->vdivs, model->num_vdivs)) < 0)
268 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
270 state->analog_channels[j].vdiv = idx;
271 g_ascii_formatd(float_str, sizeof(float_str), "%E",
272 (float) (*model->vdivs)[idx][0] / (*model->vdivs)[idx][1]);
273 g_snprintf(command, sizeof(command),
274 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
276 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
277 sr_scpi_get_opc(sdi->conn) != SR_OK)
281 case SR_CONF_TIMEBASE:
282 if ((idx = std_u64_tuple_idx(data, *model->timebases, model->num_timebases)) < 0)
284 state->timebase = idx;
285 g_ascii_formatd(float_str, sizeof(float_str), "%E",
286 (float) (*model->timebases)[idx][0] / (*model->timebases)[idx][1]);
287 g_snprintf(command, sizeof(command),
288 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
290 ret = sr_scpi_send(sdi->conn, command);
291 update_sample_rate = TRUE;
293 case SR_CONF_HORIZ_TRIGGERPOS:
294 tmp_d = g_variant_get_double(data);
295 if (tmp_d < 0.0 || tmp_d > 1.0)
297 state->horiz_triggerpos = tmp_d;
298 tmp_d = -(tmp_d - 0.5) *
299 ((double) (*model->timebases)[state->timebase][0] /
300 (*model->timebases)[state->timebase][1])
302 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
303 g_snprintf(command, sizeof(command),
304 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
306 ret = sr_scpi_send(sdi->conn, command);
308 case SR_CONF_TRIGGER_SLOPE:
309 if ((idx = std_str_idx(data, *model->trigger_slopes, model->num_trigger_slopes)) < 0)
311 state->trigger_slope = idx;
312 g_snprintf(command, sizeof(command),
313 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
314 (*model->trigger_slopes)[idx]);
315 ret = sr_scpi_send(sdi->conn, command);
317 case SR_CONF_COUPLING:
319 return SR_ERR_CHANNEL_GROUP;
320 if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
322 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
324 state->analog_channels[j].coupling = idx;
325 g_snprintf(command, sizeof(command),
326 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
327 j + 1, (*model->coupling_options)[idx]);
328 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
329 sr_scpi_get_opc(sdi->conn) != SR_OK)
339 ret = sr_scpi_get_opc(sdi->conn);
341 if (ret == SR_OK && update_sample_rate)
342 ret = hmo_update_sample_rate(sdi);
347 static int config_list(uint32_t key, GVariant **data,
348 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
350 int cg_type = CG_NONE;
351 struct dev_context *devc = NULL;
352 const struct scope_config *model = NULL;
356 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
359 model = devc->model_config;
363 case SR_CONF_SCAN_OPTIONS:
364 *data = std_gvar_array_u32(ARRAY_AND_SIZE(scanopts));
366 case SR_CONF_DEVICE_OPTIONS:
369 *data = std_gvar_array_u32((const uint32_t *)model->devopts, model->num_devopts);
371 *data = std_gvar_array_u32(ARRAY_AND_SIZE(drvopts));
372 } else if (cg_type == CG_ANALOG) {
373 *data = std_gvar_array_u32((const uint32_t *)model->devopts_cg_analog, model->num_devopts_cg_analog);
375 *data = std_gvar_array_u32(NULL, 0);
378 case SR_CONF_COUPLING:
380 return SR_ERR_CHANNEL_GROUP;
383 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
385 case SR_CONF_TRIGGER_SOURCE:
388 *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
390 case SR_CONF_TRIGGER_SLOPE:
393 *data = g_variant_new_strv(*model->trigger_slopes, model->num_trigger_slopes);
395 case SR_CONF_TIMEBASE:
398 *data = std_gvar_tuple_array(*model->timebases, model->num_timebases);
402 return SR_ERR_CHANNEL_GROUP;
405 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
414 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
416 char command[MAX_COMMAND_SIZE];
417 struct sr_channel *ch;
418 struct dev_context *devc;
419 const struct scope_config *model;
422 model = devc->model_config;
424 ch = devc->current_channel->data;
427 case SR_CHANNEL_ANALOG:
428 g_snprintf(command, sizeof(command),
429 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
430 #ifdef WORDS_BIGENDIAN
437 case SR_CHANNEL_LOGIC:
438 g_snprintf(command, sizeof(command),
439 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
440 ch->index < 8 ? 1 : 2);
443 sr_err("Invalid channel type.");
447 return sr_scpi_send(sdi->conn, command);
450 static int hmo_check_channels(GSList *channels)
453 struct sr_channel *ch;
454 gboolean enabled_chan[MAX_ANALOG_CHANNEL_COUNT];
455 gboolean enabled_pod[MAX_DIGITAL_GROUP_COUNT];
458 /* Preset "not enabled" for all channels / pods. */
459 for (idx = 0; idx < ARRAY_SIZE(enabled_chan); idx++)
460 enabled_chan[idx] = FALSE;
461 for (idx = 0; idx < ARRAY_SIZE(enabled_pod); idx++)
462 enabled_pod[idx] = FALSE;
465 * Determine which channels / pods are required for the caller's
466 * specified configuration.
468 for (l = channels; l; l = l->next) {
471 case SR_CHANNEL_ANALOG:
473 if (idx < ARRAY_SIZE(enabled_chan))
474 enabled_chan[idx] = TRUE;
476 case SR_CHANNEL_LOGIC:
478 if (idx < ARRAY_SIZE(enabled_pod))
479 enabled_pod[idx] = TRUE;
487 * Check for resource conflicts. Some channels can be either
488 * analog or digital, but never both at the same time.
490 * Note that the constraints might depend on the specific model.
491 * These tests might need some adjustment when support for more
492 * models gets added to the driver.
494 if (enabled_pod[0] && enabled_chan[2])
496 if (enabled_pod[1] && enabled_chan[3])
501 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
505 gboolean *pod_enabled, setup_changed;
506 char command[MAX_COMMAND_SIZE];
507 struct scope_state *state;
508 const struct scope_config *model;
509 struct sr_channel *ch;
510 struct dev_context *devc;
511 struct sr_scpi_dev_inst *scpi;
515 state = devc->model_state;
516 model = devc->model_config;
517 setup_changed = FALSE;
519 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
521 for (l = sdi->channels; l; l = l->next) {
524 case SR_CHANNEL_ANALOG:
525 if (ch->enabled == state->analog_channels[ch->index].state)
527 g_snprintf(command, sizeof(command),
528 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
529 ch->index + 1, ch->enabled);
531 if (sr_scpi_send(scpi, command) != SR_OK)
533 state->analog_channels[ch->index].state = ch->enabled;
534 setup_changed = TRUE;
536 case SR_CHANNEL_LOGIC:
538 * A digital POD needs to be enabled for every group of
542 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
544 if (ch->enabled == state->digital_channels[ch->index])
546 g_snprintf(command, sizeof(command),
547 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
548 ch->index, ch->enabled);
550 if (sr_scpi_send(scpi, command) != SR_OK)
553 state->digital_channels[ch->index] = ch->enabled;
554 setup_changed = TRUE;
562 for (i = 0; i < model->digital_pods; i++) {
563 if (state->digital_pods[i] == pod_enabled[i])
565 g_snprintf(command, sizeof(command),
566 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
567 i + 1, pod_enabled[i]);
568 if (sr_scpi_send(scpi, command) != SR_OK)
570 state->digital_pods[i] = pod_enabled[i];
571 setup_changed = TRUE;
576 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
582 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
585 gboolean digital_added[MAX_DIGITAL_GROUP_COUNT];
586 size_t group, pod_count;
587 struct sr_channel *ch;
588 struct dev_context *devc;
589 struct sr_scpi_dev_inst *scpi;
595 /* Preset empty results. */
596 for (group = 0; group < ARRAY_SIZE(digital_added); group++)
597 digital_added[group] = FALSE;
598 g_slist_free(devc->enabled_channels);
599 devc->enabled_channels = NULL;
602 * Contruct the list of enabled channels. Determine the highest
603 * number of digital pods involved in the acquisition.
606 for (l = sdi->channels; l; l = l->next) {
610 /* Only add a single digital channel per group (pod). */
611 group = ch->index / 8;
612 if (ch->type != SR_CHANNEL_LOGIC || !digital_added[group]) {
613 devc->enabled_channels = g_slist_append(
614 devc->enabled_channels, ch);
615 if (ch->type == SR_CHANNEL_LOGIC) {
616 digital_added[group] = TRUE;
617 if (pod_count < group + 1)
618 pod_count = group + 1;
622 if (!devc->enabled_channels)
624 devc->pod_count = pod_count;
625 devc->logic_data = NULL;
628 * Check constraints. Some channels can be either analog or
629 * digital, but not both at the same time.
631 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
632 sr_err("Invalid channel configuration specified!");
638 * Configure the analog and digital channels and the
639 * corresponding digital pods.
641 if (hmo_setup_channels(sdi) != SR_OK) {
642 sr_err("Failed to setup channel configuration!");
648 * Start acquisition on the first enabled channel. The
649 * receive routine will continue driving the acquisition.
651 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
652 hmo_receive_data, (void *)sdi);
654 std_session_send_df_header(sdi);
656 devc->current_channel = devc->enabled_channels;
658 return hmo_request_data(sdi);
661 g_slist_free(devc->enabled_channels);
662 devc->enabled_channels = NULL;
666 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
668 struct dev_context *devc;
669 struct sr_scpi_dev_inst *scpi;
671 std_session_send_df_end(sdi);
675 devc->num_frames = 0;
676 g_slist_free(devc->enabled_channels);
677 devc->enabled_channels = NULL;
679 sr_scpi_source_remove(sdi->session, scpi);
684 static struct sr_dev_driver hameg_hmo_driver_info = {
686 .longname = "Hameg HMO",
689 .cleanup = std_cleanup,
691 .dev_list = std_dev_list,
692 .dev_clear = dev_clear,
693 .config_get = config_get,
694 .config_set = config_set,
695 .config_list = config_list,
696 .dev_open = dev_open,
697 .dev_close = dev_close,
698 .dev_acquisition_start = dev_acquisition_start,
699 .dev_acquisition_stop = dev_acquisition_stop,
702 SR_REGISTER_DEV_DRIVER(hameg_hmo_driver_info);