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