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