hardware/link-mso19/api.c

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