src/hardware/link-mso19/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
   5  * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
   6  * Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
   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 "protocol.h"
  24
  25 static const uint32_t devopts[] = {
  26         SR_CONF_OSCILLOSCOPE,
  27         SR_CONF_LOGIC_ANALYZER,
  28         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  29         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  30         SR_CONF_TRIGGER_TYPE | SR_CONF_LIST,
  31         SR_CONF_TRIGGER_SLOPE | SR_CONF_SET,
  32         SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_SET,
  33         SR_CONF_CAPTURE_RATIO | SR_CONF_SET,
  34         SR_CONF_RLE | SR_CONF_SET,
  35 };
  36
  37 /*
  38  * Channels are numbered 0 to 7.
  39  *
  40  * See also: http://www.linkinstruments.com/images/mso19_1113.gif
  41  */
  42 static const char *channel_names[] = {
  43         /* Note: DSO needs to be first. */
  44         "DSO", "0", "1", "2", "3", "4", "5", "6", "7",
  45 };
  46
  47 static const uint64_t samplerates[] = {
  48         SR_HZ(100),
  49         SR_MHZ(200),
  50         SR_HZ(100),
  51 };
  52
  53 SR_PRIV struct sr_dev_driver link_mso19_driver_info;
  54
  55 /* TODO: Use sr_dev_inst to store connection handle & use std_dev_clear(). */
  56 static int dev_clear(const struct sr_dev_driver *di)
  57 {
  58         struct drv_context *drvc = di->context;
  59         GSList *l;
  60         struct sr_dev_inst *sdi;
  61         struct dev_context *devc;
  62         int ret = SR_OK;
  63
  64         /* Properly close and free all devices. */
  65         for (l = drvc->instances; l; l = l->next) {
  66                 if (!(sdi = l->data)) {
  67                         /* Log error, but continue cleaning up the rest. */
  68                         sr_err("%s: sdi was NULL, continuing", __func__);
  69                         ret = SR_ERR_BUG;
  70                         continue;
  71                 }
  72                 if (!(devc = sdi->priv)) {
  73                         /* Log error, but continue cleaning up the rest. */
  74                         sr_err("%s: sdi->priv was NULL, continuing", __func__);
  75                         ret = SR_ERR_BUG;
  76                         continue;
  77                 }
  78                 std_serial_dev_close(sdi);
  79                 sr_serial_dev_inst_free(devc->serial);
  80                 sr_dev_inst_free(sdi);
  81         }
  82         g_slist_free(drvc->instances);
  83         drvc->instances = NULL;
  84
  85         return ret;
  86 }
  87
  88 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  89 {
  90         int i;
  91         GSList *devices = NULL;
  92         const char *conn = NULL;
  93         const char *serialcomm = NULL;
  94         GSList *l;
  95         struct sr_config *src;
  96         struct udev *udev;
  97         int chtype;
  98
  99         for (l = options; l; l = l->next) {
 100                 src = l->data;
 101                 switch (src->key) {
 102                 case SR_CONF_CONN:
 103                         conn = g_variant_get_string(src->data, NULL);
 104                         break;
 105                 case SR_CONF_SERIALCOMM:
 106                         serialcomm = g_variant_get_string(src->data, NULL);
 107                         break;
 108                 }
 109         }
 110         if (!conn)
 111                 conn = SERIALCONN;
 112         if (!serialcomm)
 113                 serialcomm = SERIALCOMM;
 114
 115         udev = udev_new();
 116         if (!udev) {
 117                 sr_err("Failed to initialize udev.");
 118         }
 119
 120         struct udev_enumerate *enumerate = udev_enumerate_new(udev);
 121         udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
 122         udev_enumerate_scan_devices(enumerate);
 123         struct udev_list_entry *devs = udev_enumerate_get_list_entry(enumerate);
 124         struct udev_list_entry *dev_list_entry;
 125         for (dev_list_entry = devs;
 126              dev_list_entry != NULL;
 127              dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
 128                 const char *syspath = udev_list_entry_get_name(dev_list_entry);
 129                 struct udev_device *dev =
 130                     udev_device_new_from_syspath(udev, syspath);
 131                 const char *sysname = udev_device_get_sysname(dev);
 132                 struct udev_device *parent =
 133                     udev_device_get_parent_with_subsystem_devtype(dev, "usb",
 134                                                                   "usb_device");
 135
 136                 if (!parent) {
 137                         sr_err("Unable to find parent usb device for %s",
 138                                sysname);
 139                         continue;
 140                 }
 141
 142                 const char *idVendor =
 143                     udev_device_get_sysattr_value(parent, "idVendor");
 144                 const char *idProduct =
 145                     udev_device_get_sysattr_value(parent, "idProduct");
 146                 if (strcmp(USB_VENDOR, idVendor)
 147                     || strcmp(USB_PRODUCT, idProduct))
 148                         continue;
 149
 150                 const char *iSerial =
 151                     udev_device_get_sysattr_value(parent, "serial");
 152                 const char *iProduct =
 153                     udev_device_get_sysattr_value(parent, "product");
 154
 155                 char path[32];
 156                 snprintf(path, sizeof(path), "/dev/%s", sysname);
 157                 conn = path;
 158
 159                 size_t s = strcspn(iProduct, " ");
 160                 char product[32];
 161                 char manufacturer[32];
 162                 if (s > sizeof(product) ||
 163                     strlen(iProduct) - s > sizeof(manufacturer)) {
 164                         sr_err("Could not parse iProduct: %s.", iProduct);
 165                         continue;
 166                 }
 167                 strncpy(product, iProduct, s);
 168                 product[s] = 0;
 169                 strcpy(manufacturer, iProduct + s + 1);
 170
 171                 //Create the device context and set its params
 172                 struct dev_context *devc;
 173                 devc = g_malloc0(sizeof(struct dev_context));
 174
 175                 if (mso_parse_serial(iSerial, iProduct, devc) != SR_OK) {
 176                         sr_err("Invalid iSerial: %s.", iSerial);
 177                         g_free(devc);
 178                         return devices;
 179                 }
 180
 181                 char hwrev[32];
 182                 sprintf(hwrev, "r%d", devc->hwrev);
 183                 devc->ctlbase1 = 0;
 184                 devc->protocol_trigger.spimode = 0;
 185                 for (i = 0; i < 4; i++) {
 186                         devc->protocol_trigger.word[i] = 0;
 187                         devc->protocol_trigger.mask[i] = 0xff;
 188                 }
 189
 190                 devc->serial = sr_serial_dev_inst_new(conn, serialcomm);
 191
 192                 struct sr_dev_inst *sdi = g_malloc0(sizeof(struct sr_dev_inst));
 193                 sdi->status = SR_ST_INACTIVE;
 194                 sdi->vendor = g_strdup(manufacturer);
 195                 sdi->model = g_strdup(product);
 196                 sdi->version = g_strdup(hwrev);
 197
 198                 if (!sdi) {
 199                         sr_err("Unable to create device instance for %s",
 200                                sysname);
 201                         sr_dev_inst_free(sdi);
 202                         g_free(devc);
 203                         return devices;
 204                 }
 205
 206                 sdi->driver = di;
 207                 sdi->priv = devc;
 208
 209                 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
 210                         chtype = (i == 0) ? SR_CHANNEL_ANALOG : SR_CHANNEL_LOGIC;
 211                         sr_channel_new(sdi, i, chtype, TRUE, channel_names[i]);
 212                 }
 213
 214                 //Add the driver
 215                 struct drv_context *drvc = di->context;
 216                 drvc->instances = g_slist_append(drvc->instances, sdi);
 217                 devices = g_slist_append(devices, sdi);
 218         }
 219
 220         return devices;
 221 }
 222
 223 static int dev_open(struct sr_dev_inst *sdi)
 224 {
 225         int ret;
 226         struct dev_context *devc;
 227
 228         devc = sdi->priv;
 229
 230         if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
 231                 return SR_ERR;
 232
 233         sdi->status = SR_ST_ACTIVE;
 234
 235         /* FIXME: discard serial buffer */
 236         mso_check_trigger(devc->serial, &devc->trigger_state);
 237         sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
 238
 239         ret = mso_reset_adc(sdi);
 240         if (ret != SR_OK)
 241                 return ret;
 242
 243         mso_check_trigger(devc->serial, &devc->trigger_state);
 244         sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
 245
 246         //    ret = mso_reset_fsm(sdi);
 247         //    if (ret != SR_OK)
 248         //            return ret;
 249         //    return SR_ERR;
 250
 251         return SR_OK;
 252 }
 253
 254 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
 255                 const struct sr_channel_group *cg)
 256 {
 257         struct dev_context *devc;
 258
 259         (void)cg;
 260
 261         switch (key) {
 262         case SR_CONF_SAMPLERATE:
 263                 if (sdi) {
 264                         devc = sdi->priv;
 265                         *data = g_variant_new_uint64(devc->cur_rate);
 266                 } else
 267                         return SR_ERR;
 268                 break;
 269         default:
 270                 return SR_ERR_NA;
 271         }
 272
 273         return SR_OK;
 274 }
 275
 276 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 277                 const struct sr_channel_group *cg)
 278 {
 279         int ret;
 280         struct dev_context *devc;
 281         uint64_t num_samples;
 282         const char *slope;
 283         int trigger_pos;
 284         double pos;
 285
 286         (void)cg;
 287
 288         devc = sdi->priv;
 289
 290         if (sdi->status != SR_ST_ACTIVE)
 291                 return SR_ERR_DEV_CLOSED;
 292
 293         switch (key) {
 294         case SR_CONF_SAMPLERATE:
 295                 // FIXME
 296                 return mso_configure_rate(sdi, g_variant_get_uint64(data));
 297                 ret = SR_OK;
 298                 break;
 299         case SR_CONF_LIMIT_SAMPLES:
 300                 num_samples = g_variant_get_uint64(data);
 301                 if (num_samples != 1024) {
 302                         sr_err("Only 1024 samples are supported.");
 303                         ret = SR_ERR_ARG;
 304                 } else {
 305                         devc->limit_samples = num_samples;
 306                         ret = SR_OK;
 307                 }
 308                 break;
 309         case SR_CONF_CAPTURE_RATIO:
 310                 ret = SR_OK;
 311                 break;
 312         case SR_CONF_TRIGGER_SLOPE:
 313                 slope = g_variant_get_string(data, NULL);
 314
 315                 if (!slope || !(slope[0] == 'f' || slope[0] == 'r'))
 316                         sr_err("Invalid trigger slope");
 317                         ret = SR_ERR_ARG;
 318                 } else {
 319                         devc->trigger_slope = (slope[0] == 'r')
 320                                 ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
 321                         ret = SR_OK;
 322                 }
 323                 break;
 324         case SR_CONF_HORIZ_TRIGGERPOS:
 325                 pos = g_variant_get_double(data);
 326                 if (pos < 0 || pos > 255) {
 327                         sr_err("Trigger position (%f) should be between 0 and 255.", pos);
 328                         ret = SR_ERR_ARG;
 329                 } else {
 330                         trigger_pos = (int)pos;
 331                         devc->trigger_holdoff[0] = trigger_pos & 0xff;
 332                         ret = SR_OK;
 333                 }
 334                 break;
 335         case SR_CONF_RLE:
 336                 ret = SR_OK;
 337                 break;
 338         default:
 339                 ret = SR_ERR_NA;
 340                 break;
 341         }
 342
 343         return ret;
 344 }
 345
 346 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 347                 const struct sr_channel_group *cg)
 348 {
 349         GVariant *gvar;
 350         GVariantBuilder gvb;
 351
 352         (void)cg;
 353         (void)sdi;
 354
 355         switch (key) {
 356         case SR_CONF_DEVICE_OPTIONS:
 357                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 358                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 359                 break;
 360         case SR_CONF_SAMPLERATE:
 361                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 362                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 363                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 364                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 365                 *data = g_variant_builder_end(&gvb);
 366                 break;
 367         case SR_CONF_TRIGGER_TYPE:
 368                 *data = g_variant_new_string(TRIGGER_TYPE);
 369                 break;
 370         default:
 371                 return SR_ERR_NA;
 372         }
 373
 374         return SR_OK;
 375 }
 376
 377 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 378 {
 379         struct dev_context *devc;
 380         int ret = SR_ERR;
 381
 382         if (sdi->status != SR_ST_ACTIVE)
 383                 return SR_ERR_DEV_CLOSED;
 384
 385         devc = sdi->priv;
 386
 387         if (mso_configure_channels(sdi) != SR_OK) {
 388                 sr_err("Failed to configure channels.");
 389                 return SR_ERR;
 390         }
 391
 392         /* FIXME: No need to do full reconfigure every time */
 393 //      ret = mso_reset_fsm(sdi);
 394 //      if (ret != SR_OK)
 395 //              return ret;
 396
 397         /* FIXME: ACDC Mode */
 398         devc->ctlbase1 &= 0x7f;
 399 //      devc->ctlbase1 |= devc->acdcmode;
 400
 401         ret = mso_configure_rate(sdi, devc->cur_rate);
 402         if (ret != SR_OK)
 403                 return ret;
 404
 405         /* set dac offset */
 406         ret = mso_dac_out(sdi, devc->dac_offset);
 407         if (ret != SR_OK)
 408                 return ret;
 409
 410         ret = mso_configure_threshold_level(sdi);
 411         if (ret != SR_OK)
 412                 return ret;
 413
 414         ret = mso_configure_trigger(sdi);
 415         if (ret != SR_OK)
 416                 return ret;
 417
 418         /* END of config hardware part */
 419         ret = mso_arm(sdi);
 420         if (ret != SR_OK)
 421                 return ret;
 422
 423         /* Start acquisition on the device. */
 424         mso_check_trigger(devc->serial, &devc->trigger_state);
 425         ret = mso_check_trigger(devc->serial, NULL);
 426         if (ret != SR_OK)
 427                 return ret;
 428
 429         /* Reset trigger state. */
 430         devc->trigger_state = 0x00;
 431
 432         std_session_send_df_header(sdi, LOG_PREFIX);
 433
 434         /* Our first channel is analog, the other 8 are of type 'logic'. */
 435         /* TODO. */
 436
 437         serial_source_add(sdi->session, devc->serial, G_IO_IN, -1,
 438                         mso_receive_data, sdi);
 439
 440         return SR_OK;
 441 }
 442
 443 /* This stops acquisition on ALL devices, ignoring dev_index. */
 444 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 445 {
 446         stop_acquisition(sdi);
 447
 448         return SR_OK;
 449 }
 450
 451 SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
 452         .name = "link-mso19",
 453         .longname = "Link Instruments MSO-19",
 454         .api_version = 1,
 455         .init = std_init,
 456         .cleanup = std_cleanup,
 457         .scan = scan,
 458         .dev_list = std_dev_list,
 459         .dev_clear = dev_clear,
 460         .config_get = config_get,
 461         .config_set = config_set,
 462         .config_list = config_list,
 463         .dev_open = dev_open,
 464         .dev_close = std_serial_dev_close,
 465         .dev_acquisition_start = dev_acquisition_start,
 466         .dev_acquisition_stop = dev_acquisition_stop,
 467         .context = NULL,
 468 };