src/hardware/asix-sigma/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
   5  * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
   6  * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
   7  * Copyright (C) 2020 Gerhard Sittig <gerhard.sittig@gmx.net>
   8  *
   9  * This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #include <config.h>
  24 #include "protocol.h"
  25
  26 /*
  27  * Channel numbers seem to go from 1-16, according to this image:
  28  * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg
  29  * (the cable has two additional GND pins, and a TI and TO pin)
  30  */
  31 static const char *channel_names[] = {
  32         "1", "2", "3", "4", "5", "6", "7", "8",
  33         "9", "10", "11", "12", "13", "14", "15", "16",
  34 };
  35
  36 static const uint32_t scanopts[] = {
  37         SR_CONF_CONN,
  38 };
  39
  40 static const uint32_t drvopts[] = {
  41         SR_CONF_LOGIC_ANALYZER,
  42 };
  43
  44 static const uint32_t devopts[] = {
  45         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  47         SR_CONF_CONN | SR_CONF_GET,
  48         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  49 #if ASIX_SIGMA_WITH_TRIGGER
  50         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  51         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  52 #endif
  53 };
  54
  55 #if ASIX_SIGMA_WITH_TRIGGER
  56 static const int32_t trigger_matches[] = {
  57         SR_TRIGGER_ZERO,
  58         SR_TRIGGER_ONE,
  59         SR_TRIGGER_RISING,
  60         SR_TRIGGER_FALLING,
  61 };
  62 #endif
  63
  64 static void clear_helper(struct dev_context *devc)
  65 {
  66         ftdi_deinit(&devc->ftdic);
  67 }
  68
  69 static int dev_clear(const struct sr_dev_driver *di)
  70 {
  71         return std_dev_clear_with_callback(di,
  72                 (std_dev_clear_callback)clear_helper);
  73 }
  74
  75 static gboolean bus_addr_in_devices(int bus, int addr, GSList *devs)
  76 {
  77         struct sr_usb_dev_inst *usb;
  78
  79         for (/* EMPTY */; devs; devs = devs->next) {
  80                 usb = devs->data;
  81                 if (usb->bus == bus && usb->address == addr)
  82                         return TRUE;
  83         }
  84
  85         return FALSE;
  86 }
  87
  88 static gboolean known_vid_pid(const struct libusb_device_descriptor *des)
  89 {
  90         gboolean is_sigma, is_omega;
  91
  92         if (des->idVendor != USB_VENDOR_ASIX)
  93                 return FALSE;
  94         is_sigma = des->idProduct == USB_PRODUCT_SIGMA;
  95         is_omega = des->idProduct == USB_PRODUCT_OMEGA;
  96         if (!is_sigma && !is_omega)
  97                 return FALSE;
  98         return TRUE;
  99 }
 100
 101 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 102 {
 103         struct drv_context *drvc;
 104         libusb_context *usbctx;
 105         const char *conn;
 106         GSList *l, *conn_devices;
 107         struct sr_config *src;
 108         GSList *devices;
 109         libusb_device **devlist, *devitem;
 110         int bus, addr;
 111         struct libusb_device_descriptor des;
 112         struct libusb_device_handle *hdl;
 113         int ret;
 114         char conn_id[20];
 115         char serno_txt[16];
 116         char *end;
 117         long serno_num, serno_pre;
 118         enum asix_device_type dev_type;
 119         const char *dev_text;
 120         struct sr_dev_inst *sdi;
 121         struct dev_context *devc;
 122         size_t devidx, chidx;
 123
 124         drvc = di->context;
 125         usbctx = drvc->sr_ctx->libusb_ctx;
 126
 127         /* Find all devices which match an (optional) conn= spec. */
 128         conn = NULL;
 129         for (l = options; l; l = l->next) {
 130                 src = l->data;
 131                 switch (src->key) {
 132                 case SR_CONF_CONN:
 133                         conn = g_variant_get_string(src->data, NULL);
 134                         break;
 135                 }
 136         }
 137         conn_devices = NULL;
 138         if (conn)
 139                 conn_devices = sr_usb_find(usbctx, conn);
 140         if (conn && !conn_devices)
 141                 return NULL;
 142
 143         /* Find all ASIX logic analyzers (which match the connection spec). */
 144         devices = NULL;
 145         libusb_get_device_list(usbctx, &devlist);
 146         for (devidx = 0; devlist[devidx]; devidx++) {
 147                 devitem = devlist[devidx];
 148
 149                 /* Check for connection match if a user spec was given. */
 150                 bus = libusb_get_bus_number(devitem);
 151                 addr = libusb_get_device_address(devitem);
 152                 if (conn && !bus_addr_in_devices(bus, addr, conn_devices))
 153                         continue;
 154                 snprintf(conn_id, sizeof(conn_id), "%d.%d", bus, addr);
 155
 156                 /*
 157                  * Check for known VID:PID pairs. Get the serial number,
 158                  * to then derive the device type from it.
 159                  */
 160                 libusb_get_device_descriptor(devitem, &des);
 161                 if (!known_vid_pid(&des))
 162                         continue;
 163                 if (!des.iSerialNumber) {
 164                         sr_warn("Cannot get serial number (index 0).");
 165                         continue;
 166                 }
 167                 ret = libusb_open(devitem, &hdl);
 168                 if (ret < 0) {
 169                         sr_warn("Cannot open USB device %04x.%04x: %s.",
 170                                 des.idVendor, des.idProduct,
 171                                 libusb_error_name(ret));
 172                         continue;
 173                 }
 174                 ret = libusb_get_string_descriptor_ascii(hdl,
 175                         des.iSerialNumber,
 176                         (unsigned char *)serno_txt, sizeof(serno_txt));
 177                 if (ret < 0) {
 178                         sr_warn("Cannot get serial number (%s).",
 179                                 libusb_error_name(ret));
 180                         libusb_close(hdl);
 181                         continue;
 182                 }
 183                 libusb_close(hdl);
 184
 185                 /*
 186                  * All ASIX logic analyzers have a serial number, which
 187                  * reads as a hex number, and tells the device type.
 188                  */
 189                 ret = sr_atol_base(serno_txt, &serno_num, &end, 16);
 190                 if (ret != SR_OK || !end || *end) {
 191                         sr_warn("Cannot interpret serial number %s.", serno_txt);
 192                         continue;
 193                 }
 194                 dev_type = ASIX_TYPE_NONE;
 195                 dev_text = NULL;
 196                 serno_pre = serno_num >> 16;
 197                 switch (serno_pre) {
 198                 case 0xa601:
 199                         dev_type = ASIX_TYPE_SIGMA;
 200                         dev_text = "SIGMA";
 201                         sr_info("Found SIGMA, serno %s.", serno_txt);
 202                         break;
 203                 case 0xa602:
 204                         dev_type = ASIX_TYPE_SIGMA;
 205                         dev_text = "SIGMA2";
 206                         sr_info("Found SIGMA2, serno %s.", serno_txt);
 207                         break;
 208                 case 0xa603:
 209                         dev_type = ASIX_TYPE_OMEGA;
 210                         dev_text = "OMEGA";
 211                         sr_info("Found OMEGA, serno %s.", serno_txt);
 212                         if (!ASIX_WITH_OMEGA) {
 213                                 sr_warn("OMEGA support is not implemented yet.");
 214                                 continue;
 215                         }
 216                         break;
 217                 default:
 218                         sr_warn("Unknown serno %s, skipping.", serno_txt);
 219                         continue;
 220                 }
 221
 222                 /* Create a device instance, add it to the result set. */
 223
 224                 sdi = g_malloc0(sizeof(*sdi));
 225                 devices = g_slist_append(devices, sdi);
 226                 sdi->status = SR_ST_INITIALIZING;
 227                 sdi->vendor = g_strdup("ASIX");
 228                 sdi->model = g_strdup(dev_text);
 229                 sdi->serial_num = g_strdup(serno_txt);
 230                 sdi->connection_id = g_strdup(conn_id);
 231                 for (chidx = 0; chidx < ARRAY_SIZE(channel_names); chidx++)
 232                         sr_channel_new(sdi, chidx, SR_CHANNEL_LOGIC,
 233                                 TRUE, channel_names[chidx]);
 234
 235                 devc = g_malloc0(sizeof(*devc));
 236                 sdi->priv = devc;
 237                 devc->id.vid = des.idVendor;
 238                 devc->id.pid = des.idProduct;
 239                 devc->id.serno = serno_num;
 240                 devc->id.prefix = serno_pre;
 241                 devc->id.type = dev_type;
 242                 devc->samplerate = samplerates[0];
 243                 sr_sw_limits_init(&devc->cfg_limits);
 244                 devc->firmware_idx = SIGMA_FW_NONE;
 245                 devc->capture_ratio = 50;
 246                 devc->use_triggers = 0;
 247         }
 248         libusb_free_device_list(devlist, 1);
 249         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 250
 251         return std_scan_complete(di, devices);
 252 }
 253
 254 static int dev_open(struct sr_dev_inst *sdi)
 255 {
 256         struct dev_context *devc;
 257         long vid, pid;
 258         const char *serno;
 259         int ret;
 260
 261         devc = sdi->priv;
 262
 263         if (devc->id.type == ASIX_TYPE_OMEGA && !ASIX_WITH_OMEGA) {
 264                 sr_err("OMEGA support is not implemented yet.");
 265                 return SR_ERR_NA;
 266         }
 267         vid = devc->id.vid;
 268         pid = devc->id.pid;
 269         serno = sdi->serial_num;
 270
 271         ret = ftdi_init(&devc->ftdic);
 272         if (ret < 0) {
 273                 sr_err("Cannot initialize FTDI context (%d): %s.",
 274                         ret, ftdi_get_error_string(&devc->ftdic));
 275                 return SR_ERR_IO;
 276         }
 277         ret = ftdi_usb_open_desc_index(&devc->ftdic, vid, pid, NULL, serno, 0);
 278         if (ret < 0) {
 279                 sr_err("Cannot open device (%d): %s.",
 280                         ret, ftdi_get_error_string(&devc->ftdic));
 281                 return SR_ERR_IO;
 282         }
 283
 284         return SR_OK;
 285 }
 286
 287 static int dev_close(struct sr_dev_inst *sdi)
 288 {
 289         struct dev_context *devc;
 290         int ret;
 291
 292         devc = sdi->priv;
 293
 294         ret = ftdi_usb_close(&devc->ftdic);
 295         ftdi_deinit(&devc->ftdic);
 296
 297         return (ret == 0) ? SR_OK : SR_ERR;
 298 }
 299
 300 static int config_get(uint32_t key, GVariant **data,
 301         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 302 {
 303         struct dev_context *devc;
 304
 305         (void)cg;
 306
 307         if (!sdi)
 308                 return SR_ERR;
 309         devc = sdi->priv;
 310
 311         switch (key) {
 312         case SR_CONF_CONN:
 313                 *data = g_variant_new_string(sdi->connection_id);
 314                 break;
 315         case SR_CONF_SAMPLERATE:
 316                 *data = g_variant_new_uint64(devc->samplerate);
 317                 break;
 318         case SR_CONF_LIMIT_MSEC:
 319         case SR_CONF_LIMIT_SAMPLES:
 320                 return sr_sw_limits_config_get(&devc->cfg_limits, key, data);
 321 #if ASIX_SIGMA_WITH_TRIGGER
 322         case SR_CONF_CAPTURE_RATIO:
 323                 *data = g_variant_new_uint64(devc->capture_ratio);
 324                 break;
 325 #endif
 326         default:
 327                 return SR_ERR_NA;
 328         }
 329
 330         return SR_OK;
 331 }
 332
 333 static int config_set(uint32_t key, GVariant *data,
 334         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 335 {
 336         struct dev_context *devc;
 337         int ret;
 338         uint64_t want_rate, have_rate;
 339
 340         (void)cg;
 341
 342         devc = sdi->priv;
 343
 344         switch (key) {
 345         case SR_CONF_SAMPLERATE:
 346                 want_rate = g_variant_get_uint64(data);
 347                 ret = sigma_normalize_samplerate(want_rate, &have_rate);
 348                 if (ret != SR_OK)
 349                         return ret;
 350                 if (have_rate != want_rate) {
 351                         char *text_want, *text_have;
 352                         text_want = sr_samplerate_string(want_rate);
 353                         text_have = sr_samplerate_string(have_rate);
 354                         sr_info("Adjusted samplerate %s to %s.",
 355                                 text_want, text_have);
 356                         g_free(text_want);
 357                         g_free(text_have);
 358                 }
 359                 devc->samplerate = have_rate;
 360                 break;
 361         case SR_CONF_LIMIT_MSEC:
 362         case SR_CONF_LIMIT_SAMPLES:
 363                 return sr_sw_limits_config_set(&devc->cfg_limits, key, data);
 364 #if ASIX_SIGMA_WITH_TRIGGER
 365         case SR_CONF_CAPTURE_RATIO:
 366                 devc->capture_ratio = g_variant_get_uint64(data);
 367                 break;
 368 #endif
 369         default:
 370                 return SR_ERR_NA;
 371         }
 372
 373         return SR_OK;
 374 }
 375
 376 static int config_list(uint32_t key, GVariant **data,
 377         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 378 {
 379         switch (key) {
 380         case SR_CONF_SCAN_OPTIONS:
 381         case SR_CONF_DEVICE_OPTIONS:
 382                 if (cg)
 383                         return SR_ERR_NA;
 384                 return STD_CONFIG_LIST(key, data, sdi, cg,
 385                         scanopts, drvopts, devopts);
 386         case SR_CONF_SAMPLERATE:
 387                 *data = std_gvar_samplerates(samplerates, samplerates_count);
 388                 break;
 389 #if ASIX_SIGMA_WITH_TRIGGER
 390         case SR_CONF_TRIGGER_MATCH:
 391                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 392                 break;
 393 #endif
 394         default:
 395                 return SR_ERR_NA;
 396         }
 397
 398         return SR_OK;
 399 }
 400
 401 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 402 {
 403         struct dev_context *devc;
 404         struct clockselect_50 clockselect;
 405         int triggerpin, ret;
 406         uint8_t triggerselect;
 407         struct triggerinout triggerinout_conf;
 408         struct triggerlut lut;
 409         uint8_t regval, trgconf_bytes[2], clock_bytes[4], *wrptr;
 410         size_t count;
 411
 412         devc = sdi->priv;
 413
 414         /*
 415          * Setup the device's samplerate from the value which up to now
 416          * just got checked and stored. As a byproduct this can pick and
 417          * send firmware to the device, reduce the number of available
 418          * logic channels, etc.
 419          *
 420          * Determine an acquisition timeout from optionally configured
 421          * sample count or time limits. Which depends on the samplerate.
 422          */
 423         ret = sigma_set_samplerate(sdi);
 424         if (ret != SR_OK)
 425                 return ret;
 426         ret = sigma_set_acquire_timeout(devc);
 427         if (ret != SR_OK)
 428                 return ret;
 429
 430         if (sigma_convert_trigger(sdi) != SR_OK) {
 431                 sr_err("Failed to configure triggers.");
 432                 return SR_ERR;
 433         }
 434
 435         /* Enter trigger programming mode. */
 436         sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x20);
 437
 438         triggerselect = 0;
 439         if (devc->samplerate >= SR_MHZ(100)) {
 440                 /* 100 and 200 MHz mode. */
 441                 sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x81);
 442
 443                 /* Find which pin to trigger on from mask. */
 444                 for (triggerpin = 0; triggerpin < 8; triggerpin++) {
 445                         if (devc->trigger.risingmask & (1 << triggerpin))
 446                                 break;
 447                         if (devc->trigger.fallingmask & (1 << triggerpin))
 448                                 break;
 449                 }
 450
 451                 /* Set trigger pin and light LED on trigger. */
 452                 triggerselect = TRGSEL2_LEDSEL1 | (triggerpin & 0x7);
 453
 454                 /* Default rising edge. */
 455                 if (devc->trigger.fallingmask)
 456                         triggerselect |= 1 << 3;
 457
 458         } else if (devc->samplerate <= SR_MHZ(50)) {
 459                 /* All other modes. */
 460                 sigma_build_basic_trigger(devc, &lut);
 461
 462                 sigma_write_trigger_lut(devc, &lut);
 463
 464                 triggerselect = TRGSEL2_LEDSEL1 | TRGSEL2_LEDSEL0;
 465         }
 466
 467         /* Setup trigger in and out pins to default values. */
 468         memset(&triggerinout_conf, 0, sizeof(triggerinout_conf));
 469         triggerinout_conf.trgout_bytrigger = 1;
 470         triggerinout_conf.trgout_enable = 1;
 471         /* TODO
 472          * Verify the correctness of this implementation. The previous
 473          * version used to assign to a C language struct with bit fields
 474          * which is highly non-portable and hard to guess the resulting
 475          * raw memory layout or wire transfer content. The C struct's
 476          * field names did not match the vendor documentation's names.
 477          * Which means that I could not verify "on paper" either. Let's
 478          * re-visit this code later during research for trigger support.
 479          */
 480         wrptr = trgconf_bytes;
 481         regval = 0;
 482         if (triggerinout_conf.trgout_bytrigger)
 483                 regval |= TRGOPT_TRGOOUTEN;
 484         write_u8_inc(&wrptr, regval);
 485         regval &= ~TRGOPT_CLEAR_MASK;
 486         if (triggerinout_conf.trgout_enable)
 487                 regval |= TRGOPT_TRGOEN;
 488         write_u8_inc(&wrptr, regval);
 489         count = wrptr - trgconf_bytes;
 490         sigma_write_register(devc, WRITE_TRIGGER_OPTION, trgconf_bytes, count);
 491
 492         /* Leave trigger programming mode. */
 493         sigma_set_register(devc, WRITE_TRIGGER_SELECT2, triggerselect);
 494
 495         /* Set clock select register. */
 496         clockselect.async = 0;
 497         clockselect.fraction = 1;               /* Divider 1. */
 498         clockselect.disabled_channels = 0x0000; /* All channels enabled. */
 499         if (devc->samplerate == SR_MHZ(200)) {
 500                 /* Enable 4 channels. */
 501                 clockselect.disabled_channels = 0xfff0;
 502         } else if (devc->samplerate == SR_MHZ(100)) {
 503                 /* Enable 8 channels. */
 504                 clockselect.disabled_channels = 0xff00;
 505         } else {
 506                 /*
 507                  * 50 MHz mode, or fraction thereof. The 50MHz reference
 508                  * can get divided by any integer in the range 1 to 256.
 509                  * Divider minus 1 gets written to the hardware.
 510                  * (The driver lists a discrete set of sample rates, but
 511                  * all of them fit the above description.)
 512                  */
 513                 clockselect.fraction = SR_MHZ(50) / devc->samplerate;
 514         }
 515         wrptr = clock_bytes;
 516         write_u8_inc(&wrptr, clockselect.async);
 517         write_u8_inc(&wrptr, clockselect.fraction - 1);
 518         write_u16be_inc(&wrptr, clockselect.disabled_channels);
 519         count = wrptr - clock_bytes;
 520         sigma_write_register(devc, WRITE_CLOCK_SELECT, clock_bytes, count);
 521
 522         /* Setup maximum post trigger time. */
 523         sigma_set_register(devc, WRITE_POST_TRIGGER,
 524                 (devc->capture_ratio * 255) / 100);
 525
 526         /* Start acqusition. */
 527         regval = WMR_TRGRES | WMR_SDRAMWRITEEN;
 528 #if ASIX_SIGMA_WITH_TRIGGER
 529         regval |= WMR_TRGEN;
 530 #endif
 531         sigma_set_register(devc, WRITE_MODE, regval);
 532
 533         std_session_send_df_header(sdi);
 534
 535         /* Add capture source. */
 536         sr_session_source_add(sdi->session, -1, 0, 10,
 537                 sigma_receive_data, (void *)sdi);
 538
 539         devc->state.state = SIGMA_CAPTURE;
 540
 541         return SR_OK;
 542 }
 543
 544 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 545 {
 546         struct dev_context *devc;
 547
 548         devc = sdi->priv;
 549
 550         /*
 551          * When acquisition is currently running, keep the receive
 552          * routine registered and have it stop the acquisition upon the
 553          * next invocation. Else unregister the receive routine here
 554          * already. The detour is required to have sample data retrieved
 555          * for forced acquisition stops.
 556          */
 557         if (devc->state.state == SIGMA_CAPTURE) {
 558                 devc->state.state = SIGMA_STOPPING;
 559         } else {
 560                 devc->state.state = SIGMA_IDLE;
 561                 sr_session_source_remove(sdi->session, -1);
 562         }
 563
 564         return SR_OK;
 565 }
 566
 567 static struct sr_dev_driver asix_sigma_driver_info = {
 568         .name = "asix-sigma",
 569         .longname = "ASIX SIGMA/SIGMA2",
 570         .api_version = 1,
 571         .init = std_init,
 572         .cleanup = std_cleanup,
 573         .scan = scan,
 574         .dev_list = std_dev_list,
 575         .dev_clear = dev_clear,
 576         .config_get = config_get,
 577         .config_set = config_set,
 578         .config_list = config_list,
 579         .dev_open = dev_open,
 580         .dev_close = dev_close,
 581         .dev_acquisition_start = dev_acquisition_start,
 582         .dev_acquisition_stop = dev_acquisition_stop,
 583         .context = NULL,
 584 };
 585 SR_REGISTER_DEV_DRIVER(asix_sigma_driver_info);