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