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