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;
252 case SR_CONF_LIMIT_FRAMES:
253 devc->frame_limit = g_variant_get_uint64(data);
256 case SR_CONF_TRIGGER_SOURCE:
257 if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
259 state->trigger_source = idx;
260 g_snprintf(command, sizeof(command),
261 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
262 (*model->trigger_sources)[idx]);
263 ret = sr_scpi_send(sdi->conn, command);
267 return SR_ERR_CHANNEL_GROUP;
268 if ((idx = std_u64_tuple_idx(data, *model->vdivs, model->num_vdivs)) < 0)
270 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
272 state->analog_channels[j].vdiv = idx;
273 g_ascii_formatd(float_str, sizeof(float_str), "%E",
274 (float) (*model->vdivs)[idx][0] / (*model->vdivs)[idx][1]);
275 g_snprintf(command, sizeof(command),
276 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
278 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
279 sr_scpi_get_opc(sdi->conn) != SR_OK)
283 case SR_CONF_TIMEBASE:
284 if ((idx = std_u64_tuple_idx(data, *model->timebases, model->num_timebases)) < 0)
286 state->timebase = idx;
287 g_ascii_formatd(float_str, sizeof(float_str), "%E",
288 (float) (*model->timebases)[idx][0] / (*model->timebases)[idx][1]);
289 g_snprintf(command, sizeof(command),
290 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
292 ret = sr_scpi_send(sdi->conn, command);
293 update_sample_rate = TRUE;
295 case SR_CONF_HORIZ_TRIGGERPOS:
296 tmp_d = g_variant_get_double(data);
297 if (tmp_d < 0.0 || tmp_d > 1.0)
299 state->horiz_triggerpos = tmp_d;
300 tmp_d = -(tmp_d - 0.5) *
301 ((double) (*model->timebases)[state->timebase][0] /
302 (*model->timebases)[state->timebase][1])
304 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
305 g_snprintf(command, sizeof(command),
306 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
308 ret = sr_scpi_send(sdi->conn, command);
310 case SR_CONF_TRIGGER_SLOPE:
311 if ((idx = std_str_idx(data, *model->trigger_slopes, model->num_trigger_slopes)) < 0)
313 state->trigger_slope = idx;
314 g_snprintf(command, sizeof(command),
315 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
316 (*model->trigger_slopes)[idx]);
317 ret = sr_scpi_send(sdi->conn, command);
319 case SR_CONF_COUPLING:
321 return SR_ERR_CHANNEL_GROUP;
322 if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
324 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
326 state->analog_channels[j].coupling = idx;
327 g_snprintf(command, sizeof(command),
328 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
329 j + 1, (*model->coupling_options)[idx]);
330 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
331 sr_scpi_get_opc(sdi->conn) != SR_OK)
341 ret = sr_scpi_get_opc(sdi->conn);
343 if (ret == SR_OK && update_sample_rate)
344 ret = hmo_update_sample_rate(sdi);
349 static int config_list(uint32_t key, GVariant **data,
350 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
352 int cg_type = CG_NONE;
353 struct dev_context *devc = NULL;
354 const struct scope_config *model = NULL;
358 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
361 model = devc->model_config;
365 case SR_CONF_SCAN_OPTIONS:
366 *data = std_gvar_array_u32(ARRAY_AND_SIZE(scanopts));
368 case SR_CONF_DEVICE_OPTIONS:
371 *data = std_gvar_array_u32((const uint32_t *)model->devopts, model->num_devopts);
373 *data = std_gvar_array_u32(ARRAY_AND_SIZE(drvopts));
374 } else if (cg_type == CG_ANALOG) {
375 *data = std_gvar_array_u32((const uint32_t *)model->devopts_cg_analog, model->num_devopts_cg_analog);
377 *data = std_gvar_array_u32(NULL, 0);
380 case SR_CONF_COUPLING:
382 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;
403 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
412 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
414 char command[MAX_COMMAND_SIZE];
415 struct sr_channel *ch;
416 struct dev_context *devc;
417 const struct scope_config *model;
420 model = devc->model_config;
422 ch = devc->current_channel->data;
425 case SR_CHANNEL_ANALOG:
426 g_snprintf(command, sizeof(command),
427 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
428 #ifdef WORDS_BIGENDIAN
435 case SR_CHANNEL_LOGIC:
436 g_snprintf(command, sizeof(command),
437 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
438 ch->index < 8 ? 1 : 2);
441 sr_err("Invalid channel type.");
445 return sr_scpi_send(sdi->conn, command);
448 static int hmo_check_channels(GSList *channels)
451 struct sr_channel *ch;
452 gboolean enabled_chan[MAX_ANALOG_CHANNEL_COUNT];
453 gboolean enabled_pod[MAX_DIGITAL_GROUP_COUNT];
456 /* Preset "not enabled" for all channels / pods. */
457 for (idx = 0; idx < ARRAY_SIZE(enabled_chan); idx++)
458 enabled_chan[idx] = FALSE;
459 for (idx = 0; idx < ARRAY_SIZE(enabled_pod); idx++)
460 enabled_pod[idx] = FALSE;
463 * Determine which channels / pods are required for the caller's
464 * specified configuration.
466 for (l = channels; l; l = l->next) {
469 case SR_CHANNEL_ANALOG:
471 if (idx < ARRAY_SIZE(enabled_chan))
472 enabled_chan[idx] = TRUE;
474 case SR_CHANNEL_LOGIC:
476 if (idx < ARRAY_SIZE(enabled_pod))
477 enabled_pod[idx] = TRUE;
485 * Check for resource conflicts. Some channels can be either
486 * analog or digital, but never both at the same time.
488 * Note that the constraints might depend on the specific model.
489 * These tests might need some adjustment when support for more
490 * models gets added to the driver.
492 if (enabled_pod[0] && enabled_chan[2])
494 if (enabled_pod[1] && enabled_chan[3])
499 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
503 gboolean *pod_enabled, setup_changed;
504 char command[MAX_COMMAND_SIZE];
505 struct scope_state *state;
506 const struct scope_config *model;
507 struct sr_channel *ch;
508 struct dev_context *devc;
509 struct sr_scpi_dev_inst *scpi;
513 state = devc->model_state;
514 model = devc->model_config;
515 setup_changed = FALSE;
517 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
519 for (l = sdi->channels; l; l = l->next) {
522 case SR_CHANNEL_ANALOG:
523 if (ch->enabled == state->analog_channels[ch->index].state)
525 g_snprintf(command, sizeof(command),
526 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
527 ch->index + 1, ch->enabled);
529 if (sr_scpi_send(scpi, command) != SR_OK)
531 state->analog_channels[ch->index].state = ch->enabled;
532 setup_changed = TRUE;
534 case SR_CHANNEL_LOGIC:
536 * A digital POD needs to be enabled for every group of
540 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
542 if (ch->enabled == state->digital_channels[ch->index])
544 g_snprintf(command, sizeof(command),
545 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
546 ch->index, ch->enabled);
548 if (sr_scpi_send(scpi, command) != SR_OK)
551 state->digital_channels[ch->index] = ch->enabled;
552 setup_changed = TRUE;
559 for (i = 0; i < model->digital_pods; i++) {
560 if (state->digital_pods[i] == pod_enabled[i])
562 g_snprintf(command, sizeof(command),
563 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
564 i + 1, pod_enabled[i]);
565 if (sr_scpi_send(scpi, command) != SR_OK)
567 state->digital_pods[i] = pod_enabled[i];
568 setup_changed = TRUE;
573 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
579 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
582 gboolean digital_added[MAX_DIGITAL_GROUP_COUNT];
583 size_t group, pod_count;
584 struct sr_channel *ch;
585 struct dev_context *devc;
586 struct sr_scpi_dev_inst *scpi;
592 /* Preset empty results. */
593 for (group = 0; group < ARRAY_SIZE(digital_added); group++)
594 digital_added[group] = FALSE;
595 g_slist_free(devc->enabled_channels);
596 devc->enabled_channels = NULL;
599 * Contruct the list of enabled channels. Determine the highest
600 * number of digital pods involved in the acquisition.
603 for (l = sdi->channels; l; l = l->next) {
607 /* Only add a single digital channel per group (pod). */
608 group = ch->index / 8;
609 if (ch->type != SR_CHANNEL_LOGIC || !digital_added[group]) {
610 devc->enabled_channels = g_slist_append(
611 devc->enabled_channels, ch);
612 if (ch->type == SR_CHANNEL_LOGIC) {
613 digital_added[group] = TRUE;
614 if (pod_count < group + 1)
615 pod_count = group + 1;
619 if (!devc->enabled_channels)
621 devc->pod_count = pod_count;
622 devc->logic_data = NULL;
625 * Check constraints. Some channels can be either analog or
626 * digital, but not both at the same time.
628 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
629 sr_err("Invalid channel configuration specified!");
635 * Configure the analog and digital channels and the
636 * corresponding digital pods.
638 if (hmo_setup_channels(sdi) != SR_OK) {
639 sr_err("Failed to setup channel configuration!");
645 * Start acquisition on the first enabled channel. The
646 * receive routine will continue driving the acquisition.
648 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
649 hmo_receive_data, (void *)sdi);
651 std_session_send_df_header(sdi);
653 devc->current_channel = devc->enabled_channels;
655 return hmo_request_data(sdi);
658 g_slist_free(devc->enabled_channels);
659 devc->enabled_channels = NULL;
663 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
665 struct dev_context *devc;
666 struct sr_scpi_dev_inst *scpi;
668 std_session_send_df_end(sdi);
672 devc->num_frames = 0;
673 g_slist_free(devc->enabled_channels);
674 devc->enabled_channels = NULL;
676 sr_scpi_source_remove(sdi->session, scpi);
681 static struct sr_dev_driver hameg_hmo_driver_info = {
683 .longname = "Hameg HMO",
686 .cleanup = std_cleanup,
688 .dev_list = std_dev_list,
689 .dev_clear = dev_clear,
690 .config_get = config_get,
691 .config_set = config_set,
692 .config_list = config_list,
693 .dev_open = dev_open,
694 .dev_close = dev_close,
695 .dev_acquisition_start = dev_acquisition_start,
696 .dev_acquisition_stop = dev_acquisition_stop,
699 SR_REGISTER_DEV_DRIVER(hameg_hmo_driver_info);