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