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  *
   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 /*
  23  * ASIX SIGMA/SIGMA2 logic analyzer driver
  24  */
  25
  26 #include <config.h>
  27 #include "protocol.h"
  28
  29 /*
  30  * Channel numbers seem to go from 1-16, according to this image:
  31  * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg
  32  * (the cable has two additional GND pins, and a TI and TO pin)
  33  */
  34 static const char *channel_names[] = {
  35         "1", "2", "3", "4", "5", "6", "7", "8",
  36         "9", "10", "11", "12", "13", "14", "15", "16",
  37 };
  38
  39 static const uint32_t drvopts[] = {
  40         SR_CONF_LOGIC_ANALYZER,
  41 };
  42
  43 static const uint32_t devopts[] = {
  44         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  45         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  47 #if ASIX_SIGMA_WITH_TRIGGER
  48         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  49         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  50 #endif
  51 };
  52
  53 #if ASIX_SIGMA_WITH_TRIGGER
  54 static const int32_t trigger_matches[] = {
  55         SR_TRIGGER_ZERO,
  56         SR_TRIGGER_ONE,
  57         SR_TRIGGER_RISING,
  58         SR_TRIGGER_FALLING,
  59 };
  60 #endif
  61
  62 static int dev_clear(const struct sr_dev_driver *di)
  63 {
  64         return std_dev_clear(di, sigma_clear_helper);
  65 }
  66
  67 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  68 {
  69         struct sr_dev_inst *sdi;
  70         struct dev_context *devc;
  71         struct ftdi_device_list *devlist;
  72         char serial_txt[10];
  73         uint32_t serial;
  74         int ret;
  75         unsigned int i;
  76
  77         (void)options;
  78
  79         devc = g_malloc0(sizeof(struct dev_context));
  80
  81         ftdi_init(&devc->ftdic);
  82
  83         /* Look for SIGMAs. */
  84
  85         if ((ret = ftdi_usb_find_all(&devc->ftdic, &devlist,
  86             USB_VENDOR, USB_PRODUCT)) <= 0) {
  87                 if (ret < 0)
  88                         sr_err("ftdi_usb_find_all(): %d", ret);
  89                 goto free;
  90         }
  91
  92         /* Make sure it's a version 1 or 2 SIGMA. */
  93         ftdi_usb_get_strings(&devc->ftdic, devlist->dev, NULL, 0, NULL, 0,
  94                              serial_txt, sizeof(serial_txt));
  95         sscanf(serial_txt, "%x", &serial);
  96
  97         if (serial < 0xa6010000 || serial > 0xa602ffff) {
  98                 sr_err("Only SIGMA and SIGMA2 are supported "
  99                        "in this version of libsigrok.");
 100                 goto free;
 101         }
 102
 103         sr_info("Found ASIX SIGMA - Serial: %s", serial_txt);
 104
 105         devc->cur_samplerate = samplerates[0];
 106         devc->limit_msec = 0;
 107         devc->limit_samples = 0;
 108         devc->cur_firmware = -1;
 109         devc->num_channels = 0;
 110         devc->samples_per_event = 0;
 111         devc->capture_ratio = 50;
 112         devc->use_triggers = 0;
 113
 114         /* Register SIGMA device. */
 115         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 116         sdi->status = SR_ST_INITIALIZING;
 117         sdi->vendor = g_strdup(USB_VENDOR_NAME);
 118         sdi->model = g_strdup(USB_MODEL_NAME);
 119
 120         for (i = 0; i < ARRAY_SIZE(channel_names); i++)
 121                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
 122
 123         sdi->priv = devc;
 124
 125         /* We will open the device again when we need it. */
 126         ftdi_list_free(&devlist);
 127
 128         return std_scan_complete(di, g_slist_append(NULL, sdi));
 129
 130 free:
 131         ftdi_deinit(&devc->ftdic);
 132         g_free(devc);
 133         return NULL;
 134 }
 135
 136 static int dev_open(struct sr_dev_inst *sdi)
 137 {
 138         struct dev_context *devc;
 139         int ret;
 140
 141         devc = sdi->priv;
 142
 143         /* Make sure it's an ASIX SIGMA. */
 144         if ((ret = ftdi_usb_open_desc(&devc->ftdic,
 145                 USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
 146
 147                 sr_err("ftdi_usb_open failed: %s",
 148                        ftdi_get_error_string(&devc->ftdic));
 149
 150                 return 0;
 151         }
 152
 153         sdi->status = SR_ST_ACTIVE;
 154
 155         return SR_OK;
 156 }
 157
 158 static int dev_close(struct sr_dev_inst *sdi)
 159 {
 160         struct dev_context *devc;
 161
 162         devc = sdi->priv;
 163
 164         /* TODO */
 165         if (sdi->status == SR_ST_ACTIVE)
 166                 ftdi_usb_close(&devc->ftdic);
 167
 168         sdi->status = SR_ST_INACTIVE;
 169
 170         return SR_OK;
 171 }
 172
 173 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 174                 const struct sr_channel_group *cg)
 175 {
 176         struct dev_context *devc;
 177
 178         (void)cg;
 179
 180         if (!sdi)
 181                 return SR_ERR;
 182         devc = sdi->priv;
 183
 184         switch (key) {
 185         case SR_CONF_SAMPLERATE:
 186                 *data = g_variant_new_uint64(devc->cur_samplerate);
 187                 break;
 188         case SR_CONF_LIMIT_MSEC:
 189                 *data = g_variant_new_uint64(devc->limit_msec);
 190                 break;
 191         case SR_CONF_LIMIT_SAMPLES:
 192                 *data = g_variant_new_uint64(devc->limit_samples);
 193                 break;
 194 #if ASIX_SIGMA_WITH_TRIGGER
 195         case SR_CONF_CAPTURE_RATIO:
 196                 *data = g_variant_new_uint64(devc->capture_ratio);
 197                 break;
 198 #endif
 199         default:
 200                 return SR_ERR_NA;
 201         }
 202
 203         return SR_OK;
 204 }
 205
 206 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 207                 const struct sr_channel_group *cg)
 208 {
 209         struct dev_context *devc;
 210         uint64_t tmp;
 211         int ret;
 212
 213         (void)cg;
 214
 215         if (sdi->status != SR_ST_ACTIVE)
 216                 return SR_ERR_DEV_CLOSED;
 217
 218         devc = sdi->priv;
 219
 220         ret = SR_OK;
 221         switch (key) {
 222         case SR_CONF_SAMPLERATE:
 223                 ret = sigma_set_samplerate(sdi, g_variant_get_uint64(data));
 224                 break;
 225         case SR_CONF_LIMIT_MSEC:
 226                 tmp = g_variant_get_uint64(data);
 227                 if (tmp > 0)
 228                         devc->limit_msec = g_variant_get_uint64(data);
 229                 else
 230                         ret = SR_ERR;
 231                 break;
 232         case SR_CONF_LIMIT_SAMPLES:
 233                 tmp = g_variant_get_uint64(data);
 234                 devc->limit_samples = tmp;
 235                 devc->limit_msec = sigma_limit_samples_to_msec(devc, tmp);
 236                 break;
 237 #if ASIX_SIGMA_WITH_TRIGGER
 238         case SR_CONF_CAPTURE_RATIO:
 239                 tmp = g_variant_get_uint64(data);
 240                 if (tmp > 100)
 241                         return SR_ERR;
 242                 devc->capture_ratio = tmp;
 243                 break;
 244 #endif
 245         default:
 246                 ret = SR_ERR_NA;
 247         }
 248
 249         return ret;
 250 }
 251
 252 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 253                 const struct sr_channel_group *cg)
 254 {
 255         GVariant *gvar;
 256         GVariantBuilder gvb;
 257
 258         (void)cg;
 259
 260         switch (key) {
 261         case SR_CONF_DEVICE_OPTIONS:
 262                 if (!sdi)
 263                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 264                                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 265                 else
 266                         *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 267                                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 268                 break;
 269         case SR_CONF_SAMPLERATE:
 270                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 271                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
 272                                 samplerates_count, sizeof(samplerates[0]));
 273                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 274                 *data = g_variant_builder_end(&gvb);
 275                 break;
 276 #if ASIX_SIGMA_WITH_TRIGGER
 277         case SR_CONF_TRIGGER_MATCH:
 278                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 279                                 trigger_matches, ARRAY_SIZE(trigger_matches),
 280                                 sizeof(int32_t));
 281                 break;
 282 #endif
 283         default:
 284                 return SR_ERR_NA;
 285         }
 286
 287         return SR_OK;
 288 }
 289
 290 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 291 {
 292         struct dev_context *devc;
 293         struct clockselect_50 clockselect;
 294         int triggerpin, ret;
 295         uint8_t triggerselect;
 296         struct triggerinout triggerinout_conf;
 297         struct triggerlut lut;
 298         uint8_t regval;
 299         uint8_t clock_bytes[sizeof(clockselect)];
 300         size_t clock_idx;
 301
 302         devc = sdi->priv;
 303
 304         if (sigma_convert_trigger(sdi) != SR_OK) {
 305                 sr_err("Failed to configure triggers.");
 306                 return SR_ERR;
 307         }
 308
 309         /* If the samplerate has not been set, default to 200 kHz. */
 310         if (devc->cur_firmware == -1) {
 311                 if ((ret = sigma_set_samplerate(sdi, SR_KHZ(200))) != SR_OK)
 312                         return ret;
 313         }
 314
 315         /* Enter trigger programming mode. */
 316         sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20, devc);
 317
 318         triggerselect = 0;
 319         if (devc->cur_samplerate >= SR_MHZ(100)) {
 320                 /* 100 and 200 MHz mode. */
 321                 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81, devc);
 322
 323                 /* Find which pin to trigger on from mask. */
 324                 for (triggerpin = 0; triggerpin < 8; triggerpin++)
 325                         if ((devc->trigger.risingmask | devc->trigger.fallingmask) &
 326                             (1 << triggerpin))
 327                                 break;
 328
 329                 /* Set trigger pin and light LED on trigger. */
 330                 triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7);
 331
 332                 /* Default rising edge. */
 333                 if (devc->trigger.fallingmask)
 334                         triggerselect |= 1 << 3;
 335
 336         } else if (devc->cur_samplerate <= SR_MHZ(50)) {
 337                 /* All other modes. */
 338                 sigma_build_basic_trigger(&lut, devc);
 339
 340                 sigma_write_trigger_lut(&lut, devc);
 341
 342                 triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
 343         }
 344
 345         /* Setup trigger in and out pins to default values. */
 346         memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
 347         triggerinout_conf.trgout_bytrigger = 1;
 348         triggerinout_conf.trgout_enable = 1;
 349
 350         sigma_write_register(WRITE_TRIGGER_OPTION,
 351                              (uint8_t *) &triggerinout_conf,
 352                              sizeof(struct triggerinout), devc);
 353
 354         /* Go back to normal mode. */
 355         sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect, devc);
 356
 357         /* Set clock select register. */
 358         clockselect.async = 0;
 359         clockselect.fraction = 1 - 1;           /* Divider 1. */
 360         clockselect.disabled_channels = 0x0000; /* All channels enabled. */
 361         if (devc->cur_samplerate == SR_MHZ(200)) {
 362                 /* Enable 4 channels. */
 363                 clockselect.disabled_channels = 0xf0ff;
 364         } else if (devc->cur_samplerate == SR_MHZ(100)) {
 365                 /* Enable 8 channels. */
 366                 clockselect.disabled_channels = 0x00ff;
 367         } else {
 368                 /*
 369                  * 50 MHz mode, or fraction thereof. The 50MHz reference
 370                  * can get divided by any integer in the range 1 to 256.
 371                  * Divider minus 1 gets written to the hardware.
 372                  * (The driver lists a discrete set of sample rates, but
 373                  * all of them fit the above description.)
 374                  */
 375                 clockselect.fraction = SR_MHZ(50) / devc->cur_samplerate - 1;
 376         }
 377         clock_idx = 0;
 378         clock_bytes[clock_idx++] = clockselect.async;
 379         clock_bytes[clock_idx++] = clockselect.fraction;
 380         clock_bytes[clock_idx++] = clockselect.disabled_channels & 0xff;
 381         clock_bytes[clock_idx++] = clockselect.disabled_channels >> 8;
 382         sigma_write_register(WRITE_CLOCK_SELECT, clock_bytes, clock_idx, devc);
 383
 384         /* Setup maximum post trigger time. */
 385         sigma_set_register(WRITE_POST_TRIGGER,
 386                            (devc->capture_ratio * 255) / 100, devc);
 387
 388         /* Start acqusition. */
 389         devc->start_time = g_get_monotonic_time();
 390         regval =  WMR_TRGRES | WMR_SDRAMWRITEEN;
 391 #if ASIX_SIGMA_WITH_TRIGGER
 392         regval |= WMR_TRGEN;
 393 #endif
 394         sigma_set_register(WRITE_MODE, regval, devc);
 395
 396         std_session_send_df_header(sdi);
 397
 398         /* Add capture source. */
 399         sr_session_source_add(sdi->session, -1, 0, 10, sigma_receive_data, (void *)sdi);
 400
 401         devc->state.state = SIGMA_CAPTURE;
 402
 403         return SR_OK;
 404 }
 405
 406 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 407 {
 408         struct dev_context *devc;
 409
 410         devc = sdi->priv;
 411         devc->state.state = SIGMA_IDLE;
 412
 413         sr_session_source_remove(sdi->session, -1);
 414
 415         return SR_OK;
 416 }
 417
 418 static struct sr_dev_driver asix_sigma_driver_info = {
 419         .name = "asix-sigma",
 420         .longname = "ASIX SIGMA/SIGMA2",
 421         .api_version = 1,
 422         .init = std_init,
 423         .cleanup = std_cleanup,
 424         .scan = scan,
 425         .dev_list = std_dev_list,
 426         .dev_clear = dev_clear,
 427         .config_get = config_get,
 428         .config_set = config_set,
 429         .config_list = config_list,
 430         .dev_open = dev_open,
 431         .dev_close = dev_close,
 432         .dev_acquisition_start = dev_acquisition_start,
 433         .dev_acquisition_stop = dev_acquisition_stop,
 434         .context = NULL,
 435 };
 436 SR_REGISTER_DEV_DRIVER(asix_sigma_driver_info);