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/>.
22 * <em>Yokogawa DL/DLM series</em> oscilloscope driver
28 static const char *dlm_coupling_options[] = {
36 static const char *dlm_2ch_trigger_sources[] = {
44 /* TODO: Is BITx handled correctly or is Dx required? */
45 static const char *dlm_4ch_trigger_sources[] = {
63 /* Note: Values must correlate to the trigger_slopes values */
64 const char *dlm_trigger_slopes[3] = {
70 const uint64_t dlm_timebases[36][2] = {
113 const uint64_t dlm_vdivs[17][2] = {
135 static const char *scope_analog_channel_names[] = {
142 static const char *scope_digital_channel_names_8[] = {
153 static const char *scope_digital_channel_names_32[] = {
188 static const struct scope_config scope_models[] = {
190 .model_id = {"710105", "710115", "710125", NULL},
191 .model_name = {"DLM2022", "DLM2032", "DLM2052", NULL},
192 .analog_channels = 2,
193 .digital_channels = 0,
196 .analog_names = &scope_analog_channel_names,
197 .digital_names = &scope_digital_channel_names_8,
199 .coupling_options = &dlm_coupling_options,
200 .trigger_sources = &dlm_2ch_trigger_sources,
206 .model_id = {"710110", "710120", "710130", NULL},
207 .model_name = {"DLM2024", "DLM2034", "DLM2054", NULL},
208 .analog_channels = 4,
209 .digital_channels = 8,
212 .analog_names = &scope_analog_channel_names,
213 .digital_names = &scope_digital_channel_names_8,
215 .coupling_options = &dlm_coupling_options,
216 .trigger_sources = &dlm_4ch_trigger_sources,
222 .model_id = {"701307", "701308", "701310", "701311",
223 "701312", "701313", NULL},
224 .model_name = {"DL9040", "DL9040L", "DL9140", "DL9140L",
225 "DL9240", "DL9240L", NULL},
226 .analog_channels = 4,
227 .digital_channels = 0,
230 .analog_names = &scope_analog_channel_names,
231 .digital_names = NULL,
233 .coupling_options = &dlm_coupling_options,
234 .trigger_sources = &dlm_4ch_trigger_sources,
240 .model_id = {"701320", "701321", NULL},
241 .model_name = {"DL9505L", "DL9510L", NULL},
242 .analog_channels = 4,
243 .digital_channels = 16,
246 .analog_names = &scope_analog_channel_names,
247 .digital_names = &scope_digital_channel_names_32,
249 .coupling_options = &dlm_coupling_options,
250 .trigger_sources = &dlm_4ch_trigger_sources,
256 .model_id = {"701330", "701331", NULL},
257 .model_name = {"DL9705L", "DL9710L", NULL},
258 .analog_channels = 4,
259 .digital_channels = 32,
262 .analog_names = &scope_analog_channel_names,
263 .digital_names = &scope_digital_channel_names_32,
265 .coupling_options = &dlm_coupling_options,
266 .trigger_sources = &dlm_4ch_trigger_sources,
274 * Prints out the state of the device as we currently know it.
276 * @param config This is the scope configuration.
277 * @param state The current scope state to print.
279 static void scope_state_dump(const struct scope_config *config,
280 struct scope_state *state)
285 for (i = 0; i < config->analog_channels; ++i) {
286 tmp = sr_voltage_string(dlm_vdivs[state->analog_states[i].vdiv][0],
287 dlm_vdivs[state->analog_states[i].vdiv][1]);
288 sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
289 i + 1, state->analog_states[i].state ? "On" : "Off",
290 (*config->coupling_options)[state->analog_states[i].coupling],
291 tmp, state->analog_states[i].vertical_offset);
294 for (i = 0; i < config->digital_channels; ++i) {
295 sr_info("State of digital channel %d -> %s", i,
296 state->digital_states[i] ? "On" : "Off");
299 for (i = 0; i < config->pods; ++i) {
300 sr_info("State of digital POD %d -> %s", i,
301 state->pod_states[i] ? "On" : "Off");
304 tmp = sr_period_string(dlm_timebases[state->timebase][0] *
305 dlm_timebases[state->timebase][1]);
306 sr_info("Current timebase: %s", tmp);
309 tmp = sr_samplerate_string(state->sample_rate);
310 sr_info("Current samplerate: %s", tmp);
313 sr_info("Current samples per acquisition (i.e. frame): %d",
314 state->samples_per_frame);
316 sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
317 (*config->trigger_sources)[state->trigger_source],
318 dlm_trigger_slopes[state->trigger_slope],
319 state->horiz_triggerpos);
323 * Searches through an array of strings and returns the index to the
324 * array where a given string is located.
326 * @param value The string to search for.
327 * @param array The array of strings.
328 * @param result The index at which value is located in array. -1 on error.
330 * @return SR_ERR when value couldn't be found, SR_OK otherwise.
332 static int array_option_get(char *value, const char *(*array)[],
339 for (i = 0; (*array)[i]; ++i)
340 if (!g_strcmp0(value, (*array)[i])) {
352 * This function takes a value of the form "2.000E-03", converts it to a
353 * significand / factor pair and returns the index of an array where
354 * a matching pair was found.
356 * It's a bit convoluted because of floating-point issues. The value "10.00E-09"
357 * is parsed by g_ascii_strtod() as 0.000000009999999939, for example.
358 * Therefore it's easier to break the number up into two strings and handle
361 * @param value The string to be parsed.
362 * @param array The array of s/f pairs.
363 * @param array_len The number of pairs in the array.
364 * @param result The index at which a matching pair was found.
366 * @return SR_ERR on any parsing error, SR_OK otherwise.
368 static int array_float_get(gchar *value, const uint64_t array[][2],
369 int array_len, int *result)
375 gchar ss[10], es[10];
377 memset(ss, 0, sizeof(ss));
378 memset(es, 0, sizeof(es));
380 strncpy(ss, value, 5);
381 strncpy(es, &(value[6]), 3);
383 if (sr_atof_ascii(ss, &s) != SR_OK)
385 if (sr_atoi(es, &i) != SR_OK)
388 /* Transform e.g. 10^-03 to 1000 as the array stores the inverse. */
391 /* Adjust the significand/factor pair to make sure
392 * that f is a multiple of 1000.
394 while ((int)fmod(log10(f), 3) > 0) { s *= 10; f *= 10; }
396 /* Truncate s to circumvent rounding errors. */
397 s_int = (unsigned int)s;
399 for (i = 0; i < array_len; i++) {
400 if ( (s_int == array[i][0]) && (f == array[i][1]) ) {
410 * Obtains information about all analog channels from the oscilloscope.
411 * The internal state information is updated accordingly.
413 * @param scpi An open SCPI connection.
414 * @param config The device's device configuration.
415 * @param state The device's state information.
417 * @return SR_ERR on error, SR_OK otherwise.
419 static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
420 const struct scope_config *config,
421 struct scope_state *state)
426 for (i = 0; i < config->analog_channels; ++i) {
428 if (dlm_analog_chan_state_get(scpi, i + 1,
429 &state->analog_states[i].state) != SR_OK)
432 if (dlm_analog_chan_vdiv_get(scpi, i + 1, &response) != SR_OK)
435 if (array_float_get(response, dlm_vdivs, ARRAY_SIZE(dlm_vdivs),
442 state->analog_states[i].vdiv = j;
444 if (dlm_analog_chan_voffs_get(scpi, i + 1,
445 &state->analog_states[i].vertical_offset) != SR_OK)
448 if (dlm_analog_chan_wrange_get(scpi, i + 1,
449 &state->analog_states[i].waveform_range) != SR_OK)
452 if (dlm_analog_chan_woffs_get(scpi, i + 1,
453 &state->analog_states[i].waveform_offset) != SR_OK)
456 if (dlm_analog_chan_coupl_get(scpi, i + 1, &response) != SR_OK) {
461 if (array_option_get(response, config->coupling_options,
462 &state->analog_states[i].coupling) != SR_OK) {
473 * Obtains information about all digital channels from the oscilloscope.
474 * The internal state information is updated accordingly.
476 * @param scpi An open SCPI connection.
477 * @param config The device's device configuration.
478 * @param state The device's state information.
480 * @return SR_ERR on error, SR_OK otherwise.
482 static int digital_channel_state_get(struct sr_scpi_dev_inst *scpi,
483 const struct scope_config *config,
484 struct scope_state *state)
488 if (!config->digital_channels)
490 sr_warn("Tried obtaining digital channel states on a " \
491 "model without digital inputs.");
495 for (i = 0; i < config->digital_channels; ++i) {
496 if (dlm_digital_chan_state_get(scpi, i + 1,
497 &state->digital_states[i]) != SR_OK) {
504 sr_warn("Tried obtaining pod states on a model without pods.");
508 for (i = 0; i < config->pods; ++i) {
509 if (dlm_digital_pod_state_get(scpi, i + 'A',
510 &state->pod_states[i]) != SR_OK)
518 * Obtains information about the sample rate from the oscilloscope.
519 * The internal state information is updated accordingly.
521 * @param sdi The device instance.
523 * @return SR_ERR on error, SR_OK otherwise.
525 SR_PRIV int dlm_sample_rate_query(const struct sr_dev_inst *sdi)
527 struct dev_context *devc;
528 struct scope_state *state;
532 state = devc->model_state;
534 /* No need to find an active channel to query the sample rate:
535 * querying any channel will do, so we use channel 1 all the time.
537 if (dlm_analog_chan_srate_get(sdi->conn, 1, &tmp_float) != SR_OK)
540 state->sample_rate = tmp_float;
546 * Obtains information about the current device state from the oscilloscope,
547 * including all analog and digital channel configurations.
548 * The internal state information is updated accordingly.
550 * @param sdi The device instance.
552 * @return SR_ERR on error, SR_OK otherwise.
554 SR_PRIV int dlm_scope_state_query(struct sr_dev_inst *sdi)
556 struct dev_context *devc;
557 struct scope_state *state;
558 const struct scope_config *config;
564 config = devc->model_config;
565 state = devc->model_state;
567 if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
570 if (digital_channel_state_get(sdi->conn, config, state) != SR_OK)
573 if (dlm_timebase_get(sdi->conn, &response) != SR_OK)
576 if (array_float_get(response, dlm_timebases,
577 ARRAY_SIZE(dlm_timebases), &i) != SR_OK) {
585 if (dlm_horiz_trigger_pos_get(sdi->conn, &tmp_float) != SR_OK)
588 /* TODO: Check if the calculation makes sense for the DLM. */
589 state->horiz_triggerpos = tmp_float /
590 (((double)dlm_timebases[state->timebase][0] /
591 dlm_timebases[state->timebase][1]) * config->num_xdivs);
592 state->horiz_triggerpos -= 0.5;
593 state->horiz_triggerpos *= -1;
595 if (dlm_trigger_source_get(sdi->conn, &response) != SR_OK) {
600 if (array_option_get(response, config->trigger_sources,
601 &state->trigger_source) != SR_OK) {
608 if (dlm_trigger_slope_get(sdi->conn, &i) != SR_OK)
611 state->trigger_slope = i;
613 if (dlm_acq_length_get(sdi->conn, &state->samples_per_frame) != SR_OK) {
614 sr_err("Failed to query acquisition length.");
618 dlm_sample_rate_query(sdi);
620 scope_state_dump(config, state);
626 * Creates a new device state structure.
628 * @param config The device configuration to use.
630 * @return The newly allocated scope_state struct.
632 static struct scope_state *dlm_scope_state_new(const struct scope_config *config)
634 struct scope_state *state;
636 state = g_malloc0(sizeof(struct scope_state));
638 state->analog_states = g_malloc0(config->analog_channels *
639 sizeof(struct analog_channel_state));
641 state->digital_states = g_malloc0(config->digital_channels *
644 state->pod_states = g_malloc0(config->pods * sizeof(gboolean));
650 * Frees the memory that was allocated by a call to dlm_scope_state_new().
652 * @param state The device state structure whose memory is to be freed.
654 SR_PRIV void dlm_scope_state_destroy(struct scope_state *state)
656 g_free(state->analog_states);
657 g_free(state->digital_states);
658 g_free(state->pod_states);
662 SR_PRIV int dlm_model_get(char *model_id, char **model_name, int *model_index)
669 for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
670 for (j = 0; scope_models[i].model_id[j]; j++) {
671 if (!strcmp(model_id, scope_models[i].model_id[j])) {
673 *model_name = (char *)scope_models[i].model_name[j];
677 if (*model_index != -1)
681 if (*model_index == -1) {
682 sr_err("Found unsupported DLM device with model identifier %s.",
691 * Attempts to initialize a DL/DLM device and prepares internal structures
692 * if a suitable device was found.
694 * @param sdi The device instance.
696 SR_PRIV int dlm_device_init(struct sr_dev_inst *sdi, int model_index)
700 struct sr_channel *ch;
701 struct dev_context *devc;
705 devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
706 scope_models[model_index].analog_channels);
708 devc->digital_groups = g_malloc0(sizeof(struct sr_channel_group*) *
709 scope_models[model_index].pods);
711 /* Add analog channels, each in its own group. */
712 for (i = 0; i < scope_models[model_index].analog_channels; i++) {
713 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
714 (*scope_models[model_index].analog_names)[i]);
716 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
718 devc->analog_groups[i]->name = g_strdup(
719 (char *)(*scope_models[model_index].analog_names)[i]);
720 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
722 sdi->channel_groups = g_slist_append(sdi->channel_groups,
723 devc->analog_groups[i]);
726 /* Add digital channel groups. */
727 for (i = 0; i < scope_models[model_index].pods; ++i) {
728 g_snprintf(tmp, sizeof(tmp), "POD%d", i);
730 devc->digital_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
731 if (!devc->digital_groups[i])
732 return SR_ERR_MALLOC;
734 devc->digital_groups[i]->name = g_strdup(tmp);
735 sdi->channel_groups = g_slist_append(sdi->channel_groups,
736 devc->digital_groups[i]);
739 /* Add digital channels. */
740 for (i = 0; i < scope_models[model_index].digital_channels; i++) {
741 ch = sr_channel_new(sdi, DLM_DIG_CHAN_INDEX_OFFS + i,
742 SR_CHANNEL_LOGIC, TRUE,
743 (*scope_models[model_index].digital_names)[i]);
745 devc->digital_groups[i / 8]->channels = g_slist_append(
746 devc->digital_groups[i / 8]->channels, ch);
748 devc->model_config = &scope_models[model_index];
749 devc->frame_limit = 0;
751 if (!(devc->model_state = dlm_scope_state_new(devc->model_config)))
752 return SR_ERR_MALLOC;
754 /* Disable non-standard response behavior. */
755 if (dlm_response_headers_set(sdi->conn, FALSE) != SR_OK)
761 SR_PRIV int dlm_channel_data_request(const struct sr_dev_inst *sdi)
763 struct dev_context *devc;
764 struct sr_channel *ch;
768 ch = devc->current_channel->data;
771 case SR_CHANNEL_ANALOG:
772 result = dlm_analog_data_get(sdi->conn, ch->index + 1);
774 case SR_CHANNEL_LOGIC:
775 result = dlm_digital_data_get(sdi->conn);
778 sr_err("Invalid channel type encountered (%d).",
784 devc->data_pending = TRUE;
786 devc->data_pending = FALSE;
792 * Reads and removes the block data header from a given data input.
793 * Format is #ndddd... with n being the number of decimal digits d.
794 * The string dddd... contains the decimal-encoded length of the data.
795 * Example: #9000000013 would yield a length of 13 bytes.
797 * @param data The input data.
798 * @param len The determined input data length.
800 static int dlm_block_data_header_process(GArray *data, int *len)
805 if (g_array_index(data, gchar, 0) != '#')
808 n = (uint8_t)(g_array_index(data, gchar, 1) - '0');
810 for (i = 0; i < n; i++)
811 s[i] = g_array_index(data, gchar, 2 + i);
814 if (sr_atoi(s, len) != SR_OK)
817 g_array_remove_range(data, 0, 2 + n);
823 * Turns raw sample data into voltages and sends them off to the session bus.
825 * @param data The raw sample data.
826 * @ch_state Pointer to the state of the channel whose data we're processing.
827 * @sdi The device instance.
829 * @return SR_ERR when data is trucated, SR_OK otherwise.
831 static int dlm_analog_samples_send(GArray *data,
832 struct analog_channel_state *ch_state,
833 struct sr_dev_inst *sdi)
836 float voltage, range, offset;
838 struct dev_context *devc;
839 struct scope_state *model_state;
840 struct sr_channel *ch;
841 struct sr_datafeed_analog analog;
842 struct sr_datafeed_packet packet;
845 model_state = devc->model_state;
846 samples = model_state->samples_per_frame;
847 ch = devc->current_channel->data;
849 if (data->len < samples * sizeof(uint8_t)) {
850 sr_err("Truncated waveform data packet received.");
854 range = ch_state->waveform_range;
855 offset = ch_state->waveform_offset;
857 /* Convert byte sample to voltage according to
858 * page 269 of the Communication Interface User's Manual.
860 float_data = g_array_new(FALSE, FALSE, sizeof(float));
861 for (i = 0; i < samples; i++) {
862 voltage = (float)g_array_index(data, int8_t, i);
863 voltage = (range * voltage /
864 DLM_DIVISION_FOR_BYTE_FORMAT) + offset;
865 g_array_append_val(float_data, voltage);
868 analog.channels = g_slist_append(NULL, ch);
869 analog.num_samples = float_data->len;
870 analog.data = (float*)float_data->data;
871 analog.mq = SR_MQ_VOLTAGE;
872 analog.unit = SR_UNIT_VOLT;
874 packet.type = SR_DF_ANALOG;
875 packet.payload = &analog;
876 sr_session_send(sdi, &packet);
877 g_slist_free(analog.channels);
879 g_array_free(float_data, TRUE);
880 g_array_remove_range(data, 0, samples * sizeof(uint8_t));
886 * Sends logic sample data off to the session bus.
888 * @param data The raw sample data.
889 * @ch_state Pointer to the state of the channel whose data we're processing.
890 * @sdi The device instance.
892 * @return SR_ERR when data is trucated, SR_OK otherwise.
894 static int dlm_digital_samples_send(GArray *data,
895 struct sr_dev_inst *sdi)
897 struct dev_context *devc;
898 struct scope_state *model_state;
900 struct sr_datafeed_logic logic;
901 struct sr_datafeed_packet packet;
904 model_state = devc->model_state;
905 samples = model_state->samples_per_frame;
907 if (data->len < samples * sizeof(uint8_t)) {
908 sr_err("Truncated waveform data packet received.");
912 logic.length = samples;
914 logic.data = data->data;
915 packet.type = SR_DF_LOGIC;
916 packet.payload = &logic;
917 sr_session_send(sdi, &packet);
919 g_array_remove_range(data, 0, samples * sizeof(uint8_t));
925 * Attempts to query sample data from the oscilloscope in order to send it
926 * to the session bus for further processing.
928 * @param fd The file descriptor used as the event source.
929 * @param revents The received events.
930 * @param cb_data Callback data, in this case our device instance.
932 * @return TRUE in case of success or a recoverable error,
933 * FALSE when a fatal error was encountered.
935 SR_PRIV int dlm_data_receive(int fd, int revents, void *cb_data)
937 struct sr_dev_inst *sdi;
938 struct scope_state *model_state;
939 struct dev_context *devc;
940 struct sr_channel *ch;
941 struct sr_datafeed_packet packet;
942 int chunk_len, num_bytes;
943 static GArray *data = NULL;
948 if (!(sdi = cb_data))
951 if (!(devc = sdi->priv))
954 if (!(model_state = (struct scope_state*)devc->model_state))
957 /* Are we waiting for a response from the device? */
958 if (!devc->data_pending)
961 /* Check if a new query response is coming our way. */
963 if (sr_scpi_read_begin(sdi->conn) == SR_OK)
964 /* The 16 here accounts for the header and EOL. */
965 data = g_array_sized_new(FALSE, FALSE, sizeof(uint8_t),
966 16 + model_state->samples_per_frame);
971 /* Store incoming data. */
972 chunk_len = sr_scpi_read_data(sdi->conn, devc->receive_buffer,
973 RECEIVE_BUFFER_SIZE);
975 sr_err("Error while reading data: %d", chunk_len);
978 g_array_append_vals(data, devc->receive_buffer, chunk_len);
980 /* Read the entire query response before processing. */
981 if (!sr_scpi_read_complete(sdi->conn))
984 /* We finished reading and are no longer waiting for data. */
985 devc->data_pending = FALSE;
987 /* Signal the beginning of a new frame if this is the first channel. */
988 if (devc->current_channel == devc->enabled_channels) {
989 packet.type = SR_DF_FRAME_BEGIN;
990 sr_session_send(sdi, &packet);
993 if (dlm_block_data_header_process(data, &num_bytes) != SR_OK) {
994 sr_err("Encountered malformed block data header.");
998 if (num_bytes == 0) {
999 sr_warn("Zero-length waveform data packet received. " \
1000 "Live mode not supported yet, stopping " \
1001 "acquisition and retrying.");
1002 /* Don't care about return value here. */
1003 dlm_acquisition_stop(sdi->conn);
1004 g_array_free(data, TRUE);
1005 dlm_channel_data_request(sdi);
1009 ch = devc->current_channel->data;
1011 case SR_CHANNEL_ANALOG:
1012 if (dlm_analog_samples_send(data,
1013 &model_state->analog_states[ch->index],
1017 case SR_CHANNEL_LOGIC:
1018 if (dlm_digital_samples_send(data, sdi) != SR_OK)
1022 sr_err("Invalid channel type encountered.");
1026 g_array_free(data, TRUE);
1029 /* Signal the end of this frame if this was the last enabled channel
1030 * and set the next enabled channel. Then, request its data.
1032 if (!devc->current_channel->next) {
1033 packet.type = SR_DF_FRAME_END;
1034 sr_session_send(sdi, &packet);
1035 devc->current_channel = devc->enabled_channels;
1037 /* As of now we only support importing the current acquisition
1038 * data so we're going to stop at this point.
1040 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1043 devc->current_channel = devc->current_channel->next;
1045 if (dlm_channel_data_request(sdi) != SR_OK) {
1046 sr_err("Failed to request acquisition data.");
1054 g_array_free(data, TRUE);