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