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_helper(void *priv)
 156 {
 157         struct dev_context *devc;
 158
 159         devc = priv;
 160
 161         libusb_free_transfer(devc->xfer_in);
 162         libusb_free_transfer(devc->xfer_out);
 163 }
 164
 165 static int dev_clear(const struct sr_dev_driver *di)
 166 {
 167         return std_dev_clear_with_callback(di, clear_helper);
 168 }
 169
 170 static int dev_open(struct sr_dev_inst *sdi)
 171 {
 172         struct sr_dev_driver *di = sdi->driver;
 173         struct drv_context *drvc = di->context;
 174         struct dev_context *devc;
 175         struct sr_usb_dev_inst *usb;
 176         uint8_t buffer[PACKET_LENGTH];
 177         int ret;
 178
 179         usb = sdi->conn;
 180         devc = sdi->priv;
 181
 182         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 183                 return SR_ERR;
 184
 185         /*
 186          * Determine if a kernel driver is active on this interface and, if so,
 187          * detach it.
 188          */
 189         if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
 190                 ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE);
 191                 if (ret < 0) {
 192                         sr_err("Failed to detach kernel driver: %s.",
 193                                 libusb_error_name(ret));
 194                         return SR_ERR;
 195                 }
 196         }
 197
 198         if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE)) < 0) {
 199                 sr_err("Failed to claim interface: %s.",
 200                         libusb_error_name(ret));
 201                 return SR_ERR;
 202         }
 203
 204         libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
 205                 devc->xfer_buf_in, sl2_receive_transfer_in,
 206                 sdi, USB_TIMEOUT_MS);
 207
 208         libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
 209                 devc->xfer_buf_out, sl2_receive_transfer_out,
 210                 sdi, USB_TIMEOUT_MS);
 211
 212         memset(buffer, 0, sizeof(buffer));
 213
 214         buffer[0] = CMD_RESET;
 215         if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
 216                 sr_err("Device reset failed: %s.", libusb_error_name(ret));
 217                 return SR_ERR;
 218         }
 219
 220         /*
 221          * Set the device to idle state. If the device is not in idle state it
 222          * possibly will reset itself after a few seconds without being used
 223          * and thereby close the connection.
 224          */
 225         buffer[0] = CMD_IDLE;
 226         if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
 227                 sr_err("Failed to set device in idle state: %s.",
 228                         libusb_error_name(ret));
 229                 return SR_ERR;
 230         }
 231
 232         return SR_OK;
 233 }
 234
 235 static int dev_close(struct sr_dev_inst *sdi)
 236 {
 237         struct sr_usb_dev_inst *usb;
 238
 239         usb = sdi->conn;
 240
 241         if (!usb->devhdl)
 242                 return SR_ERR_BUG;
 243
 244         libusb_release_interface(usb->devhdl, USB_INTERFACE);
 245         libusb_close(usb->devhdl);
 246
 247         usb->devhdl = NULL;
 248
 249         return SR_OK;
 250 }
 251
 252 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 253                 const struct sr_channel_group *cg)
 254 {
 255         struct dev_context *devc;
 256         int ret;
 257
 258         (void)cg;
 259
 260         ret = SR_OK;
 261         devc = sdi->priv;
 262
 263         switch (key) {
 264         case SR_CONF_SAMPLERATE:
 265                 *data = g_variant_new_uint64(devc->samplerate);
 266                 break;
 267         case SR_CONF_CAPTURE_RATIO:
 268                 *data = g_variant_new_uint64(devc->capture_ratio);
 269                 break;
 270         default:
 271                 return SR_ERR_NA;
 272         }
 273
 274         return ret;
 275 }
 276
 277 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 278                 const struct sr_channel_group *cg)
 279 {
 280         uint64_t samplerate, limit_samples, capture_ratio;
 281         int ret;
 282
 283         (void)cg;
 284
 285         switch (key) {
 286         case SR_CONF_LIMIT_SAMPLES:
 287                 limit_samples = g_variant_get_uint64(data);
 288                 ret = sl2_set_limit_samples(sdi, limit_samples);
 289                 break;
 290         case SR_CONF_SAMPLERATE:
 291                 samplerate = g_variant_get_uint64(data);
 292                 ret = sl2_set_samplerate(sdi, samplerate);
 293                 break;
 294         case SR_CONF_CAPTURE_RATIO:
 295                 capture_ratio = g_variant_get_uint64(data);
 296                 ret = sl2_set_capture_ratio(sdi, capture_ratio);
 297                 break;
 298         default:
 299                 return SR_ERR_NA;
 300         }
 301
 302         return ret;
 303 }
 304
 305 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 306                 const struct sr_channel_group *cg)
 307 {
 308         GVariant *gvar, *grange[2];
 309         GVariantBuilder gvb;
 310         int ret;
 311
 312         (void)sdi;
 313         (void)cg;
 314
 315         ret = SR_OK;
 316         switch (key) {
 317         case SR_CONF_DEVICE_OPTIONS:
 318                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 319                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 320                 break;
 321         case SR_CONF_SAMPLERATE:
 322                 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
 323                 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
 324                         sl2_samplerates, ARRAY_SIZE(sl2_samplerates),
 325                         sizeof(uint64_t));
 326                 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
 327                 *data = g_variant_builder_end(&gvb);
 328                 break;
 329         case SR_CONF_TRIGGER_MATCH:
 330                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 331                                 trigger_matches, ARRAY_SIZE(trigger_matches),
 332                                 sizeof(int32_t));
 333                 break;
 334         case SR_CONF_LIMIT_SAMPLES:
 335                 grange[0] = g_variant_new_uint64(0);
 336                 grange[1] = g_variant_new_uint64(MAX_SAMPLES);
 337                 *data = g_variant_new_tuple(grange, 2);
 338                 break;
 339         default:
 340                 return SR_ERR_NA;
 341         }
 342
 343         return ret;
 344 }
 345
 346 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 347 {
 348         struct sr_dev_driver *di = sdi->driver;
 349         struct drv_context *drvc;
 350         struct dev_context *devc;
 351         uint16_t trigger_bytes, tmp;
 352         unsigned int i, j;
 353         int ret;
 354
 355         devc = sdi->priv;
 356         drvc = di->context;
 357
 358         devc->wait_data_ready_locked = TRUE;
 359         devc->stopping_in_progress = FALSE;
 360         devc->transfer_error = FALSE;
 361         devc->samples_processed = 0;
 362         devc->channel = 0;
 363         devc->sample_packet = 0;
 364
 365         /*
 366          * The trigger must be configured first because the calculation of the
 367          * pre and post trigger samples depends on a configured trigger.
 368          */
 369         sl2_convert_trigger(sdi);
 370         sl2_calculate_trigger_samples(sdi);
 371
 372         trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
 373
 374         /* Calculate the number of expected sample packets. */
 375         devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
 376
 377         /* Round up the number of expected sample packets. */
 378         if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
 379                 devc->num_sample_packets++;
 380
 381         devc->num_enabled_channels = 0;
 382
 383         /*
 384          * Count the number of enabled channels and number them for a sequential
 385          * access.
 386          */
 387         for (i = 0, j = 0; i < NUM_CHANNELS; i++) {
 388                 if (devc->channels[i]->enabled) {
 389                         devc->num_enabled_channels++;
 390                         devc->channel_map[j] = i;
 391                         j++;
 392                 }
 393         }
 394
 395         sr_dbg("Number of enabled channels: %i.", devc->num_enabled_channels);
 396
 397         /* Set up the transfer buffer for the acquisition. */
 398         devc->xfer_data_out[0] = CMD_SAMPLE;
 399         devc->xfer_data_out[1] = 0x00;
 400
 401         tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
 402         memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
 403
 404         tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
 405         memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
 406
 407         devc->xfer_data_out[6] = devc->samplerate_id;
 408         devc->xfer_data_out[7] = devc->trigger_type;
 409         devc->xfer_data_out[8] = devc->trigger_channel;
 410         devc->xfer_data_out[9] = 0x00;
 411
 412         tmp = GUINT16_TO_LE(devc->after_trigger_delay);
 413         memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
 414
 415         if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
 416                 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
 417                 return SR_ERR;
 418         }
 419
 420         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 421                         ikalogic_scanalogic2_receive_data, (void *)sdi);
 422
 423         std_session_send_df_header(sdi);
 424
 425         devc->next_state = STATE_SAMPLE;
 426
 427         return SR_OK;
 428 }
 429
 430 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 431 {
 432         sdi->status = SR_ST_STOPPING;
 433
 434         return SR_OK;
 435 }
 436
 437 static struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
 438         .name = "ikalogic-scanalogic2",
 439         .longname = "IKALOGIC Scanalogic-2",
 440         .api_version = 1,
 441         .init = std_init,
 442         .cleanup = std_cleanup,
 443         .scan = scan,
 444         .dev_list = std_dev_list,
 445         .dev_clear = dev_clear,
 446         .config_get = config_get,
 447         .config_set = config_set,
 448         .config_list = config_list,
 449         .dev_open = dev_open,
 450         .dev_close = dev_close,
 451         .dev_acquisition_start = dev_acquisition_start,
 452         .dev_acquisition_stop = dev_acquisition_stop,
 453         .context = NULL,
 454 };
 455 SR_REGISTER_DEV_DRIVER(ikalogic_scanalogic2_driver_info);