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