src/hardware/ikalogic-scanalogic2/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Marc Schink <sigrok-dev@marcschink.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 3 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 static const uint32_t devopts[] = {
  24         SR_CONF_LOGIC_ANALYZER,
  25         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
  26         SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  27         SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
  28         SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
  29 };
  30
  31 static const int32_t trigger_matches[] = {
  32         SR_TRIGGER_RISING,
  33         SR_TRIGGER_FALLING,
  34         SR_TRIGGER_EDGE,
  35 };
  36
  37 SR_PRIV const uint64_t sl2_samplerates[NUM_SAMPLERATES] = {
  38         SR_KHZ(1.25),
  39         SR_KHZ(10),
  40         SR_KHZ(50),
  41         SR_KHZ(100),
  42         SR_KHZ(250),
  43         SR_KHZ(500),
  44         SR_MHZ(1),
  45         SR_MHZ(2.5),
  46         SR_MHZ(5),
  47         SR_MHZ(10),
  48         SR_MHZ(20),
  49 };
  50
  51 static const char *channel_names[] = {
  52         "0", "1", "2", "3",
  53 };
  54
  55 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  56 {
  57         GSList *usb_devices, *devices, *l;
  58         struct drv_context *drvc;
  59         struct sr_dev_inst *sdi;
  60         struct dev_context *devc;
  61         struct sr_usb_dev_inst *usb;
  62         struct device_info dev_info;
  63         unsigned int i;
  64         int ret;
  65
  66         (void)options;
  67
  68         devices = NULL;
  69         drvc = di->context;
  70
  71         usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_VID_PID);
  72
  73         if (!usb_devices)
  74                 return NULL;
  75
  76         for (l = usb_devices; l; l = l->next) {
  77                 usb = l->data;
  78
  79                 if ((ret = sl2_get_device_info(di, *usb, &dev_info)) < 0) {
  80                         sr_warn("Failed to get device information: %d.", ret);
  81                         sr_usb_dev_inst_free(usb);
  82                         continue;
  83                 }
  84
  85                 devc = g_malloc0(sizeof(struct dev_context));
  86
  87                 if (!(devc->xfer_in = libusb_alloc_transfer(0))) {
  88                         sr_err("Transfer malloc failed.");
  89                         sr_usb_dev_inst_free(usb);
  90                         g_free(devc);
  91                         continue;
  92                 }
  93
  94                 if (!(devc->xfer_out = libusb_alloc_transfer(0))) {
  95                         sr_err("Transfer malloc failed.");
  96                         sr_usb_dev_inst_free(usb);
  97                         libusb_free_transfer(devc->xfer_in);
  98                         g_free(devc);
  99                         continue;
 100                 }
 101
 102                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 103                 sdi->status = SR_ST_INACTIVE;
 104                 sdi->vendor = g_strdup(VENDOR_NAME);
 105                 sdi->model = g_strdup(MODEL_NAME);
 106                 sdi->version = g_strdup_printf("%u.%u", dev_info.fw_ver_major, dev_info.fw_ver_minor);
 107                 sdi->serial_num = g_strdup_printf("%d", dev_info.serial);
 108                 sdi->priv = devc;
 109                 sdi->inst_type = SR_INST_USB;
 110                 sdi->conn = usb;
 111
 112                 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
 113                         devc->channels[i] = sr_channel_new(sdi, i,
 114                                 SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
 115
 116                 devc->state = STATE_IDLE;
 117                 devc->next_state = STATE_IDLE;
 118
 119                 /* Set default samplerate. */
 120                 sl2_set_samplerate(sdi, DEFAULT_SAMPLERATE);
 121
 122                 /* Set default capture ratio. */
 123                 devc->capture_ratio = 0;
 124
 125                 /* Set default after trigger delay. */
 126                 devc->after_trigger_delay = 0;
 127
 128                 memset(devc->xfer_buf_in, 0, LIBUSB_CONTROL_SETUP_SIZE +
 129                         PACKET_LENGTH);
 130                 memset(devc->xfer_buf_out, 0, LIBUSB_CONTROL_SETUP_SIZE +
 131                         PACKET_LENGTH);
 132
 133                 libusb_fill_control_setup(devc->xfer_buf_in,
 134                         USB_REQUEST_TYPE_IN, USB_HID_GET_REPORT,
 135                         USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
 136                         PACKET_LENGTH);
 137                 libusb_fill_control_setup(devc->xfer_buf_out,
 138                         USB_REQUEST_TYPE_OUT, USB_HID_SET_REPORT,
 139                         USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
 140                         PACKET_LENGTH);
 141
 142                 devc->xfer_data_in = devc->xfer_buf_in +
 143                         LIBUSB_CONTROL_SETUP_SIZE;
 144                 devc->xfer_data_out = devc->xfer_buf_out +
 145                         LIBUSB_CONTROL_SETUP_SIZE;
 146
 147                 devices = g_slist_append(devices, sdi);
 148         }
 149
 150         g_slist_free(usb_devices);
 151
 152         return std_scan_complete(di, devices);
 153 }
 154
 155 static void clear_dev_context(void *priv)
 156 {
 157         struct dev_context *devc;
 158
 159         devc = priv;
 160
 161         sr_dbg("Device context cleared.");
 162
 163         libusb_free_transfer(devc->xfer_in);
 164         libusb_free_transfer(devc->xfer_out);
 165         g_free(devc);
 166 }
 167
 168 static int dev_clear(const struct sr_dev_driver *di)
 169 {
 170         return std_dev_clear(di, &clear_dev_context);
 171 }
 172
 173 static int dev_open(struct sr_dev_inst *sdi)
 174 {
 175         struct sr_dev_driver *di = sdi->driver;
 176         struct drv_context *drvc = di->context;
 177         struct dev_context *devc;
 178         struct sr_usb_dev_inst *usb;
 179         uint8_t buffer[PACKET_LENGTH];
 180         int ret;
 181
 182         usb = sdi->conn;
 183         devc = sdi->priv;
 184
 185         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 186                 return SR_ERR;
 187
 188         /*
 189          * Determine if a kernel driver is active on this interface and, if so,
 190          * detach it.
 191          */
 192         if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
 193                 ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE);
 194                 if (ret < 0) {
 195                         sr_err("Failed to detach kernel driver: %s.",
 196                                 libusb_error_name(ret));
 197                         return SR_ERR;
 198                 }
 199         }
 200
 201         if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE)) < 0) {
 202                 sr_err("Failed to claim interface: %s.",
 203                         libusb_error_name(ret));
 204                 return SR_ERR;
 205         }
 206
 207         libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
 208                 devc->xfer_buf_in, sl2_receive_transfer_in,
 209                 sdi, USB_TIMEOUT_MS);
 210
 211         libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
 212                 devc->xfer_buf_out, sl2_receive_transfer_out,
 213                 sdi, USB_TIMEOUT_MS);
 214
 215         memset(buffer, 0, sizeof(buffer));
 216
 217         buffer[0] = CMD_RESET;
 218         if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
 219                 sr_err("Device reset failed: %s.", libusb_error_name(ret));
 220                 return SR_ERR;
 221         }
 222
 223         /*
 224          * Set the device to idle state. If the device is not in idle state it
 225          * possibly will reset itself after a few seconds without being used
 226          * and thereby close the connection.
 227          */
 228         buffer[0] = CMD_IDLE;
 229         if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
 230                 sr_err("Failed to set device in idle state: %s.",
 231                         libusb_error_name(ret));
 232                 return SR_ERR;
 233         }
 234
 235         return SR_OK;
 236 }
 237
 238 static int dev_close(struct sr_dev_inst *sdi)
 239 {
 240         struct sr_usb_dev_inst *usb;
 241
 242         usb = sdi->conn;
 243
 244         if (!usb->devhdl)
 245                 return SR_ERR_BUG;
 246
 247         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 248         libusb_close(usb->devhdl);
 249
 250         usb->devhdl = NULL;
 251
 252         return SR_OK;
 253 }
 254
 255 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 256                 const struct sr_channel_group *cg)
 257 {
 258         struct dev_context *devc;
 259         int ret;
 260
 261         (void)cg;
 262
 263         ret = SR_OK;
 264         devc = sdi->priv;
 265
 266         switch (key) {
 267         case SR_CONF_SAMPLERATE:
 268                 *data = g_variant_new_uint64(devc->samplerate);
 269                 break;
 270         case SR_CONF_CAPTURE_RATIO:
 271                 *data = g_variant_new_uint64(devc->capture_ratio);
 272                 break;
 273         default:
 274                 return SR_ERR_NA;
 275         }
 276
 277         return ret;
 278 }
 279
 280 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 281                 const struct sr_channel_group *cg)
 282 {
 283         uint64_t samplerate, limit_samples, capture_ratio;
 284         int ret;
 285
 286         (void)cg;
 287
 288         switch (key) {
 289         case SR_CONF_LIMIT_SAMPLES:
 290                 limit_samples = g_variant_get_uint64(data);
 291                 ret = sl2_set_limit_samples(sdi, limit_samples);
 292                 break;
 293         case SR_CONF_SAMPLERATE:
 294                 samplerate = g_variant_get_uint64(data);
 295                 ret = sl2_set_samplerate(sdi, samplerate);
 296                 break;
 297         case SR_CONF_CAPTURE_RATIO:
 298                 capture_ratio = g_variant_get_uint64(data);
 299                 ret = sl2_set_capture_ratio(sdi, capture_ratio);
 300                 break;
 301         default:
 302                 return SR_ERR_NA;
 303         }
 304
 305         return ret;
 306 }
 307
 308 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 309                 const struct sr_channel_group *cg)
 310 {
 311         GVariant *gvar, *grange[2];
 312         GVariantBuilder gvb;
 313         int ret;
 314
 315         (void)sdi;
 316         (void)cg;
 317
 318         ret = SR_OK;
 319         switch (key) {
 320         case SR_CONF_DEVICE_OPTIONS:
 321                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 322                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 323                 break;
 324         case SR_CONF_SAMPLERATE:
 325                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 326                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 327                         sl2_samplerates, ARRAY_SIZE(sl2_samplerates),
 328                         sizeof(uint64_t));
 329                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 330                 *data = g_variant_builder_end(&gvb);
 331                 break;
 332         case SR_CONF_TRIGGER_MATCH:
 333                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 334                                 trigger_matches, ARRAY_SIZE(trigger_matches),
 335                                 sizeof(int32_t));
 336                 break;
 337         case SR_CONF_LIMIT_SAMPLES:
 338                 grange[0] = g_variant_new_uint64(0);
 339                 grange[1] = g_variant_new_uint64(MAX_SAMPLES);
 340                 *data = g_variant_new_tuple(grange, 2);
 341                 break;
 342         default:
 343                 return SR_ERR_NA;
 344         }
 345
 346         return ret;
 347 }
 348
 349 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 350 {
 351         struct sr_dev_driver *di = sdi->driver;
 352         struct drv_context *drvc;
 353         struct dev_context *devc;
 354         uint16_t trigger_bytes, tmp;
 355         unsigned int i, j;
 356         int ret;
 357
 358         devc = sdi->priv;
 359         drvc = di->context;
 360
 361         devc->wait_data_ready_locked = TRUE;
 362         devc->stopping_in_progress = FALSE;
 363         devc->transfer_error = FALSE;
 364         devc->samples_processed = 0;
 365         devc->channel = 0;
 366         devc->sample_packet = 0;
 367
 368         /*
 369          * The trigger must be configured first because the calculation of the
 370          * pre and post trigger samples depends on a configured trigger.
 371          */
 372         sl2_convert_trigger(sdi);
 373         sl2_calculate_trigger_samples(sdi);
 374
 375         trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
 376
 377         /* Calculate the number of expected sample packets. */
 378         devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
 379
 380         /* Round up the number of expected sample packets. */
 381         if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
 382                 devc->num_sample_packets++;
 383
 384         devc->num_enabled_channels = 0;
 385
 386         /*
 387          * Count the number of enabled channels and number them for a sequential
 388          * access.
 389          */
 390         for (i = 0, j = 0; i < NUM_CHANNELS; i++) {
 391                 if (devc->channels[i]->enabled) {
 392                         devc->num_enabled_channels++;
 393                         devc->channel_map[j] = i;
 394                         j++;
 395                 }
 396         }
 397
 398         sr_dbg("Number of enabled channels: %i.", devc->num_enabled_channels);
 399
 400         /* Set up the transfer buffer for the acquisition. */
 401         devc->xfer_data_out[0] = CMD_SAMPLE;
 402         devc->xfer_data_out[1] = 0x00;
 403
 404         tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
 405         memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
 406
 407         tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
 408         memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
 409
 410         devc->xfer_data_out[6] = devc->samplerate_id;
 411         devc->xfer_data_out[7] = devc->trigger_type;
 412         devc->xfer_data_out[8] = devc->trigger_channel;
 413         devc->xfer_data_out[9] = 0x00;
 414
 415         tmp = GUINT16_TO_LE(devc->after_trigger_delay);
 416         memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
 417
 418         if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
 419                 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
 420                 return SR_ERR;
 421         }
 422
 423         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 424                         ikalogic_scanalogic2_receive_data, (void *)sdi);
 425
 426         sr_dbg("Acquisition started successfully.");
 427
 428         std_session_send_df_header(sdi);
 429
 430         devc->next_state = STATE_SAMPLE;
 431
 432         return SR_OK;
 433 }
 434
 435 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 436 {
 437         sdi->status = SR_ST_STOPPING;
 438
 439         return SR_OK;
 440 }
 441
 442 static struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
 443         .name = "ikalogic-scanalogic2",
 444         .longname = "IKALOGIC Scanalogic-2",
 445         .api_version = 1,
 446         .init = std_init,
 447         .cleanup = std_cleanup,
 448         .scan = scan,
 449         .dev_list = std_dev_list,
 450         .dev_clear = dev_clear,
 451         .config_get = config_get,
 452         .config_set = config_set,
 453         .config_list = config_list,
 454         .dev_open = dev_open,
 455         .dev_close = dev_close,
 456         .dev_acquisition_start = dev_acquisition_start,
 457         .dev_acquisition_stop = dev_acquisition_stop,
 458         .context = NULL,
 459 };
 460 SR_REGISTER_DEV_DRIVER(ikalogic_scanalogic2_driver_info);