src/hardware/rigol-ds/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  * Copyright (C) 2013 Mathias Grimmberger <mgri@zaphod.sax.de>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <config.h>
  23 #include <fcntl.h>
  24 #include <unistd.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <strings.h>
  28 #include <math.h>
  29 #include <glib.h>
  30 #include <libsigrok/libsigrok.h>
  31 #include "libsigrok-internal.h"
  32 #include "scpi.h"
  33 #include "protocol.h"
  34
  35 static const uint32_t scanopts[] = {
  36         SR_CONF_CONN,
  37         SR_CONF_SERIALCOMM,
  38 };
  39
  40 static const uint32_t drvopts[] = {
  41         SR_CONF_OSCILLOSCOPE,
  42 };
  43
  44 static const uint32_t devopts[] = {
  45         SR_CONF_LIMIT_FRAMES | SR_CONF_SET,
  46         SR_CONF_SAMPLERATE | SR_CONF_GET,
  47         SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  48         SR_CONF_NUM_HDIV | SR_CONF_GET,
  49         SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_SET,
  50         SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  51         SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  52         SR_CONF_TRIGGER_LEVEL | SR_CONF_GET | SR_CONF_SET,
  53         SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  54 };
  55
  56 static const uint32_t devopts_cg_analog[] = {
  57         SR_CONF_NUM_VDIV | SR_CONF_GET,
  58         SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  59         SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  60         SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  61 };
  62
  63 static const uint64_t timebases[][2] = {
  64         /* nanoseconds */
  65         { 1, 1000000000 },
  66         { 2, 1000000000 },
  67         { 5, 1000000000 },
  68         { 10, 1000000000 },
  69         { 20, 1000000000 },
  70         { 50, 1000000000 },
  71         { 100, 1000000000 },
  72         { 500, 1000000000 },
  73         /* microseconds */
  74         { 1, 1000000 },
  75         { 2, 1000000 },
  76         { 5, 1000000 },
  77         { 10, 1000000 },
  78         { 20, 1000000 },
  79         { 50, 1000000 },
  80         { 100, 1000000 },
  81         { 200, 1000000 },
  82         { 500, 1000000 },
  83         /* milliseconds */
  84         { 1, 1000 },
  85         { 2, 1000 },
  86         { 5, 1000 },
  87         { 10, 1000 },
  88         { 20, 1000 },
  89         { 50, 1000 },
  90         { 100, 1000 },
  91         { 200, 1000 },
  92         { 500, 1000 },
  93         /* seconds */
  94         { 1, 1 },
  95         { 2, 1 },
  96         { 5, 1 },
  97         { 10, 1 },
  98         { 20, 1 },
  99         { 50, 1 },
 100         { 100, 1 },
 101         { 200, 1 },
 102         { 500, 1 },
 103         { 1000, 1 },
 104 };
 105
 106 static const uint64_t vdivs[][2] = {
 107         /* microvolts */
 108         { 500, 1000000 },
 109         /* millivolts */
 110         { 1, 1000 },
 111         { 2, 1000 },
 112         { 5, 1000 },
 113         { 10, 1000 },
 114         { 20, 1000 },
 115         { 50, 1000 },
 116         { 100, 1000 },
 117         { 200, 1000 },
 118         { 500, 1000 },
 119         /* volts */
 120         { 1, 1 },
 121         { 2, 1 },
 122         { 5, 1 },
 123         { 10, 1 },
 124         { 20, 1 },
 125         { 50, 1 },
 126         { 100, 1 },
 127 };
 128
 129 static const char *trigger_sources[] = {
 130         "CH1", "CH2", "CH3", "CH4",
 131         "EXT", "AC Line",
 132         "D0", "D1", "D2", "D3", "D4", "D5", "D6", "D7",
 133         "D8", "D9", "D10", "D11", "D12", "D13", "D14", "D15",
 134 };
 135
 136 static const char *trigger_slopes[] = {
 137         "r", "f",
 138 };
 139
 140 static const char *coupling[] = {
 141         "AC", "DC", "GND",
 142 };
 143
 144 static const uint64_t probe_factor[] = {
 145         1, 2, 5, 10, 20, 50, 100, 200, 500, 1000,
 146 };
 147
 148 /* Do not change the order of entries */
 149 static const char *data_sources[] = {
 150         "Live",
 151         "Memory",
 152         "Segmented",
 153 };
 154
 155 enum vendor {
 156         RIGOL,
 157         AGILENT,
 158 };
 159
 160 enum series {
 161         VS5000,
 162         DS1000,
 163         DS2000,
 164         DS2000A,
 165         DSO1000,
 166         DS1000Z,
 167 };
 168
 169 /* short name, full name */
 170 static const struct rigol_ds_vendor supported_vendors[] = {
 171         [RIGOL] = {"Rigol", "Rigol Technologies"},
 172         [AGILENT] = {"Agilent", "Agilent Technologies"},
 173 };
 174
 175 #define VENDOR(x) &supported_vendors[x]
 176 /* vendor, series/name, protocol, data format, max timebase, min vdiv,
 177  * number of horizontal divs, live waveform samples, memory buffer samples */
 178 static const struct rigol_ds_series supported_series[] = {
 179         [VS5000] = {VENDOR(RIGOL), "VS5000", PROTOCOL_V1, FORMAT_RAW,
 180                 {50, 1}, {2, 1000}, 14, 2048, 0},
 181         [DS1000] = {VENDOR(RIGOL), "DS1000", PROTOCOL_V2, FORMAT_IEEE488_2,
 182                 {50, 1}, {2, 1000}, 12, 600, 1048576},
 183         [DS2000] = {VENDOR(RIGOL), "DS2000", PROTOCOL_V3, FORMAT_IEEE488_2,
 184                 {500, 1}, {500, 1000000}, 14, 1400, 14000},
 185         [DS2000A] = {VENDOR(RIGOL), "DS2000A", PROTOCOL_V3, FORMAT_IEEE488_2,
 186                 {1000, 1}, {500, 1000000}, 14, 1400, 14000},
 187         [DSO1000] = {VENDOR(AGILENT), "DSO1000", PROTOCOL_V3, FORMAT_IEEE488_2,
 188                 {50, 1}, {2, 1000}, 12, 600, 20480},
 189         [DS1000Z] = {VENDOR(RIGOL), "DS1000Z", PROTOCOL_V4, FORMAT_IEEE488_2,
 190                 {50, 1}, {1, 1000}, 12, 1200, 12000000},
 191 };
 192
 193 #define SERIES(x) &supported_series[x]
 194 /* series, model, min timebase, analog channels, digital */
 195 static const struct rigol_ds_model supported_models[] = {
 196         {SERIES(VS5000), "VS5022", {20, 1000000000}, 2, false},
 197         {SERIES(VS5000), "VS5042", {10, 1000000000}, 2, false},
 198         {SERIES(VS5000), "VS5062", {5, 1000000000}, 2, false},
 199         {SERIES(VS5000), "VS5102", {2, 1000000000}, 2, false},
 200         {SERIES(VS5000), "VS5202", {2, 1000000000}, 2, false},
 201         {SERIES(VS5000), "VS5022D", {20, 1000000000}, 2, true},
 202         {SERIES(VS5000), "VS5042D", {10, 1000000000}, 2, true},
 203         {SERIES(VS5000), "VS5062D", {5, 1000000000}, 2, true},
 204         {SERIES(VS5000), "VS5102D", {2, 1000000000}, 2, true},
 205         {SERIES(VS5000), "VS5202D", {2, 1000000000}, 2, true},
 206         {SERIES(DS1000), "DS1052E", {5, 1000000000}, 2, false},
 207         {SERIES(DS1000), "DS1102E", {2, 1000000000}, 2, false},
 208         {SERIES(DS1000), "DS1152E", {2, 1000000000}, 2, false},
 209         {SERIES(DS1000), "DS1052D", {5, 1000000000}, 2, true},
 210         {SERIES(DS1000), "DS1102D", {2, 1000000000}, 2, true},
 211         {SERIES(DS1000), "DS1152D", {2, 1000000000}, 2, true},
 212         {SERIES(DS2000), "DS2072", {5, 1000000000}, 2, false},
 213         {SERIES(DS2000), "DS2102", {5, 1000000000}, 2, false},
 214         {SERIES(DS2000), "DS2202", {2, 1000000000}, 2, false},
 215         {SERIES(DS2000), "DS2302", {1, 1000000000}, 2, false},
 216         {SERIES(DS2000A), "DS2072A", {5, 1000000000}, 2, false},
 217         {SERIES(DS2000A), "DS2102A", {5, 1000000000}, 2, false},
 218         {SERIES(DS2000A), "DS2202A", {2, 1000000000}, 2, false},
 219         {SERIES(DS2000A), "DS2302A", {1, 1000000000}, 2, false},
 220         {SERIES(DS2000A), "MSO2072A", {5, 1000000000}, 2, true},
 221         {SERIES(DS2000A), "MSO2102A", {5, 1000000000}, 2, true},
 222         {SERIES(DS2000A), "MSO2202A", {2, 1000000000}, 2, true},
 223         {SERIES(DS2000A), "MSO2302A", {1, 1000000000}, 2, true},
 224         {SERIES(DSO1000), "DSO1002A", {5, 1000000000}, 2, false},
 225         {SERIES(DSO1000), "DSO1004A", {5, 1000000000}, 4, false},
 226         {SERIES(DSO1000), "DSO1012A", {2, 1000000000}, 2, false},
 227         {SERIES(DSO1000), "DSO1014A", {2, 1000000000}, 4, false},
 228         {SERIES(DSO1000), "DSO1022A", {2, 1000000000}, 2, false},
 229         {SERIES(DSO1000), "DSO1024A", {2, 1000000000}, 4, false},
 230         {SERIES(DS1000Z), "DS1054Z", {5, 1000000000}, 4, false},
 231         {SERIES(DS1000Z), "DS1074Z", {5, 1000000000}, 4, false},
 232         {SERIES(DS1000Z), "DS1104Z", {5, 1000000000}, 4, false},
 233         {SERIES(DS1000Z), "DS1074Z-S", {5, 1000000000}, 4, false},
 234         {SERIES(DS1000Z), "DS1104Z-S", {5, 1000000000}, 4, false},
 235         {SERIES(DS1000Z), "DS1074Z Plus", {5, 1000000000}, 4, false},
 236         {SERIES(DS1000Z), "DS1104Z Plus", {5, 1000000000}, 4, false},
 237         {SERIES(DS1000Z), "MSO1074Z", {5, 1000000000}, 4, true},
 238         {SERIES(DS1000Z), "MSO1104Z", {5, 1000000000}, 4, true},
 239         {SERIES(DS1000Z), "MSO1074Z-S", {5, 1000000000}, 4, true},
 240         {SERIES(DS1000Z), "MSO1104Z-S", {5, 1000000000}, 4, true},
 241 };
 242
 243 static struct sr_dev_driver rigol_ds_driver_info;
 244
 245 static void clear_helper(struct dev_context *devc)
 246 {
 247         unsigned int i;
 248
 249         g_free(devc->data);
 250         g_free(devc->buffer);
 251         for (i = 0; i < ARRAY_SIZE(devc->coupling); i++)
 252                 g_free(devc->coupling[i]);
 253         g_free(devc->trigger_source);
 254         g_free(devc->trigger_slope);
 255         g_free(devc->analog_groups);
 256 }
 257
 258 static int dev_clear(const struct sr_dev_driver *di)
 259 {
 260         return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
 261 }
 262
 263 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 264 {
 265         struct dev_context *devc;
 266         struct sr_dev_inst *sdi;
 267         struct sr_scpi_hw_info *hw_info;
 268         struct sr_channel *ch;
 269         long n[3];
 270         unsigned int i;
 271         const struct rigol_ds_model *model = NULL;
 272         gchar *channel_name, **version;
 273
 274         if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
 275                 sr_info("Couldn't get IDN response, retrying.");
 276                 sr_scpi_close(scpi);
 277                 sr_scpi_open(scpi);
 278                 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
 279                         sr_info("Couldn't get IDN response.");
 280                         return NULL;
 281                 }
 282         }
 283
 284         for (i = 0; i < ARRAY_SIZE(supported_models); i++) {
 285                 if (!g_ascii_strcasecmp(hw_info->manufacturer,
 286                                         supported_models[i].series->vendor->full_name) &&
 287                                 !strcmp(hw_info->model, supported_models[i].name)) {
 288                         model = &supported_models[i];
 289                         break;
 290                 }
 291         }
 292
 293         if (!model) {
 294                 sr_scpi_hw_info_free(hw_info);
 295                 return NULL;
 296         }
 297
 298         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 299         sdi->vendor = g_strdup(model->series->vendor->name);
 300         sdi->model = g_strdup(model->name);
 301         sdi->version = g_strdup(hw_info->firmware_version);
 302         sdi->conn = scpi;
 303         sdi->driver = &rigol_ds_driver_info;
 304         sdi->inst_type = SR_INST_SCPI;
 305         sdi->serial_num = g_strdup(hw_info->serial_number);
 306         devc = g_malloc0(sizeof(struct dev_context));
 307         devc->limit_frames = 0;
 308         devc->model = model;
 309         devc->format = model->series->format;
 310
 311         /* DS1000 models with firmware before 0.2.4 used the old data format. */
 312         if (model->series == SERIES(DS1000)) {
 313                 version = g_strsplit(hw_info->firmware_version, ".", 0);
 314                 do {
 315                         if (!version[0] || !version[1] || !version[2])
 316                                 break;
 317                         if (version[0][0] == 0 || version[1][0] == 0 || version[2][0] == 0)
 318                                 break;
 319                         for (i = 0; i < 3; i++) {
 320                                 if (sr_atol(version[i], &n[i]) != SR_OK)
 321                                         break;
 322                         }
 323                         if (i != 3)
 324                                 break;
 325                         scpi->firmware_version = n[0] * 100 + n[1] * 10 + n[2];
 326                         if (scpi->firmware_version < 24) {
 327                                 sr_dbg("Found DS1000 firmware < 0.2.4, using raw data format.");
 328                                 devc->format = FORMAT_RAW;
 329                         }
 330                         break;
 331                 } while (0);
 332                 g_strfreev(version);
 333         }
 334
 335         sr_scpi_hw_info_free(hw_info);
 336
 337         devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
 338                                         model->analog_channels);
 339
 340         for (i = 0; i < model->analog_channels; i++) {
 341                 channel_name = g_strdup_printf("CH%d", i + 1);
 342                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE, channel_name);
 343
 344                 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
 345
 346                 devc->analog_groups[i]->name = channel_name;
 347                 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
 348                 sdi->channel_groups = g_slist_append(sdi->channel_groups,
 349                                 devc->analog_groups[i]);
 350         }
 351
 352         if (devc->model->has_digital) {
 353                 devc->digital_group = g_malloc0(sizeof(struct sr_channel_group));
 354
 355                 for (i = 0; i < ARRAY_SIZE(devc->digital_channels); i++) {
 356                         channel_name = g_strdup_printf("D%d", i);
 357                         ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
 358                         g_free(channel_name);
 359                         devc->digital_group->channels = g_slist_append(
 360                                         devc->digital_group->channels, ch);
 361                 }
 362                 devc->digital_group->name = g_strdup("LA");
 363                 sdi->channel_groups = g_slist_append(sdi->channel_groups,
 364                                 devc->digital_group);
 365         }
 366
 367         for (i = 0; i < ARRAY_SIZE(timebases); i++) {
 368                 if (!memcmp(&devc->model->min_timebase, &timebases[i], sizeof(uint64_t[2])))
 369                         devc->timebases = &timebases[i];
 370                 if (!memcmp(&devc->model->series->max_timebase, &timebases[i], sizeof(uint64_t[2])))
 371                         devc->num_timebases = &timebases[i] - devc->timebases + 1;
 372         }
 373
 374         for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
 375                 if (!memcmp(&devc->model->series->min_vdiv,
 376                                         &vdivs[i], sizeof(uint64_t[2]))) {
 377                         devc->vdivs = &vdivs[i];
 378                         devc->num_vdivs = ARRAY_SIZE(vdivs) - i;
 379                 }
 380         }
 381
 382         devc->buffer = g_malloc(ACQ_BUFFER_SIZE);
 383         devc->data = g_malloc(ACQ_BUFFER_SIZE * sizeof(float));
 384
 385         devc->data_source = DATA_SOURCE_LIVE;
 386
 387         sdi->priv = devc;
 388
 389         return sdi;
 390 }
 391
 392 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 393 {
 394         return sr_scpi_scan(di->context, options, probe_device);
 395 }
 396
 397 static int dev_open(struct sr_dev_inst *sdi)
 398 {
 399         int ret;
 400         struct sr_scpi_dev_inst *scpi = sdi->conn;
 401
 402         if ((ret = sr_scpi_open(scpi)) < 0) {
 403                 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
 404                 return SR_ERR;
 405         }
 406
 407         if ((ret = rigol_ds_get_dev_cfg(sdi)) < 0) {
 408                 sr_err("Failed to get device config: %s.", sr_strerror(ret));
 409                 return SR_ERR;
 410         }
 411
 412         return SR_OK;
 413 }
 414
 415 static int dev_close(struct sr_dev_inst *sdi)
 416 {
 417         struct sr_scpi_dev_inst *scpi;
 418         struct dev_context *devc;
 419
 420         scpi = sdi->conn;
 421         devc = sdi->priv;
 422
 423         if (!scpi)
 424                 return SR_ERR_BUG;
 425
 426         if (devc->model->series->protocol == PROTOCOL_V2)
 427                 rigol_ds_config_set(sdi, ":KEY:LOCK DISABLE");
 428
 429         return sr_scpi_close(scpi);
 430 }
 431
 432 static int analog_frame_size(const struct sr_dev_inst *sdi)
 433 {
 434         struct dev_context *devc = sdi->priv;
 435         struct sr_channel *ch;
 436         int analog_channels = 0;
 437         GSList *l;
 438
 439         for (l = sdi->channels; l; l = l->next) {
 440                 ch = l->data;
 441                 if (ch->type == SR_CHANNEL_ANALOG && ch->enabled)
 442                         analog_channels++;
 443         }
 444
 445         if (analog_channels == 0)
 446                 return 0;
 447
 448         switch (devc->data_source) {
 449         case DATA_SOURCE_LIVE:
 450                 return devc->model->series->live_samples;
 451         case DATA_SOURCE_MEMORY:
 452                 return devc->model->series->buffer_samples / analog_channels;
 453         default:
 454                 return 0;
 455         }
 456 }
 457
 458 static int digital_frame_size(const struct sr_dev_inst *sdi)
 459 {
 460         struct dev_context *devc = sdi->priv;
 461
 462         switch (devc->data_source) {
 463         case DATA_SOURCE_LIVE:
 464                 return devc->model->series->live_samples * 2;
 465         case DATA_SOURCE_MEMORY:
 466                 return devc->model->series->buffer_samples * 2;
 467         default:
 468                 return 0;
 469         }
 470 }
 471
 472 static int config_get(uint32_t key, GVariant **data,
 473         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 474 {
 475         struct dev_context *devc;
 476         struct sr_channel *ch;
 477         const char *tmp_str;
 478         uint64_t samplerate;
 479         int analog_channel = -1;
 480         float smallest_diff = INFINITY;
 481         int idx = -1;
 482         unsigned i;
 483
 484         if (!sdi)
 485                 return SR_ERR_ARG;
 486
 487         devc = sdi->priv;
 488
 489         /* If a channel group is specified, it must be a valid one. */
 490         if (cg && !g_slist_find(sdi->channel_groups, cg)) {
 491                 sr_err("Invalid channel group specified.");
 492                 return SR_ERR;
 493         }
 494
 495         if (cg) {
 496                 ch = g_slist_nth_data(cg->channels, 0);
 497                 if (!ch)
 498                         return SR_ERR;
 499                 if (ch->type == SR_CHANNEL_ANALOG) {
 500                         if (ch->name[2] < '1' || ch->name[2] > '4')
 501                                 return SR_ERR;
 502                         analog_channel = ch->name[2] - '1';
 503                 }
 504         }
 505
 506         switch (key) {
 507         case SR_CONF_NUM_HDIV:
 508                 *data = g_variant_new_int32(devc->model->series->num_horizontal_divs);
 509                 break;
 510         case SR_CONF_NUM_VDIV:
 511                 *data = g_variant_new_int32(devc->num_vdivs);
 512                 break;
 513         case SR_CONF_DATA_SOURCE:
 514                 if (devc->data_source == DATA_SOURCE_LIVE)
 515                         *data = g_variant_new_string("Live");
 516                 else if (devc->data_source == DATA_SOURCE_MEMORY)
 517                         *data = g_variant_new_string("Memory");
 518                 else
 519                         *data = g_variant_new_string("Segmented");
 520                 break;
 521         case SR_CONF_SAMPLERATE:
 522                 if (devc->data_source == DATA_SOURCE_LIVE) {
 523                         samplerate = analog_frame_size(sdi) /
 524                                 (devc->timebase * devc->model->series->num_horizontal_divs);
 525                         *data = g_variant_new_uint64(samplerate);
 526                 } else {
 527                         sr_dbg("Unknown data source: %d.", devc->data_source);
 528                         return SR_ERR_NA;
 529                 }
 530                 break;
 531         case SR_CONF_TRIGGER_SOURCE:
 532                 if (!strcmp(devc->trigger_source, "ACL"))
 533                         tmp_str = "AC Line";
 534                 else if (!strcmp(devc->trigger_source, "CHAN1"))
 535                         tmp_str = "CH1";
 536                 else if (!strcmp(devc->trigger_source, "CHAN2"))
 537                         tmp_str = "CH2";
 538                 else if (!strcmp(devc->trigger_source, "CHAN3"))
 539                         tmp_str = "CH3";
 540                 else if (!strcmp(devc->trigger_source, "CHAN4"))
 541                         tmp_str = "CH4";
 542                 else
 543                         tmp_str = devc->trigger_source;
 544                 *data = g_variant_new_string(tmp_str);
 545                 break;
 546         case SR_CONF_TRIGGER_SLOPE:
 547                 if (!strncmp(devc->trigger_slope, "POS", 3)) {
 548                         tmp_str = "r";
 549                 } else if (!strncmp(devc->trigger_slope, "NEG", 3)) {
 550                         tmp_str = "f";
 551                 } else {
 552                         sr_dbg("Unknown trigger slope: '%s'.", devc->trigger_slope);
 553                         return SR_ERR_NA;
 554                 }
 555                 *data = g_variant_new_string(tmp_str);
 556                 break;
 557         case SR_CONF_TRIGGER_LEVEL:
 558                 *data = g_variant_new_double(devc->trigger_level);
 559                 break;
 560         case SR_CONF_TIMEBASE:
 561                 for (i = 0; i < devc->num_timebases; i++) {
 562                         float tb = (float)devc->timebases[i][0] / devc->timebases[i][1];
 563                         float diff = fabs(devc->timebase - tb);
 564                         if (diff < smallest_diff) {
 565                                 smallest_diff = diff;
 566                                 idx = i;
 567                         }
 568                 }
 569                 if (idx < 0) {
 570                         sr_dbg("Negative timebase index: %d.", idx);
 571                         return SR_ERR_NA;
 572                 }
 573                 *data = g_variant_new("(tt)", devc->timebases[idx][0],
 574                                               devc->timebases[idx][1]);
 575                 break;
 576         case SR_CONF_VDIV:
 577                 if (analog_channel < 0) {
 578                         sr_dbg("Negative analog channel: %d.", analog_channel);
 579                         return SR_ERR_NA;
 580                 }
 581                 for (i = 0; i < ARRAY_SIZE(vdivs); i++) {
 582                         float vdiv = (float)vdivs[i][0] / vdivs[i][1];
 583                         float diff = fabs(devc->vdiv[analog_channel] - vdiv);
 584                         if (diff < smallest_diff) {
 585                                 smallest_diff = diff;
 586                                 idx = i;
 587                         }
 588                 }
 589                 if (idx < 0) {
 590                         sr_dbg("Negative vdiv index: %d.", idx);
 591                         return SR_ERR_NA;
 592                 }
 593                 *data = g_variant_new("(tt)", vdivs[idx][0], vdivs[idx][1]);
 594                 break;
 595         case SR_CONF_COUPLING:
 596                 if (analog_channel < 0) {
 597                         sr_dbg("Negative analog channel: %d.", analog_channel);
 598                         return SR_ERR_NA;
 599                 }
 600                 *data = g_variant_new_string(devc->coupling[analog_channel]);
 601                 break;
 602         case SR_CONF_PROBE_FACTOR:
 603                 if (analog_channel < 0) {
 604                         sr_dbg("Negative analog channel: %d.", analog_channel);
 605                         return SR_ERR_NA;
 606                 }
 607                 *data = g_variant_new_uint64(devc->attenuation[analog_channel]);
 608                 break;
 609         default:
 610                 return SR_ERR_NA;
 611         }
 612
 613         return SR_OK;
 614 }
 615
 616 static int config_set(uint32_t key, GVariant *data,
 617         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 618 {
 619         struct dev_context *devc;
 620         uint64_t p;
 621         double t_dbl;
 622         unsigned int i;
 623         int ret, idx;
 624         const char *tmp_str;
 625         char buffer[16];
 626
 627         devc = sdi->priv;
 628
 629         /* If a channel group is specified, it must be a valid one. */
 630         if (cg && !g_slist_find(sdi->channel_groups, cg)) {
 631                 sr_err("Invalid channel group specified.");
 632                 return SR_ERR;
 633         }
 634
 635         switch (key) {
 636         case SR_CONF_LIMIT_FRAMES:
 637                 devc->limit_frames = g_variant_get_uint64(data);
 638                 break;
 639         case SR_CONF_TRIGGER_SLOPE:
 640                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_slopes))) < 0)
 641                         return SR_ERR_ARG;
 642                 g_free(devc->trigger_slope);
 643                 devc->trigger_slope = g_strdup((trigger_slopes[idx][0] == 'r') ? "POS" : "NEG");
 644                 return rigol_ds_config_set(sdi, ":TRIG:EDGE:SLOP %s", devc->trigger_slope);
 645         case SR_CONF_HORIZ_TRIGGERPOS:
 646                 t_dbl = g_variant_get_double(data);
 647                 if (t_dbl < 0.0 || t_dbl > 1.0) {
 648                         sr_err("Invalid horiz. trigger position: %g.", t_dbl);
 649                         return SR_ERR;
 650                 }
 651                 devc->horiz_triggerpos = t_dbl;
 652                 /* We have the trigger offset as a percentage of the frame, but
 653                  * need to express this in seconds. */
 654                 t_dbl = -(devc->horiz_triggerpos - 0.5) * devc->timebase * devc->num_timebases;
 655                 g_ascii_formatd(buffer, sizeof(buffer), "%.6f", t_dbl);
 656                 return rigol_ds_config_set(sdi, ":TIM:OFFS %s", buffer);
 657         case SR_CONF_TRIGGER_LEVEL:
 658                 t_dbl = g_variant_get_double(data);
 659                 g_ascii_formatd(buffer, sizeof(buffer), "%.3f", t_dbl);
 660                 ret = rigol_ds_config_set(sdi, ":TRIG:EDGE:LEV %s", buffer);
 661                 if (ret == SR_OK)
 662                         devc->trigger_level = t_dbl;
 663                 return ret;
 664         case SR_CONF_TIMEBASE:
 665                 if ((idx = std_u64_tuple_idx(data, devc->timebases, devc->num_timebases)) < 0)
 666                         return SR_ERR_ARG;
 667                 devc->timebase = (float)devc->timebases[idx][0] / devc->timebases[idx][1];
 668                 g_ascii_formatd(buffer, sizeof(buffer), "%.9f",
 669                                 devc->timebase);
 670                 return rigol_ds_config_set(sdi, ":TIM:SCAL %s", buffer);
 671         case SR_CONF_TRIGGER_SOURCE:
 672                 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_sources))) < 0)
 673                         return SR_ERR_ARG;
 674                 g_free(devc->trigger_source);
 675                 devc->trigger_source = g_strdup(trigger_sources[idx]);
 676                 if (!strcmp(devc->trigger_source, "AC Line"))
 677                         tmp_str = "ACL";
 678                 else if (!strcmp(devc->trigger_source, "CH1"))
 679                         tmp_str = "CHAN1";
 680                 else if (!strcmp(devc->trigger_source, "CH2"))
 681                         tmp_str = "CHAN2";
 682                 else if (!strcmp(devc->trigger_source, "CH3"))
 683                         tmp_str = "CHAN3";
 684                 else if (!strcmp(devc->trigger_source, "CH4"))
 685                         tmp_str = "CHAN4";
 686                 else
 687                         tmp_str = (char *)devc->trigger_source;
 688                 return rigol_ds_config_set(sdi, ":TRIG:EDGE:SOUR %s", tmp_str);
 689         case SR_CONF_VDIV:
 690                 if (!cg)
 691                         return SR_ERR_CHANNEL_GROUP;
 692                 for (i = 0; i < devc->model->analog_channels; i++) {
 693                         if (cg != devc->analog_groups[i])
 694                                 continue;
 695                         if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(vdivs))) < 0)
 696                                 return SR_ERR_ARG;
 697                         devc->vdiv[i] = (float)vdivs[idx][0] / vdivs[idx][1];
 698                         g_ascii_formatd(buffer, sizeof(buffer), "%.3f",
 699                                         devc->vdiv[i]);
 700                         return rigol_ds_config_set(sdi, ":CHAN%d:SCAL %s", i + 1,
 701                                         buffer);
 702                 }
 703                 sr_dbg("Didn't set vdiv, unknown channel(group).");
 704                 return SR_ERR_NA;
 705         case SR_CONF_COUPLING:
 706                 if (!cg)
 707                         return SR_ERR_CHANNEL_GROUP;
 708                 for (i = 0; i < devc->model->analog_channels; i++) {
 709                         if (cg != devc->analog_groups[i])
 710                                 continue;
 711                         if ((idx = std_str_idx(data, ARRAY_AND_SIZE(coupling))) < 0)
 712                                 return SR_ERR_ARG;
 713                         g_free(devc->coupling[i]);
 714                         devc->coupling[i] = g_strdup(coupling[idx]);
 715                         return rigol_ds_config_set(sdi, ":CHAN%d:COUP %s", i + 1,
 716                                         devc->coupling[i]);
 717                 }
 718                 sr_dbg("Didn't set coupling, unknown channel(group).");
 719                 return SR_ERR_NA;
 720         case SR_CONF_PROBE_FACTOR:
 721                 if (!cg)
 722                         return SR_ERR_CHANNEL_GROUP;
 723                 p = g_variant_get_uint64(data);
 724                 for (i = 0; i < devc->model->analog_channels; i++) {
 725                         if (cg != devc->analog_groups[i])
 726                                 continue;
 727                         if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(probe_factor))) < 0)
 728                                 return SR_ERR_ARG;
 729                         devc->attenuation[i] = probe_factor[idx];
 730                         ret = rigol_ds_config_set(sdi, ":CHAN%d:PROB %"PRIu64,
 731                                                   i + 1, p);
 732                         if (ret == SR_OK)
 733                                 rigol_ds_get_dev_cfg_vertical(sdi);
 734                         return ret;
 735                 }
 736                 sr_dbg("Didn't set probe factor, unknown channel(group).");
 737                 return SR_ERR_NA;
 738         case SR_CONF_DATA_SOURCE:
 739                 tmp_str = g_variant_get_string(data, NULL);
 740                 if (!strcmp(tmp_str, "Live"))
 741                         devc->data_source = DATA_SOURCE_LIVE;
 742                 else if (devc->model->series->protocol >= PROTOCOL_V2
 743                         && !strcmp(tmp_str, "Memory"))
 744                         devc->data_source = DATA_SOURCE_MEMORY;
 745                 else if (devc->model->series->protocol >= PROTOCOL_V3
 746                          && !strcmp(tmp_str, "Segmented"))
 747                         devc->data_source = DATA_SOURCE_SEGMENTED;
 748                 else {
 749                         sr_err("Unknown data source: '%s'.", tmp_str);
 750                         return SR_ERR;
 751                 }
 752                 break;
 753         default:
 754                 return SR_ERR_NA;
 755         }
 756
 757         return SR_OK;
 758 }
 759
 760 static int config_list(uint32_t key, GVariant **data,
 761         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 762 {
 763         unsigned int i;
 764         struct dev_context *devc;
 765
 766         devc = (sdi) ? sdi->priv : NULL;
 767
 768         switch (key) {
 769         case SR_CONF_SCAN_OPTIONS:
 770         case SR_CONF_DEVICE_OPTIONS:
 771                 if (!cg)
 772                         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 773                 if (cg == devc->digital_group) {
 774                         *data = std_gvar_array_u32(NULL, 0);
 775                         return SR_OK;
 776                 } else {
 777                         for (i = 0; i < devc->model->analog_channels; i++) {
 778                                 if (cg == devc->analog_groups[i]) {
 779                                         *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
 780                                         return SR_OK;
 781                                 }
 782                         }
 783                         return SR_ERR_NA;
 784                 }
 785                 break;
 786         case SR_CONF_COUPLING:
 787                 if (!cg)
 788                         return SR_ERR_CHANNEL_GROUP;
 789                 *data = g_variant_new_strv(ARRAY_AND_SIZE(coupling));
 790                 break;
 791         case SR_CONF_PROBE_FACTOR:
 792                 if (!cg)
 793                         return SR_ERR_CHANNEL_GROUP;
 794                 *data = std_gvar_array_u64(ARRAY_AND_SIZE(probe_factor));
 795                 break;
 796         case SR_CONF_VDIV:
 797                 if (!devc)
 798                         /* Can't know this until we have the exact model. */
 799                         return SR_ERR_ARG;
 800                 if (!cg)
 801                         return SR_ERR_CHANNEL_GROUP;
 802                 *data = std_gvar_tuple_array(devc->vdivs, devc->num_vdivs);
 803                 break;
 804         case SR_CONF_TIMEBASE:
 805                 if (!devc)
 806                         /* Can't know this until we have the exact model. */
 807                         return SR_ERR_ARG;
 808                 if (devc->num_timebases <= 0)
 809                         return SR_ERR_NA;
 810                 *data = std_gvar_tuple_array(devc->timebases, devc->num_timebases);
 811                 break;
 812         case SR_CONF_TRIGGER_SOURCE:
 813                 if (!devc)
 814                         /* Can't know this until we have the exact model. */
 815                         return SR_ERR_ARG;
 816                 *data = g_variant_new_strv(trigger_sources,
 817                                 devc->model->has_digital ? ARRAY_SIZE(trigger_sources) : 4);
 818                 break;
 819         case SR_CONF_TRIGGER_SLOPE:
 820                 *data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_slopes));
 821                 break;
 822         case SR_CONF_DATA_SOURCE:
 823                 if (!devc)
 824                         /* Can't know this until we have the exact model. */
 825                         return SR_ERR_ARG;
 826                 switch (devc->model->series->protocol) {
 827                 case PROTOCOL_V1:
 828                         *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources) - 2);
 829                         break;
 830                 case PROTOCOL_V2:
 831                         *data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources) - 1);
 832                         break;
 833                 default:
 834                         *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
 835                         break;
 836                 }
 837                 break;
 838         default:
 839                 return SR_ERR_NA;
 840         }
 841
 842         return SR_OK;
 843 }
 844
 845 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 846 {
 847         struct sr_scpi_dev_inst *scpi;
 848         struct dev_context *devc;
 849         struct sr_channel *ch;
 850         struct sr_datafeed_packet packet;
 851         gboolean some_digital;
 852         GSList *l;
 853
 854         scpi = sdi->conn;
 855         devc = sdi->priv;
 856
 857         devc->num_frames = 0;
 858
 859         some_digital = FALSE;
 860         for (l = sdi->channels; l; l = l->next) {
 861                 ch = l->data;
 862                 sr_dbg("handling channel %s", ch->name);
 863                 if (ch->type == SR_CHANNEL_ANALOG) {
 864                         if (ch->enabled)
 865                                 devc->enabled_channels = g_slist_append(
 866                                                 devc->enabled_channels, ch);
 867                         if (ch->enabled != devc->analog_channels[ch->index]) {
 868                                 /* Enabled channel is currently disabled, or vice versa. */
 869                                 if (rigol_ds_config_set(sdi, ":CHAN%d:DISP %s", ch->index + 1,
 870                                                 ch->enabled ? "ON" : "OFF") != SR_OK)
 871                                         return SR_ERR;
 872                                 devc->analog_channels[ch->index] = ch->enabled;
 873                         }
 874                 } else if (ch->type == SR_CHANNEL_LOGIC) {
 875                         /* Only one list entry for older protocols. All channels are
 876                          * retrieved together when this entry is processed. */
 877                         if (ch->enabled && (
 878                                                 devc->model->series->protocol > PROTOCOL_V3 ||
 879                                                 !some_digital))
 880                                 devc->enabled_channels = g_slist_append(
 881                                                 devc->enabled_channels, ch);
 882                         if (ch->enabled) {
 883                                 some_digital = TRUE;
 884                                 /* Turn on LA module if currently off. */
 885                                 if (!devc->la_enabled) {
 886                                         if (rigol_ds_config_set(sdi,
 887                                                         devc->model->series->protocol >= PROTOCOL_V3 ?
 888                                                                 ":LA:STAT ON" : ":LA:DISP ON") != SR_OK)
 889                                                 return SR_ERR;
 890                                         devc->la_enabled = TRUE;
 891                                 }
 892                         }
 893                         if (ch->enabled != devc->digital_channels[ch->index]) {
 894                                 /* Enabled channel is currently disabled, or vice versa. */
 895                                 if (rigol_ds_config_set(sdi,
 896                                                 devc->model->series->protocol >= PROTOCOL_V3 ?
 897                                                         ":LA:DIG%d:DISP %s" : ":DIG%d:TURN %s", ch->index,
 898                                                 ch->enabled ? "ON" : "OFF") != SR_OK)
 899                                         return SR_ERR;
 900                                 devc->digital_channels[ch->index] = ch->enabled;
 901                         }
 902                 }
 903         }
 904
 905         if (!devc->enabled_channels)
 906                 return SR_ERR;
 907
 908         /* Turn off LA module if on and no digital channels selected. */
 909         if (devc->la_enabled && !some_digital)
 910                 if (rigol_ds_config_set(sdi,
 911                                 devc->model->series->protocol >= PROTOCOL_V3 ?
 912                                         ":LA:STAT OFF" : ":LA:DISP OFF") != SR_OK)
 913                         return SR_ERR;
 914
 915         /* Set memory mode. */
 916         if (devc->data_source == DATA_SOURCE_SEGMENTED) {
 917                 sr_err("Data source 'Segmented' not yet supported");
 918                 return SR_ERR;
 919         }
 920
 921         devc->analog_frame_size = analog_frame_size(sdi);
 922         devc->digital_frame_size = digital_frame_size(sdi);
 923
 924         switch (devc->model->series->protocol) {
 925         case PROTOCOL_V2:
 926                 if (rigol_ds_config_set(sdi, ":ACQ:MEMD LONG") != SR_OK)
 927                         return SR_ERR;
 928                 break;
 929         case PROTOCOL_V3:
 930                 /* Apparently for the DS2000 the memory
 931                  * depth can only be set in Running state -
 932                  * this matches the behaviour of the UI. */
 933                 if (rigol_ds_config_set(sdi, ":RUN") != SR_OK)
 934                         return SR_ERR;
 935                 if (rigol_ds_config_set(sdi, ":ACQ:MDEP %d",
 936                                         devc->analog_frame_size) != SR_OK)
 937                         return SR_ERR;
 938                 if (rigol_ds_config_set(sdi, ":STOP") != SR_OK)
 939                         return SR_ERR;
 940                 break;
 941         default:
 942                 break;
 943         }
 944
 945         if (devc->data_source == DATA_SOURCE_LIVE)
 946                 if (rigol_ds_config_set(sdi, ":RUN") != SR_OK)
 947                         return SR_ERR;
 948
 949         sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
 950                         rigol_ds_receive, (void *)sdi);
 951
 952         std_session_send_df_header(sdi);
 953
 954         devc->channel_entry = devc->enabled_channels;
 955
 956         if (rigol_ds_capture_start(sdi) != SR_OK)
 957                 return SR_ERR;
 958
 959         /* Start of first frame. */
 960         packet.type = SR_DF_FRAME_BEGIN;
 961         sr_session_send(sdi, &packet);
 962
 963         return SR_OK;
 964 }
 965
 966 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 967 {
 968         struct dev_context *devc;
 969         struct sr_scpi_dev_inst *scpi;
 970
 971         devc = sdi->priv;
 972
 973         std_session_send_df_end(sdi);
 974
 975         g_slist_free(devc->enabled_channels);
 976         devc->enabled_channels = NULL;
 977         scpi = sdi->conn;
 978         sr_scpi_source_remove(sdi->session, scpi);
 979
 980         return SR_OK;
 981 }
 982
 983 static struct sr_dev_driver rigol_ds_driver_info = {
 984         .name = "rigol-ds",
 985         .longname = "Rigol DS",
 986         .api_version = 1,
 987         .init = std_init,
 988         .cleanup = std_cleanup,
 989         .scan = scan,
 990         .dev_list = std_dev_list,
 991         .dev_clear = dev_clear,
 992         .config_get = config_get,
 993         .config_set = config_set,
 994         .config_list = config_list,
 995         .dev_open = dev_open,
 996         .dev_close = dev_close,
 997         .dev_acquisition_start = dev_acquisition_start,
 998         .dev_acquisition_stop = dev_acquisition_stop,
 999         .context = NULL,
1000 };
1001 SR_REGISTER_DEV_DRIVER(rigol_ds_driver_info);