src/hardware/ikalogic-scanaplus/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <config.h>
  22 #include "protocol.h"
  23
  24 #define USB_VENDOR_ID                   0x0403
  25 #define USB_DEVICE_ID                   0x6014
  26 #define USB_VENDOR_NAME                 "IKALOGIC"
  27 #define USB_MODEL_NAME                  "ScanaPLUS"
  28 #define USB_IPRODUCT                    "SCANAPLUS"
  29
  30 #define SAMPLE_BUF_SIZE                 (8 * 1024 * 1024)
  31
  32 static const uint32_t devopts[] = {
  33         SR_CONF_LOGIC_ANALYZER,
  34         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  35         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  36         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  37 };
  38
  39 /* Channels are numbered 1-9. */
  40 static const char *channel_names[] = {
  41         "1", "2", "3", "4", "5", "6", "7", "8", "9",
  42 };
  43
  44 /* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
  45 static const uint64_t samplerates[1] = { SR_MHZ(100) };
  46
  47 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
  48
  49 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
  50
  51 static void clear_helper(void *priv)
  52 {
  53         struct dev_context *devc;
  54
  55         devc = priv;
  56
  57         ftdi_free(devc->ftdic);
  58         g_free(devc->compressed_buf);
  59         g_free(devc->sample_buf);
  60         g_free(devc);
  61 }
  62
  63 static int dev_clear(const struct sr_dev_driver *di)
  64 {
  65         return std_dev_clear(di, clear_helper);
  66 }
  67
  68 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  69 {
  70         struct sr_dev_inst *sdi;
  71         struct drv_context *drvc;
  72         struct dev_context *devc;
  73         GSList *devices;
  74         unsigned int i;
  75         int ret;
  76
  77         (void)options;
  78
  79         drvc = di->context;
  80
  81         devices = NULL;
  82
  83         /* Allocate memory for our private device context. */
  84         devc = g_malloc0(sizeof(struct dev_context));
  85
  86         /* Allocate memory for the incoming compressed samples. */
  87         if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
  88                 sr_err("compressed_buf malloc failed.");
  89                 goto err_free_devc;
  90         }
  91
  92         /* Allocate memory for the uncompressed samples. */
  93         if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
  94                 sr_err("sample_buf malloc failed.");
  95                 goto err_free_compressed_buf;
  96         }
  97
  98         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
  99         if (!(devc->ftdic = ftdi_new())) {
 100                 sr_err("Failed to initialize libftdi.");
 101                 goto err_free_sample_buf;
 102         }
 103
 104         /* Check for the device and temporarily open it. */
 105         ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
 106                                  USB_IPRODUCT, NULL);
 107         if (ret < 0) {
 108                 /* Log errors, except for -3 ("device not found"). */
 109                 if (ret != -3)
 110                         sr_err("Failed to open device (%d): %s", ret,
 111                                ftdi_get_error_string(devc->ftdic));
 112                 goto err_free_ftdic;
 113         }
 114
 115         /* Register the device with libsigrok. */
 116         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 117         sdi->status = SR_ST_INACTIVE;
 118         sdi->vendor = g_strdup(USB_VENDOR_NAME);
 119         sdi->model = g_strdup(USB_MODEL_NAME);
 120         sdi->driver = di;
 121         sdi->priv = devc;
 122
 123         for (i = 0; i < ARRAY_SIZE(channel_names); i++)
 124                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
 125
 126         devices = g_slist_append(devices, sdi);
 127         drvc->instances = g_slist_append(drvc->instances, sdi);
 128
 129         /* Close device. We'll reopen it again when we need it. */
 130         scanaplus_close(devc);
 131
 132         return devices;
 133
 134         scanaplus_close(devc);
 135 err_free_ftdic:
 136         ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
 137 err_free_sample_buf:
 138         g_free(devc->sample_buf);
 139 err_free_compressed_buf:
 140         g_free(devc->compressed_buf);
 141 err_free_devc:
 142         g_free(devc);
 143
 144         return NULL;
 145 }
 146
 147 static int dev_open(struct sr_dev_inst *sdi)
 148 {
 149         struct dev_context *devc;
 150         int ret;
 151
 152         devc = sdi->priv;
 153
 154         /* Select interface A, otherwise communication will fail. */
 155         ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
 156         if (ret < 0) {
 157                 sr_err("Failed to set FTDI interface A (%d): %s", ret,
 158                        ftdi_get_error_string(devc->ftdic));
 159                 return SR_ERR;
 160         }
 161         sr_dbg("FTDI chip interface A set successfully.");
 162
 163         /* Open the device. */
 164         ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
 165                                  USB_IPRODUCT, NULL);
 166         if (ret < 0) {
 167                 sr_err("Failed to open device (%d): %s", ret,
 168                        ftdi_get_error_string(devc->ftdic));
 169                 return SR_ERR;
 170         }
 171         sr_dbg("FTDI device opened successfully.");
 172
 173         /* Purge RX/TX buffers in the FTDI chip. */
 174         if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
 175                 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
 176                        ret, ftdi_get_error_string(devc->ftdic));
 177                 goto err_dev_open_close_ftdic;
 178         }
 179         sr_dbg("FTDI chip buffers purged successfully.");
 180
 181         /* Reset the FTDI bitmode. */
 182         ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
 183         if (ret < 0) {
 184                 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
 185                        ret, ftdi_get_error_string(devc->ftdic));
 186                 goto err_dev_open_close_ftdic;
 187         }
 188         sr_dbg("FTDI chip bitmode reset successfully.");
 189
 190         /* Set FTDI bitmode to "sync FIFO". */
 191         ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
 192         if (ret < 0) {
 193                 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
 194                        ret, ftdi_get_error_string(devc->ftdic));
 195                 goto err_dev_open_close_ftdic;
 196         }
 197         sr_dbg("FTDI chip sync FIFO mode entered successfully.");
 198
 199         /* Set the FTDI latency timer to 2. */
 200         ret = ftdi_set_latency_timer(devc->ftdic, 2);
 201         if (ret < 0) {
 202                 sr_err("Failed to set FTDI latency timer (%d): %s.",
 203                        ret, ftdi_get_error_string(devc->ftdic));
 204                 goto err_dev_open_close_ftdic;
 205         }
 206         sr_dbg("FTDI chip latency timer set successfully.");
 207
 208         /* Set the FTDI read data chunk size to 64kB. */
 209         ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
 210         if (ret < 0) {
 211                 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
 212                        ret, ftdi_get_error_string(devc->ftdic));
 213                 goto err_dev_open_close_ftdic;
 214         }
 215         sr_dbg("FTDI chip read data chunk size set successfully.");
 216
 217         /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
 218         if ((ret = scanaplus_get_device_id(devc)) < 0) {
 219                 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
 220                 goto err_dev_open_close_ftdic;
 221         }
 222         sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
 223                devc->devid[0], devc->devid[1], devc->devid[2]);
 224
 225         sdi->status = SR_ST_ACTIVE;
 226
 227         return SR_OK;
 228
 229 err_dev_open_close_ftdic:
 230         scanaplus_close(devc);
 231         return SR_ERR;
 232 }
 233
 234 static int dev_close(struct sr_dev_inst *sdi)
 235 {
 236         int ret;
 237         struct dev_context *devc;
 238
 239         ret = SR_OK;
 240         devc = sdi->priv;
 241
 242         if (sdi->status == SR_ST_ACTIVE) {
 243                 sr_dbg("Status ACTIVE, closing device.");
 244                 ret = scanaplus_close(devc);
 245         } else {
 246                 sr_spew("Status not ACTIVE, nothing to do.");
 247         }
 248
 249         sdi->status = SR_ST_INACTIVE;
 250
 251         return ret;
 252 }
 253
 254 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 255                 const struct sr_channel_group *cg)
 256 {
 257         (void)sdi;
 258         (void)cg;
 259
 260         switch (key) {
 261         case SR_CONF_SAMPLERATE:
 262                 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
 263                 *data = g_variant_new_uint64(SR_MHZ(100));
 264                 break;
 265         default:
 266                 return SR_ERR_NA;
 267         }
 268
 269         return SR_OK;
 270 }
 271
 272 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 273                 const struct sr_channel_group *cg)
 274 {
 275         struct dev_context *devc;
 276
 277         (void)cg;
 278
 279         if (sdi->status != SR_ST_ACTIVE)
 280                 return SR_ERR_DEV_CLOSED;
 281
 282         devc = sdi->priv;
 283
 284         switch (key) {
 285         case SR_CONF_SAMPLERATE:
 286                 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
 287                         sr_err("ScanaPLUS only supports samplerate = 100MHz.");
 288                         return SR_ERR_ARG;
 289                 }
 290                 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
 291                 break;
 292         case SR_CONF_LIMIT_MSEC:
 293                 if (g_variant_get_uint64(data) == 0)
 294                         return SR_ERR_ARG;
 295                 devc->limit_msec = g_variant_get_uint64(data);
 296                 break;
 297         case SR_CONF_LIMIT_SAMPLES:
 298                 if (g_variant_get_uint64(data) == 0)
 299                         return SR_ERR_ARG;
 300                 devc->limit_samples = g_variant_get_uint64(data);
 301                 break;
 302         default:
 303                 return SR_ERR_NA;
 304         }
 305
 306         return SR_OK;
 307 }
 308
 309 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 310                 const struct sr_channel_group *cg)
 311 {
 312         GVariant *gvar;
 313         GVariantBuilder gvb;
 314
 315         (void)sdi;
 316         (void)cg;
 317
 318         switch (key) {
 319         case SR_CONF_DEVICE_OPTIONS:
 320                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 321                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 322                 break;
 323         case SR_CONF_SAMPLERATE:
 324                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 325                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 326                                 samplerates, ARRAY_SIZE(samplerates),
 327                                 sizeof(uint64_t));
 328                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 329                 *data = g_variant_builder_end(&gvb);
 330                 break;
 331         default:
 332                 return SR_ERR_NA;
 333         }
 334
 335         return SR_OK;
 336 }
 337
 338 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 339 {
 340         int ret;
 341         struct dev_context *devc;
 342
 343         if (sdi->status != SR_ST_ACTIVE)
 344                 return SR_ERR_DEV_CLOSED;
 345
 346         devc = sdi->priv;
 347
 348         if (!devc->ftdic)
 349                 return SR_ERR_BUG;
 350
 351         /* TODO: Configure channels later (thresholds etc.). */
 352
 353         /* Properly reset internal variables before every new acquisition. */
 354         devc->compressed_bytes_ignored = 0;
 355         devc->samples_sent = 0;
 356         devc->bytes_received = 0;
 357
 358         if ((ret = scanaplus_init(devc)) < 0)
 359                 return ret;
 360
 361         if ((ret = scanaplus_start_acquisition(devc)) < 0)
 362                 return ret;
 363
 364         std_session_send_df_header(sdi, LOG_PREFIX);
 365
 366         /* Hook up a dummy handler to receive data from the device. */
 367         sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
 368
 369         return SR_OK;
 370 }
 371
 372 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 373 {
 374         sr_dbg("Stopping acquisition.");
 375         sr_session_source_remove(sdi->session, -1);
 376         std_session_send_df_end(sdi, LOG_PREFIX);
 377
 378         return SR_OK;
 379 }
 380
 381 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
 382         .name = "ikalogic-scanaplus",
 383         .longname = "IKALOGIC ScanaPLUS",
 384         .api_version = 1,
 385         .init = std_init,
 386         .cleanup = std_cleanup,
 387         .scan = scan,
 388         .dev_list = std_dev_list,
 389         .dev_clear = dev_clear,
 390         .config_get = config_get,
 391         .config_set = config_set,
 392         .config_list = config_list,
 393         .dev_open = dev_open,
 394         .dev_close = dev_close,
 395         .dev_acquisition_start = dev_acquisition_start,
 396         .dev_acquisition_stop = dev_acquisition_stop,
 397         .context = NULL,
 398 };