2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Marc Schink <sigrok-dev@marcschink.de>
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.
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.
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/>.
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,
31 static const int32_t trigger_matches[] = {
37 SR_PRIV const uint64_t sl2_samplerates[NUM_SAMPLERATES] = {
51 static const char *channel_names[] = {
55 static GSList *scan(struct sr_dev_driver *di, GSList *options)
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;
71 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_VID_PID);
76 for (l = usb_devices; l; l = l->next) {
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);
85 devc = g_malloc0(sizeof(struct dev_context));
87 if (!(devc->xfer_in = libusb_alloc_transfer(0))) {
88 sr_err("Transfer malloc failed.");
89 sr_usb_dev_inst_free(usb);
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);
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);
110 sdi->inst_type = SR_INST_USB;
113 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
114 devc->channels[i] = sr_channel_new(sdi, i,
115 SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
117 devc->state = STATE_IDLE;
118 devc->next_state = STATE_IDLE;
120 /* Set default samplerate. */
121 sl2_set_samplerate(sdi, DEFAULT_SAMPLERATE);
123 /* Set default capture ratio. */
124 devc->capture_ratio = 0;
126 /* Set default after trigger delay. */
127 devc->after_trigger_delay = 0;
129 memset(devc->xfer_buf_in, 0, LIBUSB_CONTROL_SETUP_SIZE +
131 memset(devc->xfer_buf_out, 0, LIBUSB_CONTROL_SETUP_SIZE +
134 libusb_fill_control_setup(devc->xfer_buf_in,
135 USB_REQUEST_TYPE_IN, USB_HID_GET_REPORT,
136 USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
138 libusb_fill_control_setup(devc->xfer_buf_out,
139 USB_REQUEST_TYPE_OUT, USB_HID_SET_REPORT,
140 USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
143 devc->xfer_data_in = devc->xfer_buf_in +
144 LIBUSB_CONTROL_SETUP_SIZE;
145 devc->xfer_data_out = devc->xfer_buf_out +
146 LIBUSB_CONTROL_SETUP_SIZE;
148 drvc->instances = g_slist_append(drvc->instances, sdi);
149 devices = g_slist_append(devices, sdi);
152 g_slist_free(usb_devices);
157 static void clear_dev_context(void *priv)
159 struct dev_context *devc;
163 sr_dbg("Device context cleared.");
165 libusb_free_transfer(devc->xfer_in);
166 libusb_free_transfer(devc->xfer_out);
170 static int dev_clear(const struct sr_dev_driver *di)
172 return std_dev_clear(di, &clear_dev_context);
175 static int dev_open(struct sr_dev_inst *sdi)
177 struct sr_dev_driver *di = sdi->driver;
178 struct drv_context *drvc = di->context;
179 struct dev_context *devc;
180 struct sr_usb_dev_inst *usb;
181 uint8_t buffer[PACKET_LENGTH];
187 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
191 * Determine if a kernel driver is active on this interface and, if so,
194 if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
195 ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE);
197 sr_err("Failed to detach kernel driver: %s.",
198 libusb_error_name(ret));
203 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE)) < 0) {
204 sr_err("Failed to claim interface: %s.",
205 libusb_error_name(ret));
209 libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
210 devc->xfer_buf_in, sl2_receive_transfer_in,
211 sdi, USB_TIMEOUT_MS);
213 libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
214 devc->xfer_buf_out, sl2_receive_transfer_out,
215 sdi, USB_TIMEOUT_MS);
217 memset(buffer, 0, sizeof(buffer));
219 buffer[0] = CMD_RESET;
220 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
221 sr_err("Device reset failed: %s.", libusb_error_name(ret));
226 * Set the device to idle state. If the device is not in idle state it
227 * possibly will reset itself after a few seconds without being used
228 * and thereby close the connection.
230 buffer[0] = CMD_IDLE;
231 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
232 sr_err("Failed to set device in idle state: %s.",
233 libusb_error_name(ret));
237 sdi->status = SR_ST_ACTIVE;
242 static int dev_close(struct sr_dev_inst *sdi)
244 struct sr_usb_dev_inst *usb;
251 libusb_release_interface(usb->devhdl, USB_INTERFACE);
252 libusb_close(usb->devhdl);
255 sdi->status = SR_ST_INACTIVE;
260 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
261 const struct sr_channel_group *cg)
263 struct dev_context *devc;
272 case SR_CONF_SAMPLERATE:
273 *data = g_variant_new_uint64(devc->samplerate);
275 case SR_CONF_CAPTURE_RATIO:
276 *data = g_variant_new_uint64(devc->capture_ratio);
285 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
286 const struct sr_channel_group *cg)
288 uint64_t samplerate, limit_samples, capture_ratio;
293 if (sdi->status != SR_ST_ACTIVE)
294 return SR_ERR_DEV_CLOSED;
297 case SR_CONF_LIMIT_SAMPLES:
298 limit_samples = g_variant_get_uint64(data);
299 ret = sl2_set_limit_samples(sdi, limit_samples);
301 case SR_CONF_SAMPLERATE:
302 samplerate = g_variant_get_uint64(data);
303 ret = sl2_set_samplerate(sdi, samplerate);
305 case SR_CONF_CAPTURE_RATIO:
306 capture_ratio = g_variant_get_uint64(data);
307 ret = sl2_set_capture_ratio(sdi, capture_ratio);
316 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
317 const struct sr_channel_group *cg)
319 GVariant *gvar, *grange[2];
328 case SR_CONF_DEVICE_OPTIONS:
329 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
330 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
332 case SR_CONF_SAMPLERATE:
333 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
334 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
335 sl2_samplerates, ARRAY_SIZE(sl2_samplerates),
337 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
338 *data = g_variant_builder_end(&gvb);
340 case SR_CONF_TRIGGER_MATCH:
341 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
342 trigger_matches, ARRAY_SIZE(trigger_matches),
345 case SR_CONF_LIMIT_SAMPLES:
346 grange[0] = g_variant_new_uint64(0);
347 grange[1] = g_variant_new_uint64(MAX_SAMPLES);
348 *data = g_variant_new_tuple(grange, 2);
357 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
359 struct sr_dev_driver *di = sdi->driver;
360 struct drv_context *drvc;
361 struct dev_context *devc;
362 uint16_t trigger_bytes, tmp;
366 if (sdi->status != SR_ST_ACTIVE)
367 return SR_ERR_DEV_CLOSED;
372 devc->wait_data_ready_locked = TRUE;
373 devc->stopping_in_progress = FALSE;
374 devc->transfer_error = FALSE;
375 devc->samples_processed = 0;
377 devc->sample_packet = 0;
380 * The trigger must be configured first because the calculation of the
381 * pre and post trigger samples depends on a configured trigger.
383 sl2_convert_trigger(sdi);
384 sl2_calculate_trigger_samples(sdi);
386 trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
388 /* Calculate the number of expected sample packets. */
389 devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
391 /* Round up the number of expected sample packets. */
392 if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
393 devc->num_sample_packets++;
395 devc->num_enabled_channels = 0;
398 * Count the number of enabled channels and number them for a sequential
401 for (i = 0, j = 0; i < NUM_CHANNELS; i++) {
402 if (devc->channels[i]->enabled) {
403 devc->num_enabled_channels++;
404 devc->channel_map[j] = i;
409 sr_dbg("Number of enabled channels: %i.", devc->num_enabled_channels);
411 /* Set up the transfer buffer for the acquisition. */
412 devc->xfer_data_out[0] = CMD_SAMPLE;
413 devc->xfer_data_out[1] = 0x00;
415 tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
416 memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
418 tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
419 memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
421 devc->xfer_data_out[6] = devc->samplerate_id;
422 devc->xfer_data_out[7] = devc->trigger_type;
423 devc->xfer_data_out[8] = devc->trigger_channel;
424 devc->xfer_data_out[9] = 0x00;
426 tmp = GUINT16_TO_LE(devc->after_trigger_delay);
427 memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
429 if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
430 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
434 usb_source_add(sdi->session, drvc->sr_ctx, 100,
435 ikalogic_scanalogic2_receive_data, (void *)sdi);
437 sr_dbg("Acquisition started successfully.");
439 std_session_send_df_header(sdi, LOG_PREFIX);
441 devc->next_state = STATE_SAMPLE;
446 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
448 if (sdi->status != SR_ST_ACTIVE)
449 return SR_ERR_DEV_CLOSED;
451 sr_dbg("Stopping acquisition.");
453 sdi->status = SR_ST_STOPPING;
458 static struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
459 .name = "ikalogic-scanalogic2",
460 .longname = "IKALOGIC Scanalogic-2",
463 .cleanup = std_cleanup,
465 .dev_list = std_dev_list,
466 .dev_clear = dev_clear,
467 .config_get = config_get,
468 .config_set = config_set,
469 .config_list = config_list,
470 .dev_open = dev_open,
471 .dev_close = dev_close,
472 .dev_acquisition_start = dev_acquisition_start,
473 .dev_acquisition_stop = dev_acquisition_stop,
476 SR_REGISTER_DEV_DRIVER(ikalogic_scanalogic2_driver_info);