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, void *cb_data);
  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 int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  69 {
  70         return std_init(sr_ctx, di, LOG_PREFIX);
  71 }
  72
  73 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  74 {
  75         struct sr_dev_inst *sdi;
  76         struct drv_context *drvc;
  77         struct dev_context *devc;
  78         GSList *devices;
  79         unsigned int i;
  80         int ret;
  81
  82         (void)options;
  83
  84         drvc = di->context;
  85
  86         devices = NULL;
  87
  88         /* Allocate memory for our private device context. */
  89         devc = g_malloc0(sizeof(struct dev_context));
  90
  91         /* Allocate memory for the incoming compressed samples. */
  92         if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
  93                 sr_err("compressed_buf malloc failed.");
  94                 goto err_free_devc;
  95         }
  96
  97         /* Allocate memory for the uncompressed samples. */
  98         if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
  99                 sr_err("sample_buf malloc failed.");
 100                 goto err_free_compressed_buf;
 101         }
 102
 103         /* Allocate memory for the FTDI context (ftdic) and initialize it. */
 104         if (!(devc->ftdic = ftdi_new())) {
 105                 sr_err("Failed to initialize libftdi.");
 106                 goto err_free_sample_buf;
 107         }
 108
 109         /* Check for the device and temporarily open it. */
 110         ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
 111                                  USB_IPRODUCT, NULL);
 112         if (ret < 0) {
 113                 /* Log errors, except for -3 ("device not found"). */
 114                 if (ret != -3)
 115                         sr_err("Failed to open device (%d): %s", ret,
 116                                ftdi_get_error_string(devc->ftdic));
 117                 goto err_free_ftdic;
 118         }
 119
 120         /* Register the device with libsigrok. */
 121         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 122         sdi->status = SR_ST_INITIALIZING;
 123         sdi->vendor = g_strdup(USB_VENDOR_NAME);
 124         sdi->model = g_strdup(USB_MODEL_NAME);
 125         sdi->driver = di;
 126         sdi->priv = devc;
 127
 128         for (i = 0; i < ARRAY_SIZE(channel_names); i++)
 129                 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
 130
 131         devices = g_slist_append(devices, sdi);
 132         drvc->instances = g_slist_append(drvc->instances, sdi);
 133
 134         /* Close device. We'll reopen it again when we need it. */
 135         scanaplus_close(devc);
 136
 137         return devices;
 138
 139         scanaplus_close(devc);
 140 err_free_ftdic:
 141         ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
 142 err_free_sample_buf:
 143         g_free(devc->sample_buf);
 144 err_free_compressed_buf:
 145         g_free(devc->compressed_buf);
 146 err_free_devc:
 147         g_free(devc);
 148
 149         return NULL;
 150 }
 151
 152 static GSList *dev_list(const struct sr_dev_driver *di)
 153 {
 154         return ((struct drv_context *)(di->context))->instances;
 155 }
 156
 157 static int dev_open(struct sr_dev_inst *sdi)
 158 {
 159         struct dev_context *devc;
 160         int ret;
 161
 162         devc = sdi->priv;
 163
 164         /* Select interface A, otherwise communication will fail. */
 165         ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
 166         if (ret < 0) {
 167                 sr_err("Failed to set FTDI interface A (%d): %s", ret,
 168                        ftdi_get_error_string(devc->ftdic));
 169                 return SR_ERR;
 170         }
 171         sr_dbg("FTDI chip interface A set successfully.");
 172
 173         /* Open the device. */
 174         ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
 175                                  USB_IPRODUCT, NULL);
 176         if (ret < 0) {
 177                 sr_err("Failed to open device (%d): %s", ret,
 178                        ftdi_get_error_string(devc->ftdic));
 179                 return SR_ERR;
 180         }
 181         sr_dbg("FTDI device opened successfully.");
 182
 183         /* Purge RX/TX buffers in the FTDI chip. */
 184         if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
 185                 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
 186                        ret, ftdi_get_error_string(devc->ftdic));
 187                 goto err_dev_open_close_ftdic;
 188         }
 189         sr_dbg("FTDI chip buffers purged successfully.");
 190
 191         /* Reset the FTDI bitmode. */
 192         ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
 193         if (ret < 0) {
 194                 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
 195                        ret, ftdi_get_error_string(devc->ftdic));
 196                 goto err_dev_open_close_ftdic;
 197         }
 198         sr_dbg("FTDI chip bitmode reset successfully.");
 199
 200         /* Set FTDI bitmode to "sync FIFO". */
 201         ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
 202         if (ret < 0) {
 203                 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
 204                        ret, ftdi_get_error_string(devc->ftdic));
 205                 goto err_dev_open_close_ftdic;
 206         }
 207         sr_dbg("FTDI chip sync FIFO mode entered successfully.");
 208
 209         /* Set the FTDI latency timer to 2. */
 210         ret = ftdi_set_latency_timer(devc->ftdic, 2);
 211         if (ret < 0) {
 212                 sr_err("Failed to set FTDI latency timer (%d): %s.",
 213                        ret, ftdi_get_error_string(devc->ftdic));
 214                 goto err_dev_open_close_ftdic;
 215         }
 216         sr_dbg("FTDI chip latency timer set successfully.");
 217
 218         /* Set the FTDI read data chunk size to 64kB. */
 219         ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
 220         if (ret < 0) {
 221                 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
 222                        ret, ftdi_get_error_string(devc->ftdic));
 223                 goto err_dev_open_close_ftdic;
 224         }
 225         sr_dbg("FTDI chip read data chunk size set successfully.");
 226
 227         /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
 228         if ((ret = scanaplus_get_device_id(devc)) < 0) {
 229                 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
 230                 goto err_dev_open_close_ftdic;
 231         }
 232         sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
 233                devc->devid[0], devc->devid[1], devc->devid[2]);
 234
 235         sdi->status = SR_ST_ACTIVE;
 236
 237         return SR_OK;
 238
 239 err_dev_open_close_ftdic:
 240         scanaplus_close(devc);
 241         return SR_ERR;
 242 }
 243
 244 static int dev_close(struct sr_dev_inst *sdi)
 245 {
 246         int ret;
 247         struct dev_context *devc;
 248
 249         ret = SR_OK;
 250         devc = sdi->priv;
 251
 252         if (sdi->status == SR_ST_ACTIVE) {
 253                 sr_dbg("Status ACTIVE, closing device.");
 254                 ret = scanaplus_close(devc);
 255         } else {
 256                 sr_spew("Status not ACTIVE, nothing to do.");
 257         }
 258
 259         sdi->status = SR_ST_INACTIVE;
 260
 261         return ret;
 262 }
 263
 264 static int cleanup(const struct sr_dev_driver *di)
 265 {
 266         return dev_clear(di);
 267 }
 268
 269 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 270                 const struct sr_channel_group *cg)
 271 {
 272         (void)sdi;
 273         (void)cg;
 274
 275         switch (key) {
 276         case SR_CONF_SAMPLERATE:
 277                 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
 278                 *data = g_variant_new_uint64(SR_MHZ(100));
 279                 break;
 280         default:
 281                 return SR_ERR_NA;
 282         }
 283
 284         return SR_OK;
 285 }
 286
 287 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 288                 const struct sr_channel_group *cg)
 289 {
 290         struct dev_context *devc;
 291
 292         (void)cg;
 293
 294         if (sdi->status != SR_ST_ACTIVE)
 295                 return SR_ERR_DEV_CLOSED;
 296
 297         devc = sdi->priv;
 298
 299         switch (key) {
 300         case SR_CONF_SAMPLERATE:
 301                 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
 302                         sr_err("ScanaPLUS only supports samplerate = 100MHz.");
 303                         return SR_ERR_ARG;
 304                 }
 305                 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
 306                 break;
 307         case SR_CONF_LIMIT_MSEC:
 308                 if (g_variant_get_uint64(data) == 0)
 309                         return SR_ERR_ARG;
 310                 devc->limit_msec = g_variant_get_uint64(data);
 311                 break;
 312         case SR_CONF_LIMIT_SAMPLES:
 313                 if (g_variant_get_uint64(data) == 0)
 314                         return SR_ERR_ARG;
 315                 devc->limit_samples = g_variant_get_uint64(data);
 316                 break;
 317         default:
 318                 return SR_ERR_NA;
 319         }
 320
 321         return SR_OK;
 322 }
 323
 324 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 325                 const struct sr_channel_group *cg)
 326 {
 327         GVariant *gvar;
 328         GVariantBuilder gvb;
 329
 330         (void)sdi;
 331         (void)cg;
 332
 333         switch (key) {
 334         case SR_CONF_DEVICE_OPTIONS:
 335                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 336                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 337                 break;
 338         case SR_CONF_SAMPLERATE:
 339                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 340                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 341                                 samplerates, ARRAY_SIZE(samplerates),
 342                                 sizeof(uint64_t));
 343                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 344                 *data = g_variant_builder_end(&gvb);
 345                 break;
 346         default:
 347                 return SR_ERR_NA;
 348         }
 349
 350         return SR_OK;
 351 }
 352
 353 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 354 {
 355         int ret;
 356         struct dev_context *devc;
 357
 358         if (sdi->status != SR_ST_ACTIVE)
 359                 return SR_ERR_DEV_CLOSED;
 360
 361         if (!(devc = sdi->priv))
 362                 return SR_ERR_BUG;
 363
 364         if (!devc->ftdic)
 365                 return SR_ERR_BUG;
 366
 367         /* TODO: Configure channels later (thresholds etc.). */
 368
 369         devc->cb_data = cb_data;
 370
 371         /* Properly reset internal variables before every new acquisition. */
 372         devc->compressed_bytes_ignored = 0;
 373         devc->samples_sent = 0;
 374         devc->bytes_received = 0;
 375
 376         if ((ret = scanaplus_init(devc)) < 0)
 377                 return ret;
 378
 379         if ((ret = scanaplus_start_acquisition(devc)) < 0)
 380                 return ret;
 381
 382         std_session_send_df_header(sdi, LOG_PREFIX);
 383
 384         /* Hook up a dummy handler to receive data from the device. */
 385         sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
 386
 387         return SR_OK;
 388 }
 389
 390 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 391 {
 392         (void)cb_data;
 393
 394         sr_dbg("Stopping acquisition.");
 395         sr_session_source_remove(sdi->session, -1);
 396         std_session_send_df_end(sdi, LOG_PREFIX);
 397
 398         return SR_OK;
 399 }
 400
 401 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
 402         .name = "ikalogic-scanaplus",
 403         .longname = "IKALOGIC ScanaPLUS",
 404         .api_version = 1,
 405         .init = init,
 406         .cleanup = cleanup,
 407         .scan = scan,
 408         .dev_list = dev_list,
 409         .dev_clear = dev_clear,
 410         .config_get = config_get,
 411         .config_set = config_set,
 412         .config_list = config_list,
 413         .dev_open = dev_open,
 414         .dev_close = dev_close,
 415         .dev_acquisition_start = dev_acquisition_start,
 416         .dev_acquisition_stop = dev_acquisition_stop,
 417         .context = NULL,
 418 };