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