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->priv = devc;
 163
 164                 for (i = 0; i < ARRAY_SIZE(channel_names); i++) {
 165                         chtype = (i == 0) ? SR_CHANNEL_ANALOG : SR_CHANNEL_LOGIC;
 166                         sr_channel_new(sdi, i, chtype, TRUE, channel_names[i]);
 167                 }
 168         }
 169
 170         return std_scan_complete(di, devices);
 171 }
 172
 173 static int dev_open(struct sr_dev_inst *sdi)
 174 {
 175         int ret;
 176         struct dev_context *devc;
 177
 178         devc = sdi->priv;
 179
 180         if (serial_open(devc->serial, SERIAL_RDWR) != SR_OK)
 181                 return SR_ERR;
 182
 183         sdi->status = SR_ST_ACTIVE;
 184
 185         /* FIXME: discard serial buffer */
 186         mso_check_trigger(devc->serial, &devc->trigger_state);
 187         sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
 188
 189         ret = mso_reset_adc(sdi);
 190         if (ret != SR_OK)
 191                 return ret;
 192
 193         mso_check_trigger(devc->serial, &devc->trigger_state);
 194         sr_dbg("Trigger state: 0x%x.", devc->trigger_state);
 195
 196         //    ret = mso_reset_fsm(sdi);
 197         //    if (ret != SR_OK)
 198         //            return ret;
 199         //    return SR_ERR;
 200
 201         return SR_OK;
 202 }
 203
 204 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
 205                 const struct sr_channel_group *cg)
 206 {
 207         struct dev_context *devc;
 208
 209         (void)cg;
 210
 211         if (!sdi)
 212                 return SR_ERR_ARG;
 213
 214         devc = sdi->priv;
 215
 216         switch (key) {
 217         case SR_CONF_SAMPLERATE:
 218                 *data = g_variant_new_uint64(devc->cur_rate);
 219                 break;
 220         default:
 221                 return SR_ERR_NA;
 222         }
 223
 224         return SR_OK;
 225 }
 226
 227 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 228                 const struct sr_channel_group *cg)
 229 {
 230         int ret;
 231         struct dev_context *devc;
 232         uint64_t num_samples;
 233         const char *slope;
 234         int trigger_pos;
 235         double pos;
 236
 237         (void)cg;
 238
 239         devc = sdi->priv;
 240
 241         if (sdi->status != SR_ST_ACTIVE)
 242                 return SR_ERR_DEV_CLOSED;
 243
 244         switch (key) {
 245         case SR_CONF_SAMPLERATE:
 246                 // FIXME
 247                 return mso_configure_rate(sdi, g_variant_get_uint64(data));
 248                 ret = SR_OK;
 249                 break;
 250         case SR_CONF_LIMIT_SAMPLES:
 251                 num_samples = g_variant_get_uint64(data);
 252                 if (num_samples != 1024) {
 253                         sr_err("Only 1024 samples are supported.");
 254                         ret = SR_ERR_ARG;
 255                 } else {
 256                         devc->limit_samples = num_samples;
 257                         ret = SR_OK;
 258                 }
 259                 break;
 260         case SR_CONF_CAPTURE_RATIO:
 261                 ret = SR_OK;
 262                 break;
 263         case SR_CONF_TRIGGER_SLOPE:
 264                 slope = g_variant_get_string(data, NULL);
 265
 266                 if (!slope || !(slope[0] == 'f' || slope[0] == 'r'))
 267                         sr_err("Invalid trigger slope");
 268                         ret = SR_ERR_ARG;
 269                 } else {
 270                         devc->trigger_slope = (slope[0] == 'r')
 271                                 ? SLOPE_POSITIVE : SLOPE_NEGATIVE;
 272                         ret = SR_OK;
 273                 }
 274                 break;
 275         case SR_CONF_HORIZ_TRIGGERPOS:
 276                 pos = g_variant_get_double(data);
 277                 if (pos < 0 || pos > 255) {
 278                         sr_err("Trigger position (%f) should be between 0 and 255.", pos);
 279                         ret = SR_ERR_ARG;
 280                 } else {
 281                         trigger_pos = (int)pos;
 282                         devc->trigger_holdoff[0] = trigger_pos & 0xff;
 283                         ret = SR_OK;
 284                 }
 285                 break;
 286         case SR_CONF_RLE:
 287                 ret = SR_OK;
 288                 break;
 289         default:
 290                 ret = SR_ERR_NA;
 291                 break;
 292         }
 293
 294         return ret;
 295 }
 296
 297 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 298                 const struct sr_channel_group *cg)
 299 {
 300         GVariant *gvar;
 301         GVariantBuilder gvb;
 302
 303         (void)cg;
 304         (void)sdi;
 305
 306         switch (key) {
 307         case SR_CONF_DEVICE_OPTIONS:
 308                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 309                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 310                 break;
 311         case SR_CONF_SAMPLERATE:
 312                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 313                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 314                                 ARRAY_SIZE(samplerates), sizeof(uint64_t));
 315                 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
 316                 *data = g_variant_builder_end(&gvb);
 317                 break;
 318         case SR_CONF_TRIGGER_TYPE:
 319                 *data = g_variant_new_string(TRIGGER_TYPE);
 320                 break;
 321         default:
 322                 return SR_ERR_NA;
 323         }
 324
 325         return SR_OK;
 326 }
 327
 328 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 329 {
 330         struct dev_context *devc;
 331         int ret = SR_ERR;
 332
 333         if (sdi->status != SR_ST_ACTIVE)
 334                 return SR_ERR_DEV_CLOSED;
 335
 336         devc = sdi->priv;
 337
 338         if (mso_configure_channels(sdi) != SR_OK) {
 339                 sr_err("Failed to configure channels.");
 340                 return SR_ERR;
 341         }
 342
 343         /* FIXME: No need to do full reconfigure every time */
 344 //      ret = mso_reset_fsm(sdi);
 345 //      if (ret != SR_OK)
 346 //              return ret;
 347
 348         /* FIXME: ACDC Mode */
 349         devc->ctlbase1 &= 0x7f;
 350 //      devc->ctlbase1 |= devc->acdcmode;
 351
 352         ret = mso_configure_rate(sdi, devc->cur_rate);
 353         if (ret != SR_OK)
 354                 return ret;
 355
 356         /* set dac offset */
 357         ret = mso_dac_out(sdi, devc->dac_offset);
 358         if (ret != SR_OK)
 359                 return ret;
 360
 361         ret = mso_configure_threshold_level(sdi);
 362         if (ret != SR_OK)
 363                 return ret;
 364
 365         ret = mso_configure_trigger(sdi);
 366         if (ret != SR_OK)
 367                 return ret;
 368
 369         /* END of config hardware part */
 370         ret = mso_arm(sdi);
 371         if (ret != SR_OK)
 372                 return ret;
 373
 374         /* Start acquisition on the device. */
 375         mso_check_trigger(devc->serial, &devc->trigger_state);
 376         ret = mso_check_trigger(devc->serial, NULL);
 377         if (ret != SR_OK)
 378                 return ret;
 379
 380         /* Reset trigger state. */
 381         devc->trigger_state = 0x00;
 382
 383         std_session_send_df_header(sdi);
 384
 385         /* Our first channel is analog, the other 8 are of type 'logic'. */
 386         /* TODO. */
 387
 388         serial_source_add(sdi->session, devc->serial, G_IO_IN, -1,
 389                         mso_receive_data, sdi);
 390
 391         return SR_OK;
 392 }
 393
 394 /* This stops acquisition on ALL devices, ignoring dev_index. */
 395 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 396 {
 397         stop_acquisition(sdi);
 398
 399         return SR_OK;
 400 }
 401
 402 static struct sr_dev_driver link_mso19_driver_info = {
 403         .name = "link-mso19",
 404         .longname = "Link Instruments MSO-19",
 405         .api_version = 1,
 406         .init = std_init,
 407         .cleanup = std_cleanup,
 408         .scan = scan,
 409         .dev_list = std_dev_list,
 410         .config_get = config_get,
 411         .config_set = config_set,
 412         .config_list = config_list,
 413         .dev_open = dev_open,
 414         .dev_close = std_serial_dev_close,
 415         .dev_acquisition_start = dev_acquisition_start,
 416         .dev_acquisition_stop = dev_acquisition_stop,
 417         .context = NULL,
 418 };
 419 SR_REGISTER_DEV_DRIVER(link_mso19_driver_info);