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