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