hardware/rigol-ds1xx2/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include <fcntl.h>
  21 #include <unistd.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27 #include "protocol.h"
  28
  29 static const int hwcaps[] = {
  30         SR_CONF_OSCILLOSCOPE,
  31         SR_CONF_LIMIT_SAMPLES,
  32         SR_CONF_TIMEBASE,
  33         SR_CONF_TRIGGER_SOURCE,
  34         SR_CONF_TRIGGER_SLOPE,
  35         SR_CONF_HORIZ_TRIGGERPOS,
  36         SR_CONF_VDIV,
  37         SR_CONF_COUPLING,
  38         0,
  39 };
  40
  41 static const struct sr_rational timebases[] = {
  42         /* nanoseconds */
  43         { 2, 1000000000 },
  44         { 5, 1000000000 },
  45         { 10, 1000000000 },
  46         { 20, 1000000000 },
  47         { 50, 1000000000 },
  48         { 100, 1000000000 },
  49         { 500, 1000000000 },
  50         /* microseconds */
  51         { 1, 1000000 },
  52         { 2, 1000000 },
  53         { 5, 1000000 },
  54         { 10, 1000000 },
  55         { 20, 1000000 },
  56         { 50, 1000000 },
  57         { 100, 1000000 },
  58         { 200, 1000000 },
  59         { 500, 1000000 },
  60         /* milliseconds */
  61         { 1, 1000 },
  62         { 2, 1000 },
  63         { 5, 1000 },
  64         { 10, 1000 },
  65         { 20, 1000 },
  66         { 50, 1000 },
  67         { 100, 1000 },
  68         { 200, 1000 },
  69         { 500, 1000 },
  70         /* seconds */
  71         { 1, 1 },
  72         { 2, 1 },
  73         { 5, 1 },
  74         { 10, 1 },
  75         { 20, 1 },
  76         { 50, 1 },
  77         { 0, 0},
  78 };
  79
  80 static const struct sr_rational vdivs[] = {
  81         /* millivolts */
  82         { 2, 1000 },
  83         { 5, 1000 },
  84         { 10, 1000 },
  85         { 20, 1000 },
  86         { 50, 1000 },
  87         { 100, 1000 },
  88         { 200, 1000 },
  89         { 500, 1000 },
  90         /* volts */
  91         { 1, 1 },
  92         { 2, 1 },
  93         { 5, 1 },
  94         { 10, 1 },
  95         { 0, 0 },
  96 };
  97
  98 static const char *trigger_sources[] = {
  99         "CH1",
 100         "CH2",
 101         "EXT",
 102         "AC Line",
 103         NULL,
 104 };
 105
 106 static const char *coupling[] = {
 107         "AC",
 108         "DC",
 109         "GND",
 110         NULL,
 111 };
 112
 113 static const char *supported_models[] = {
 114         "DS1052E",
 115         "DS1102E",
 116         "DS1052D",
 117         "DS1102D"
 118 };
 119
 120 SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 121 static struct sr_dev_driver *di = &rigol_ds1xx2_driver_info;
 122
 123 /* Properly close and free all devices. */
 124 static int clear_instances(void)
 125 {
 126         struct sr_dev_inst *sdi;
 127         struct drv_context *drvc;
 128         struct dev_context *devc;
 129         GSList *l;
 130
 131         if (!(drvc = di->priv))
 132                 return SR_OK;
 133
 134         for (l = drvc->instances; l; l = l->next) {
 135                 if (!(sdi = l->data))
 136                         continue;
 137                 if (!(devc = sdi->priv))
 138                         continue;
 139
 140                 g_free(devc->device);
 141                 g_slist_free(devc->enabled_probes);
 142                 close(devc->fd);
 143
 144                 sr_dev_inst_free(sdi);
 145         }
 146
 147         g_slist_free(drvc->instances);
 148         drvc->instances = NULL;
 149
 150         return SR_OK;
 151 }
 152
 153 static int hw_init(struct sr_context *sr_ctx)
 154 {
 155         return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
 156 }
 157
 158 static GSList *hw_scan(GSList *options)
 159 {
 160         struct drv_context *drvc;
 161         struct sr_dev_inst *sdi;
 162         struct dev_context *devc;
 163         struct sr_probe *probe;
 164         GSList *devices;
 165         GDir *dir;
 166         const gchar *dev_name;
 167         const gchar *dev_dir = "/dev/";
 168         const gchar *prefix = "usbtmc";
 169         gchar *device;
 170         const gchar *idn_query = "*IDN?";
 171         int len, num_tokens, fd, i;
 172         const gchar *delimiter = ",";
 173         gchar **tokens;
 174         const char *manufacturer, *model, *version;
 175         int num_models;
 176         gboolean matched = FALSE;
 177         char buf[256];
 178
 179         (void)options;
 180
 181         drvc = di->priv;
 182         drvc->instances = NULL;
 183
 184         devices = NULL;
 185
 186         dir = g_dir_open("/sys/class/usb/", 0, NULL);
 187
 188         if (dir == NULL)
 189                 return NULL;
 190
 191         while ((dev_name = g_dir_read_name(dir)) != NULL) {
 192                 if (strncmp(dev_name, prefix, strlen(prefix)))
 193                         continue;
 194
 195                 device = g_strconcat(dev_dir, dev_name, NULL);
 196
 197                 fd = open(device, O_RDWR);
 198                 len = write(fd, idn_query, strlen(idn_query));
 199                 len = read(fd, buf, sizeof(buf));
 200                 close(fd);
 201                 if (len == 0) {
 202                         g_free(device);
 203                         return NULL;
 204                 }
 205
 206                 buf[len] = 0;
 207                 tokens = g_strsplit(buf, delimiter, 0);
 208                 close(fd);
 209                 sr_dbg("response: %s %d [%s]", device, len, buf);
 210
 211                 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
 212
 213                 if (num_tokens < 4) {
 214                         g_strfreev(tokens);
 215                         g_free(device);
 216                         return NULL;
 217                 }
 218
 219                 manufacturer = tokens[0];
 220                 model = tokens[1];
 221                 version = tokens[3];
 222
 223                 if (strcmp(manufacturer, "Rigol Technologies")) {
 224                         g_strfreev(tokens);
 225                         g_free(device);
 226                         return NULL;
 227                 }
 228
 229                 num_models = sizeof(supported_models) / sizeof(supported_models[0]);
 230
 231                 for (i = 0; i < num_models; i++) {
 232                         if (!strcmp(model, supported_models[i])) {
 233                                 matched = 1;
 234                                 break;
 235                         }
 236                 }
 237
 238                 if (!matched || !(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE,
 239                         manufacturer, model, version))) {
 240                         g_strfreev(tokens);
 241                         g_free(device);
 242                         return NULL;
 243                 }
 244
 245                 g_strfreev(tokens);
 246
 247                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 248                         sr_err("Device context malloc failed.");
 249                         g_free(device);
 250                         return NULL;
 251                 }
 252
 253                 devc->device = device;
 254
 255                 sdi->priv = devc;
 256                 sdi->driver = di;
 257
 258                 for (i = 0; i < 2; i++) {
 259                         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE,
 260                             i == 0 ? "CH1" : "CH2")))
 261                                 return NULL;
 262                         sdi->probes = g_slist_append(sdi->probes, probe);
 263                 }
 264
 265                 drvc->instances = g_slist_append(drvc->instances, sdi);
 266                 devices = g_slist_append(devices, sdi);
 267         }
 268
 269         g_dir_close(dir);
 270
 271         return devices;
 272 }
 273
 274 static GSList *hw_dev_list(void)
 275 {
 276         return ((struct drv_context *)(di->priv))->instances;
 277 }
 278
 279 static int hw_dev_open(struct sr_dev_inst *sdi)
 280 {
 281         struct dev_context *devc;
 282         int fd;
 283
 284         devc = sdi->priv;
 285
 286         if ((fd = open(devc->device, O_RDWR)) == -1)
 287                 return SR_ERR;
 288
 289         devc->fd = fd;
 290
 291         devc->scale = 1;
 292
 293         return SR_OK;
 294 }
 295
 296 static int hw_dev_close(struct sr_dev_inst *sdi)
 297 {
 298         struct dev_context *devc;
 299
 300         devc = sdi->priv;
 301
 302         close(devc->fd);
 303
 304         return SR_OK;
 305 }
 306
 307 static int hw_cleanup(void)
 308 {
 309         clear_instances();
 310
 311         return SR_OK;
 312 }
 313
 314 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 315 {
 316         struct dev_context *devc;
 317         uint64_t tmp_u64;
 318         float tmp_float;
 319         struct sr_rational tmp_rat;
 320         int ret, i, j;
 321         char *channel;
 322
 323         devc = sdi->priv;
 324
 325         if (sdi->status != SR_ST_ACTIVE) {
 326                 sr_err("Device inactive, can't set config options.");
 327                 return SR_ERR;
 328         }
 329
 330         ret = SR_OK;
 331         switch (id) {
 332         case SR_CONF_LIMIT_FRAMES:
 333                 devc->limit_frames = *(const uint64_t *)value;
 334                 break;
 335         case SR_CONF_TRIGGER_SLOPE:
 336                 tmp_u64 = *(const int *)value;
 337                 rigol_ds1xx2_send_data(devc->fd, ":TRIG:EDGE:SLOP %s\n",
 338                                        tmp_u64 ? "POS" : "NEG");
 339                 break;
 340         case SR_CONF_HORIZ_TRIGGERPOS:
 341                 tmp_float = *(const float *)value;
 342                 rigol_ds1xx2_send_data(devc->fd, ":TIM:OFFS %.9f\n", tmp_float);
 343                 break;
 344         case SR_CONF_TIMEBASE:
 345                 tmp_rat = *(const struct sr_rational *)value;
 346                 rigol_ds1xx2_send_data(devc->fd, ":TIM:SCAL %.9f\n",
 347                                        (float)tmp_rat.p / tmp_rat.q);
 348                 break;
 349         case SR_CONF_TRIGGER_SOURCE:
 350                 if (!strcmp(value, "CH1"))
 351                         channel = "CHAN1";
 352                 else if (!strcmp(value, "CH2"))
 353                         channel = "CHAN2";
 354                 else if (!strcmp(value, "EXT"))
 355                         channel = "EXT";
 356                 else if (!strcmp(value, "AC Line"))
 357                         channel = "ACL";
 358                 else {
 359                         ret = SR_ERR_ARG;
 360                         break;
 361                 }
 362                 rigol_ds1xx2_send_data(devc->fd, ":TRIG:EDGE:SOUR %s\n", channel);
 363                 break;
 364         case SR_CONF_VDIV:
 365                 /* TODO: Not supporting vdiv per channel yet. */
 366                 tmp_rat = *(const struct sr_rational *)value;
 367                 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
 368                         if (vdivs[i].p == tmp_rat.p
 369                                         && vdivs[i].q == tmp_rat.q) {
 370                                 devc->scale = (float)tmp_rat.p / tmp_rat.q;
 371                                 for (j = 0; j < 2; j++)
 372                                         rigol_ds1xx2_send_data(devc->fd,
 373                                          ":CHAN%d:SCAL %.3f\n", j, devc->scale);
 374                                 break;
 375                         }
 376                 }
 377                 if (vdivs[i].p == 0 && vdivs[i].q == 0)
 378                         ret = SR_ERR_ARG;
 379                 break;
 380         case SR_CONF_COUPLING:
 381                 /* TODO: Not supporting coupling per channel yet. */
 382                 for (i = 0; coupling[i]; i++) {
 383                         if (!strcmp(value, coupling[i])) {
 384                                 for (j = 0; j < 2; j++)
 385                                         rigol_ds1xx2_send_data(devc->fd,
 386                                           ":CHAN%d:COUP %s\n", j, coupling[i]);
 387                                 break;
 388                         }
 389                 }
 390                 if (coupling[i] == 0)
 391                         ret = SR_ERR_ARG;
 392                 break;
 393         default:
 394                 sr_err("Unknown hardware capability: %d.", id);
 395                 ret = SR_ERR_ARG;
 396                 break;
 397         }
 398
 399         return ret;
 400 }
 401
 402 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 403 {
 404
 405         (void)sdi;
 406
 407         switch (key) {
 408         case SR_CONF_DEVICE_OPTIONS:
 409                 *data = hwcaps;
 410                 break;
 411         case SR_CONF_COUPLING:
 412                 *data = coupling;
 413                 break;
 414         case SR_CONF_VDIV:
 415                 *data = vdivs;
 416                 break;
 417         case SR_CONF_TIMEBASE:
 418                 *data = timebases;
 419                 break;
 420         case SR_CONF_TRIGGER_SOURCE:
 421                 *data = trigger_sources;
 422                 break;
 423         default:
 424                 return SR_ERR_ARG;
 425         }
 426
 427         return SR_OK;
 428 }
 429
 430 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 431                                     void *cb_data)
 432 {
 433         struct dev_context *devc;
 434         char buf[256];
 435         int len;
 436
 437         (void)cb_data;
 438
 439         devc = sdi->priv;
 440
 441         devc->num_frames = 0;
 442
 443         sr_source_add(devc->fd, G_IO_IN, 50, rigol_ds1xx2_receive_data, (void *)sdi);
 444
 445         /* Send header packet to the session bus. */
 446         std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
 447
 448         /* Hardcoded to CH1 only. */
 449         devc->enabled_probes = g_slist_append(NULL, sdi->probes->data);
 450         rigol_ds1xx2_send_data(devc->fd, ":CHAN1:SCAL?\n");
 451         len = read(devc->fd, buf, sizeof(buf));
 452         buf[len] = 0;
 453         devc->scale = atof(buf);
 454         sr_dbg("Scale is %.3f.", devc->scale);
 455         rigol_ds1xx2_send_data(devc->fd, ":CHAN1:OFFS?\n");
 456         len = read(devc->fd, buf, sizeof(buf));
 457         buf[len] = 0;
 458         devc->offset = atof(buf);
 459         sr_dbg("Offset is %.6f.", devc->offset);
 460         rigol_ds1xx2_send_data(devc->fd, ":WAV:DATA?\n");
 461
 462         return SR_OK;
 463 }
 464
 465 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 466 {
 467         struct dev_context *devc;
 468
 469         (void)cb_data;
 470
 471         devc = sdi->priv;
 472
 473         if (sdi->status != SR_ST_ACTIVE) {
 474                 sr_err("Device inactive, can't stop acquisition.");
 475                 return SR_ERR;
 476         }
 477
 478         sr_source_remove(devc->fd);
 479
 480         return SR_OK;
 481 }
 482
 483 SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info = {
 484         .name = "rigol-ds1xx2",
 485         .longname = "Rigol DS1xx2",
 486         .api_version = 1,
 487         .init = hw_init,
 488         .cleanup = hw_cleanup,
 489         .scan = hw_scan,
 490         .dev_list = hw_dev_list,
 491         .dev_clear = clear_instances,
 492         .config_set = config_set,
 493         .config_list = config_list,
 494         .dev_open = hw_dev_open,
 495         .dev_close = hw_dev_close,
 496         .dev_acquisition_start = hw_dev_acquisition_start,
 497         .dev_acquisition_stop = hw_dev_acquisition_stop,
 498         .priv = NULL,
 499 };