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