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         (void)sigma_force_close(devc);
  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                 sr_sw_limits_init(&devc->cfg_limits);
 243                 devc->capture_ratio = 50;
 244                 devc->use_triggers = 0;
 245
 246                 /* TODO Retrieve some of this state from hardware? */
 247                 devc->firmware_idx = SIGMA_FW_NONE;
 248                 devc->samplerate = sigma_get_samplerate(sdi);
 249         }
 250         libusb_free_device_list(devlist, 1);
 251         g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
 252
 253         return std_scan_complete(di, devices);
 254 }
 255
 256 static int dev_open(struct sr_dev_inst *sdi)
 257 {
 258         struct dev_context *devc;
 259
 260         devc = sdi->priv;
 261
 262         if (devc->id.type == ASIX_TYPE_OMEGA && !ASIX_WITH_OMEGA) {
 263                 sr_err("OMEGA support is not implemented yet.");
 264                 return SR_ERR_NA;
 265         }
 266
 267         return sigma_force_open(sdi);
 268 }
 269
 270 static int dev_close(struct sr_dev_inst *sdi)
 271 {
 272         struct dev_context *devc;
 273
 274         devc = sdi->priv;
 275
 276         return sigma_force_close(devc);
 277 }
 278
 279 static int config_get(uint32_t key, GVariant **data,
 280         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 281 {
 282         struct dev_context *devc;
 283
 284         (void)cg;
 285
 286         if (!sdi)
 287                 return SR_ERR;
 288         devc = sdi->priv;
 289
 290         switch (key) {
 291         case SR_CONF_CONN:
 292                 *data = g_variant_new_string(sdi->connection_id);
 293                 break;
 294         case SR_CONF_SAMPLERATE:
 295                 *data = g_variant_new_uint64(devc->samplerate);
 296                 break;
 297         case SR_CONF_LIMIT_MSEC:
 298         case SR_CONF_LIMIT_SAMPLES:
 299                 return sr_sw_limits_config_get(&devc->cfg_limits, key, data);
 300 #if ASIX_SIGMA_WITH_TRIGGER
 301         case SR_CONF_CAPTURE_RATIO:
 302                 *data = g_variant_new_uint64(devc->capture_ratio);
 303                 break;
 304 #endif
 305         default:
 306                 return SR_ERR_NA;
 307         }
 308
 309         return SR_OK;
 310 }
 311
 312 static int config_set(uint32_t key, GVariant *data,
 313         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 314 {
 315         struct dev_context *devc;
 316         int ret;
 317         uint64_t want_rate, have_rate;
 318
 319         (void)cg;
 320
 321         devc = sdi->priv;
 322
 323         switch (key) {
 324         case SR_CONF_SAMPLERATE:
 325                 want_rate = g_variant_get_uint64(data);
 326                 ret = sigma_normalize_samplerate(want_rate, &have_rate);
 327                 if (ret != SR_OK)
 328                         return ret;
 329                 if (have_rate != want_rate) {
 330                         char *text_want, *text_have;
 331                         text_want = sr_samplerate_string(want_rate);
 332                         text_have = sr_samplerate_string(have_rate);
 333                         sr_info("Adjusted samplerate %s to %s.",
 334                                 text_want, text_have);
 335                         g_free(text_want);
 336                         g_free(text_have);
 337                 }
 338                 devc->samplerate = have_rate;
 339                 break;
 340         case SR_CONF_LIMIT_MSEC:
 341         case SR_CONF_LIMIT_SAMPLES:
 342                 return sr_sw_limits_config_set(&devc->cfg_limits, key, data);
 343 #if ASIX_SIGMA_WITH_TRIGGER
 344         case SR_CONF_CAPTURE_RATIO:
 345                 devc->capture_ratio = g_variant_get_uint64(data);
 346                 break;
 347 #endif
 348         default:
 349                 return SR_ERR_NA;
 350         }
 351
 352         return SR_OK;
 353 }
 354
 355 static int config_list(uint32_t key, GVariant **data,
 356         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 357 {
 358         switch (key) {
 359         case SR_CONF_SCAN_OPTIONS:
 360         case SR_CONF_DEVICE_OPTIONS:
 361                 if (cg)
 362                         return SR_ERR_NA;
 363                 return STD_CONFIG_LIST(key, data, sdi, cg,
 364                         scanopts, drvopts, devopts);
 365         case SR_CONF_SAMPLERATE:
 366                 *data = sigma_get_samplerates_list();
 367                 break;
 368 #if ASIX_SIGMA_WITH_TRIGGER
 369         case SR_CONF_TRIGGER_MATCH:
 370                 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
 371                 break;
 372 #endif
 373         default:
 374                 return SR_ERR_NA;
 375         }
 376
 377         return SR_OK;
 378 }
 379
 380 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 381 {
 382         struct dev_context *devc;
 383         uint16_t pindis_mask;
 384         uint8_t async, div;
 385         int triggerpin, ret;
 386         uint8_t trigsel2;
 387         struct triggerinout triggerinout_conf;
 388         struct triggerlut lut;
 389         uint8_t regval, trgconf_bytes[2], clock_bytes[4], *wrptr;
 390         size_t count;
 391
 392         devc = sdi->priv;
 393
 394         /*
 395          * Setup the device's samplerate from the value which up to now
 396          * just got checked and stored. As a byproduct this can pick and
 397          * send firmware to the device, reduce the number of available
 398          * logic channels, etc.
 399          *
 400          * Determine an acquisition timeout from optionally configured
 401          * sample count or time limits. Which depends on the samplerate.
 402          */
 403         ret = sigma_set_samplerate(sdi);
 404         if (ret != SR_OK)
 405                 return ret;
 406         ret = sigma_set_acquire_timeout(devc);
 407         if (ret != SR_OK)
 408                 return ret;
 409
 410         ret = sigma_convert_trigger(sdi);
 411         if (ret != SR_OK) {
 412                 sr_err("Could not configure triggers.");
 413                 return ret;
 414         }
 415
 416         /* Enter trigger programming mode. */
 417         ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x20);
 418         if (ret != SR_OK)
 419                 return ret;
 420
 421         trigsel2 = 0;
 422         if (devc->samplerate >= SR_MHZ(100)) {
 423                 /* 100 and 200 MHz mode. */
 424                 /* TODO Decipher the 0x81 magic number's purpose. */
 425                 ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, 0x81);
 426                 if (ret != SR_OK)
 427                         return ret;
 428
 429                 /* Find which pin to trigger on from mask. */
 430                 for (triggerpin = 0; triggerpin < 8; triggerpin++) {
 431                         if (devc->trigger.risingmask & (1 << triggerpin))
 432                                 break;
 433                         if (devc->trigger.fallingmask & (1 << triggerpin))
 434                                 break;
 435                 }
 436
 437                 /* Set trigger pin and light LED on trigger. */
 438                 trigsel2 = triggerpin & TRGSEL2_PINS_MASK;
 439                 trigsel2 |= TRGSEL2_LEDSEL1;
 440
 441                 /* Default rising edge. */
 442                 /* TODO Documentation disagrees, bit set means _rising_ edge. */
 443                 if (devc->trigger.fallingmask)
 444                         trigsel2 |= TRGSEL2_PINPOL_RISE;
 445
 446         } else if (devc->samplerate <= SR_MHZ(50)) {
 447                 /* 50MHz firmware modes. */
 448
 449                 /* Translate application specs to hardware perspective. */
 450                 ret = sigma_build_basic_trigger(devc, &lut);
 451                 if (ret != SR_OK)
 452                         return ret;
 453
 454                 /* Communicate resulting register values to the device. */
 455                 ret = sigma_write_trigger_lut(devc, &lut);
 456                 if (ret != SR_OK)
 457                         return ret;
 458
 459                 trigsel2 = TRGSEL2_LEDSEL1 | TRGSEL2_LEDSEL0;
 460         }
 461
 462         /* Setup trigger in and out pins to default values. */
 463         memset(&triggerinout_conf, 0, sizeof(triggerinout_conf));
 464         triggerinout_conf.trgout_bytrigger = 1;
 465         triggerinout_conf.trgout_enable = 1;
 466         /* TODO
 467          * Verify the correctness of this implementation. The previous
 468          * version used to assign to a C language struct with bit fields
 469          * which is highly non-portable and hard to guess the resulting
 470          * raw memory layout or wire transfer content. The C struct's
 471          * field names did not match the vendor documentation's names.
 472          * Which means that I could not verify "on paper" either. Let's
 473          * re-visit this code later during research for trigger support.
 474          */
 475         wrptr = trgconf_bytes;
 476         regval = 0;
 477         if (triggerinout_conf.trgout_bytrigger)
 478                 regval |= TRGOPT_TRGOOUTEN;
 479         write_u8_inc(&wrptr, regval);
 480         regval &= ~TRGOPT_CLEAR_MASK;
 481         if (triggerinout_conf.trgout_enable)
 482                 regval |= TRGOPT_TRGOEN;
 483         write_u8_inc(&wrptr, regval);
 484         count = wrptr - trgconf_bytes;
 485         ret = sigma_write_register(devc, WRITE_TRIGGER_OPTION,
 486                 trgconf_bytes, count);
 487         if (ret != SR_OK)
 488                 return ret;
 489
 490         /* Leave trigger programming mode. */
 491         ret = sigma_set_register(devc, WRITE_TRIGGER_SELECT2, trigsel2);
 492         if (ret != SR_OK)
 493                 return ret;
 494
 495         /*
 496          * Samplerate dependent clock and channels configuration. Some
 497          * channels by design are not available at higher clock rates.
 498          * Register layout differs between firmware variants (depth 1
 499          * with LSB channel mask above 50MHz, depth 4 with more details
 500          * up to 50MHz).
 501          *
 502          * Derive a mask where bits are set for unavailable channels.
 503          * Either send the single byte, or the full byte sequence.
 504          */
 505         pindis_mask = ~((1UL << devc->num_channels) - 1);
 506         if (devc->samplerate > SR_MHZ(50)) {
 507                 ret = sigma_set_register(devc, WRITE_CLOCK_SELECT,
 508                         pindis_mask & 0xff);
 509         } else {
 510                 wrptr = clock_bytes;
 511                 /* Select 50MHz base clock, and divider. */
 512                 async = 0;
 513                 div = SR_MHZ(50) / devc->samplerate - 1;
 514                 /*
 515                  * TODO Optionally use external clock.
 516                  * async[0] = 1 to enable external clock
 517                  * div[5] = 1 to select falling edge
 518                  * div[4] = 1 to select rising edge
 519                  * div[3:0] = 1..16 to select clock pin
 520                  */
 521                 write_u8_inc(&wrptr, async);
 522                 write_u8_inc(&wrptr, div);
 523                 write_u16be_inc(&wrptr, pindis_mask);
 524                 ret = sigma_write_register(devc, WRITE_CLOCK_SELECT,
 525                         clock_bytes, wrptr - clock_bytes);
 526         }
 527         if (ret != SR_OK)
 528                 return ret;
 529
 530         /* Setup maximum post trigger time. */
 531         ret = sigma_set_register(devc, WRITE_POST_TRIGGER,
 532                 (devc->capture_ratio * 255) / 100);
 533         if (ret != SR_OK)
 534                 return ret;
 535
 536         /* Start acqusition. */
 537         regval = WMR_TRGRES | WMR_SDRAMWRITEEN;
 538 #if ASIX_SIGMA_WITH_TRIGGER
 539         regval |= WMR_TRGEN;
 540 #endif
 541         ret = sigma_set_register(devc, WRITE_MODE, regval);
 542         if (ret != SR_OK)
 543                 return ret;
 544
 545         ret = std_session_send_df_header(sdi);
 546         if (ret != SR_OK)
 547                 return ret;
 548
 549         /* Add capture source. */
 550         ret = sr_session_source_add(sdi->session, -1, 0, 10,
 551                 sigma_receive_data, (void *)sdi);
 552         if (ret != SR_OK)
 553                 return ret;
 554
 555         devc->state.state = SIGMA_CAPTURE;
 556
 557         return SR_OK;
 558 }
 559
 560 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 561 {
 562         struct dev_context *devc;
 563
 564         devc = sdi->priv;
 565
 566         /*
 567          * When acquisition is currently running, keep the receive
 568          * routine registered and have it stop the acquisition upon the
 569          * next invocation. Else unregister the receive routine here
 570          * already. The detour is required to have sample data retrieved
 571          * for forced acquisition stops.
 572          */
 573         if (devc->state.state == SIGMA_CAPTURE) {
 574                 devc->state.state = SIGMA_STOPPING;
 575         } else {
 576                 devc->state.state = SIGMA_IDLE;
 577                 (void)sr_session_source_remove(sdi->session, -1);
 578         }
 579
 580         return SR_OK;
 581 }
 582
 583 static struct sr_dev_driver asix_sigma_driver_info = {
 584         .name = "asix-sigma",
 585         .longname = "ASIX SIGMA/SIGMA2",
 586         .api_version = 1,
 587         .init = std_init,
 588         .cleanup = std_cleanup,
 589         .scan = scan,
 590         .dev_list = std_dev_list,
 591         .dev_clear = dev_clear,
 592         .config_get = config_get,
 593         .config_set = config_set,
 594         .config_list = config_list,
 595         .dev_open = dev_open,
 596         .dev_close = dev_close,
 597         .dev_acquisition_start = dev_acquisition_start,
 598         .dev_acquisition_stop = dev_acquisition_stop,
 599         .context = NULL,
 600 };
 601 SR_REGISTER_DEV_DRIVER(asix_sigma_driver_info);