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