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