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