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