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