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