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 "protocol.h"
  23
  24 static const int32_t 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 };
  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         /* Note: DSO needs to be first. */
  42         "DSO", "0", "1", "2", "3", "4", "5", "6", "7", NULL,
  43 };
  44
  45 static const uint64_t samplerates[] = {
  46         SR_HZ(100),
  47         SR_MHZ(200),
  48         SR_HZ(100),
  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 init(struct sr_context *sr_ctx)
  55 {
  56         return std_init(sr_ctx, di, LOG_PREFIX);
  57 }
  58
  59 static GSList *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         int ptype;
  69
  70         for (l = options; l; l = l->next) {
  71                 src = l->data;
  72                 switch (src->key) {
  73                 case SR_CONF_CONN:
  74                         conn = g_variant_get_string(src->data, NULL);
  75                         break;
  76                 case SR_CONF_SERIALCOMM:
  77                         serialcomm = g_variant_get_string(src->data, NULL);
  78                         break;
  79                 }
  80         }
  81         if (!conn)
  82                 conn = SERIALCONN;
  83         if (serialcomm == NULL)
  84                 serialcomm = SERIALCOMM;
  85
  86         udev = udev_new();
  87         if (!udev) {
  88                 sr_err("Failed to initialize udev.");
  89         }
  90
  91         struct udev_enumerate *enumerate = udev_enumerate_new(udev);
  92         udev_enumerate_add_match_subsystem(enumerate, "usb-serial");
  93         udev_enumerate_scan_devices(enumerate);
  94         struct udev_list_entry *devs = udev_enumerate_get_list_entry(enumerate);
  95         struct udev_list_entry *dev_list_entry;
  96         for (dev_list_entry = devs;
  97              dev_list_entry != NULL;
  98              dev_list_entry = udev_list_entry_get_next(dev_list_entry)) {
  99                 const char *syspath = udev_list_entry_get_name(dev_list_entry);
 100                 struct udev_device *dev =
 101                     udev_device_new_from_syspath(udev, syspath);
 102                 const char *sysname = udev_device_get_sysname(dev);
 103                 struct udev_device *parent =
 104                     udev_device_get_parent_with_subsystem_devtype(dev, "usb",
 105                                                                   "usb_device");
 106
 107                 if (!parent) {
 108                         sr_err("Unable to find parent usb device for %s",
 109                                sysname);
 110                         continue;
 111                 }
 112
 113                 const char *idVendor =
 114                     udev_device_get_sysattr_value(parent, "idVendor");
 115                 const char *idProduct =
 116                     udev_device_get_sysattr_value(parent, "idProduct");
 117                 if (strcmp(USB_VENDOR, idVendor)
 118                     || strcmp(USB_PRODUCT, idProduct))
 119                         continue;
 120
 121                 const char *iSerial =
 122                     udev_device_get_sysattr_value(parent, "serial");
 123                 const char *iProduct =
 124                     udev_device_get_sysattr_value(parent, "product");
 125
 126                 char path[32];
 127                 snprintf(path, sizeof(path), "/dev/%s", sysname);
 128                 conn = path;
 129
 130                 size_t s = strcspn(iProduct, " ");
 131                 char product[32];
 132                 char manufacturer[32];
 133                 if (s > sizeof(product) ||
 134                     strlen(iProduct) - s > sizeof(manufacturer)) {
 135                         sr_err("Could not parse iProduct: %s.", iProduct);
 136                         continue;
 137                 }
 138                 strncpy(product, iProduct, s);
 139                 product[s] = 0;
 140                 strcpy(manufacturer, iProduct + s + 1);
 141
 142                 //Create the device context and set its params
 143                 struct dev_context *devc;
 144                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 145                         sr_err("Device context malloc failed.");
 146                         return devices;
 147                 }
 148
 149                 if (mso_parse_serial(iSerial, iProduct, devc) != SR_OK) {
 150                         sr_err("Invalid iSerial: %s.", iSerial);
 151                         g_free(devc);
 152                         return devices;
 153                 }
 154
 155                 char hwrev[32];
 156                 sprintf(hwrev, "r%d", devc->hwrev);
 157                 devc->ctlbase1 = 0;
 158                 devc->protocol_trigger.spimode = 0;
 159                 for (i = 0; i < 4; i++) {
 160                         devc->protocol_trigger.word[i] = 0;
 161                         devc->protocol_trigger.mask[i] = 0xff;
 162                 }
 163
 164                 if (!(devc->serial = sr_serial_dev_inst_new(conn, serialcomm))) {
 165                         g_free(devc);
 166                         return devices;
 167                 }
 168
 169                 struct sr_dev_inst *sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
 170                                                 manufacturer, product, hwrev);
 171
 172                 if (!sdi) {
 173                         sr_err("Unable to create device instance for %s",
 174                                sysname);
 175                         sr_dev_inst_free(sdi);
 176                         g_free(devc);
 177                         return devices;
 178                 }
 179
 180                 sdi->driver = di;
 181                 sdi->priv = devc;
 182
 183                 for (i = 0; i < NUM_PROBES; i++) {
 184                         struct sr_probe *probe;
 185                         ptype = (i == 0) ? SR_PROBE_ANALOG : SR_PROBE_LOGIC;
 186                         if (!(probe = sr_probe_new(i, ptype, 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 *dev_list(void)
 202 {
 203         return ((struct drv_context *)(di->priv))->instances;
 204 }
 205
 206 static int 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 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 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                 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, GVariant **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 = g_variant_new_uint64(devc->cur_rate);
 295                 } else
 296                         return SR_ERR;
 297                 break;
 298         default:
 299                 return SR_ERR_NA;
 300         }
 301
 302         return SR_OK;
 303 }
 304
 305 static int config_set(int id, GVariant *data, 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         double pos;
 312
 313         devc = sdi->priv;
 314
 315         if (sdi->status != SR_ST_ACTIVE)
 316                 return SR_ERR_DEV_CLOSED;
 317
 318         switch (id) {
 319         case SR_CONF_SAMPLERATE:
 320                 // FIXME
 321                 return mso_configure_rate(sdi, g_variant_get_uint64(data));
 322                 ret = SR_OK;
 323                 break;
 324         case SR_CONF_LIMIT_SAMPLES:
 325                 num_samples = g_variant_get_uint64(data);
 326                 if (num_samples != 1024) {
 327                         sr_err("Only 1024 samples are supported.");
 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 = g_variant_get_uint64(data);
 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 = g_variant_get_double(data);
 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_NA;
 365                 break;
 366         }
 367
 368         return ret;
 369 }
 370
 371 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 372 {
 373         GVariant *gvar;
 374         GVariantBuilder gvb;
 375
 376         (void)sdi;
 377
 378         switch (key) {
 379         case SR_CONF_DEVICE_OPTIONS:
 380                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 381                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 382                 break;
 383         case SR_CONF_SAMPLERATE:
 384                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 385                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 386                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 387                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 388                 *data = g_variant_builder_end(&gvb);
 389                 break;
 390         case SR_CONF_TRIGGER_TYPE:
 391                 *data = g_variant_new_string(TRIGGER_TYPE);
 392                 break;
 393         default:
 394                 return SR_ERR_NA;
 395         }
 396
 397         return SR_OK;
 398 }
 399
 400 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 401 {
 402         struct dev_context *devc;
 403         int ret = SR_ERR;
 404
 405         if (sdi->status != SR_ST_ACTIVE)
 406                 return SR_ERR_DEV_CLOSED;
 407
 408         devc = sdi->priv;
 409
 410         if (mso_configure_probes(sdi) != SR_OK) {
 411                 sr_err("Failed to configure probes.");
 412                 return SR_ERR;
 413         }
 414
 415         /* FIXME: No need to do full reconfigure every time */
 416 //      ret = mso_reset_fsm(sdi);
 417 //      if (ret != SR_OK)
 418 //              return ret;
 419
 420         /* FIXME: ACDC Mode */
 421         devc->ctlbase1 &= 0x7f;
 422 //      devc->ctlbase1 |= devc->acdcmode;
 423
 424         ret = mso_configure_rate(sdi, devc->cur_rate);
 425         if (ret != SR_OK)
 426                 return ret;
 427
 428         /* set dac offset */
 429         ret = mso_dac_out(sdi, devc->dac_offset);
 430         if (ret != SR_OK)
 431                 return ret;
 432
 433         ret = mso_configure_threshold_level(sdi);
 434         if (ret != SR_OK)
 435                 return ret;
 436
 437         ret = mso_configure_trigger(sdi);
 438         if (ret != SR_OK)
 439                 return ret;
 440
 441         /* END of config hardware part */
 442         ret = mso_arm(sdi);
 443         if (ret != SR_OK)
 444                 return ret;
 445
 446         /* Start acquisition on the device. */
 447         mso_check_trigger(devc->serial, &devc->trigger_state);
 448         ret = mso_check_trigger(devc->serial, NULL);
 449         if (ret != SR_OK)
 450                 return ret;
 451
 452         /* Reset trigger state. */
 453         devc->trigger_state = 0x00;
 454
 455         /* Send header packet to the session bus. */
 456         std_session_send_df_header(cb_data, LOG_PREFIX);
 457
 458         /* Our first probe is analog, the other 8 are of type 'logic'. */
 459         /* TODO. */
 460
 461         sr_source_add(devc->serial->fd, G_IO_IN, -1, mso_receive_data, cb_data);
 462
 463         return SR_OK;
 464 }
 465
 466 /* This stops acquisition on ALL devices, ignoring dev_index. */
 467 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 468 {
 469         (void)cb_data;
 470
 471         stop_acquisition(sdi);
 472
 473         return SR_OK;
 474 }
 475
 476 SR_PRIV struct sr_dev_driver link_mso19_driver_info = {
 477         .name = "link-mso19",
 478         .longname = "Link Instruments MSO-19",
 479         .api_version = 1,
 480         .init = init,
 481         .cleanup = cleanup,
 482         .scan = scan,
 483         .dev_list = dev_list,
 484         .dev_clear = cleanup,
 485         .config_get = config_get,
 486         .config_set = config_set,
 487         .config_list = config_list,
 488         .dev_open = dev_open,
 489         .dev_close = dev_close,
 490         .dev_acquisition_start = dev_acquisition_start,
 491         .dev_acquisition_stop = dev_acquisition_stop,
 492         .priv = NULL,
 493 };