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/>.
22 static const int hwcaps[] = {
23 SR_CONF_LOGIC_ANALYZER,
25 SR_CONF_LIMIT_SAMPLES,
27 SR_CONF_CAPTURE_RATIO,
30 SR_PRIV const uint64_t ikalogic_scanalogic2_samplerates[NUM_SAMPLERATES] = {
44 static const char *probe_names[NUM_PROBES + 1] = {
49 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
50 static struct sr_dev_driver *di = &ikalogic_scanalogic2_driver_info;
52 static int init(struct sr_context *sr_ctx)
54 return std_init(sr_ctx, di, LOG_PREFIX);
57 static GSList *scan(GSList *options)
59 GSList *usb_devices, *devices, *l;
60 struct drv_context *drvc;
61 struct sr_dev_inst *sdi;
62 struct sr_probe *probe;
63 struct dev_context *devc;
64 struct sr_usb_dev_inst *usb;
65 struct device_info dev_info;
66 int ret, device_index, i;
73 drvc->instances = NULL;
76 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_VID_PID);
78 if (usb_devices == NULL)
81 for (l = usb_devices; l; l = l->next) {
84 ret = ikalogic_scanalogic2_get_device_info(*usb, &dev_info);
86 sr_warn("Failed to get device information.");
87 sr_usb_dev_inst_free(usb);
91 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
92 sr_err("Device instance malloc failed.");
93 sr_usb_dev_inst_free(usb);
97 if (!(devc->xfer_in = libusb_alloc_transfer(0))) {
98 sr_err("Transfer malloc failed.");
99 sr_usb_dev_inst_free(usb);
104 if (!(devc->xfer_out = libusb_alloc_transfer(0))) {
105 sr_err("Transfer malloc failed.");
106 sr_usb_dev_inst_free(usb);
107 libusb_free_transfer(devc->xfer_in);
112 fw_ver_str = g_strdup_printf("%u.%u", dev_info.fw_ver_major,
113 dev_info.fw_ver_minor);
115 sr_err("Firmware string malloc failed.");
116 sr_usb_dev_inst_free(usb);
117 libusb_free_transfer(devc->xfer_in);
118 libusb_free_transfer(devc->xfer_out);
123 sdi = sr_dev_inst_new(device_index, SR_ST_INACTIVE, VENDOR_NAME,
124 MODEL_NAME, fw_ver_str);
127 sr_err("sr_dev_inst_new failed.");
128 sr_usb_dev_inst_free(usb);
129 libusb_free_transfer(devc->xfer_in);
130 libusb_free_transfer(devc->xfer_out);
137 sdi->inst_type = SR_INST_USB;
140 for (i = 0; probe_names[i]; i++) {
141 probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
143 sdi->probes = g_slist_append(sdi->probes, probe);
144 devc->probes[i] = probe;
147 devc->state = STATE_IDLE;
148 devc->next_state = STATE_IDLE;
150 /* Set default samplerate. */
151 ikalogic_scanalogic2_set_samplerate(sdi, DEFAULT_SAMPLERATE);
153 /* Set default capture ratio. */
154 devc->capture_ratio = 0;
156 /* Set default after trigger delay. */
157 devc->after_trigger_delay = 0;
159 memset(devc->xfer_buf_in, 0, LIBUSB_CONTROL_SETUP_SIZE +
161 memset(devc->xfer_buf_out, 0, LIBUSB_CONTROL_SETUP_SIZE +
164 libusb_fill_control_setup(devc->xfer_buf_in,
165 USB_REQUEST_TYPE_IN, USB_HID_SET_REPORT,
166 USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
168 libusb_fill_control_setup(devc->xfer_buf_out,
169 USB_REQUEST_TYPE_OUT, USB_HID_SET_REPORT,
170 USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
173 devc->xfer_data_in = devc->xfer_buf_in +
174 LIBUSB_CONTROL_SETUP_SIZE;
175 devc->xfer_data_out = devc->xfer_buf_out +
176 LIBUSB_CONTROL_SETUP_SIZE;
178 drvc->instances = g_slist_append(drvc->instances, sdi);
179 devices = g_slist_append(devices, sdi);
184 g_slist_free(usb_devices);
189 static GSList *dev_list(void)
191 return ((struct drv_context *)(di->priv))->instances;
194 static void clear_dev_context(void *priv)
196 struct dev_context *devc;
200 sr_dbg("Device context cleared.");
202 libusb_free_transfer(devc->xfer_in);
203 libusb_free_transfer(devc->xfer_out);
207 static int dev_clear(void)
209 return std_dev_clear(di, &clear_dev_context);
212 static int dev_open(struct sr_dev_inst *sdi)
214 struct drv_context *drvc;
215 struct dev_context *devc;
216 struct sr_usb_dev_inst *usb;
217 uint8_t buffer[PACKET_LENGTH];
220 if (!(drvc = di->priv)) {
221 sr_err("Driver was not initialized.");
228 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
232 * Determine if a kernel driver is active on this interface and, if so,
235 if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
236 ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE);
238 sr_err("Failed to detach kernel driver: %i.",
239 libusb_error_name(ret));
244 ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
246 sr_err("Failed to claim interface: %s.",
247 libusb_error_name(ret));
251 libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
252 devc->xfer_buf_in, ikalogic_scanalogic2_receive_transfer_in,
255 libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
256 devc->xfer_buf_out, ikalogic_scanalogic2_receive_transfer_out,
259 memset(buffer, 0, sizeof(buffer));
261 buffer[0] = CMD_RESET;
262 ret = ikalogic_scanalogic2_transfer_out(usb->devhdl, buffer);
263 if (ret != PACKET_LENGTH) {
264 sr_err("Device reset failed: %s.", libusb_error_name(ret));
269 * Set the device to idle state. If the device is not in idle state it
270 * possibly will reset itself after a few seconds without being used
271 * and thereby close the connection.
273 buffer[0] = CMD_IDLE;
274 ret = ikalogic_scanalogic2_transfer_out(usb->devhdl, buffer);
275 if (ret != PACKET_LENGTH) {
276 sr_err("Failed to set device in idle state: %s.",
277 libusb_error_name(ret));
281 sdi->status = SR_ST_ACTIVE;
286 static int dev_close(struct sr_dev_inst *sdi)
288 struct sr_usb_dev_inst *usb;
291 sr_err("Driver was not initialized.");
300 libusb_release_interface(usb->devhdl, USB_INTERFACE);
301 libusb_close(usb->devhdl);
304 sdi->status = SR_ST_INACTIVE;
309 static int cleanup(void)
314 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
316 struct dev_context *devc;
323 case SR_CONF_SAMPLERATE:
324 *data = g_variant_new_uint64(devc->samplerate);
326 case SR_CONF_CAPTURE_RATIO:
327 *data = g_variant_new_uint64(devc->capture_ratio);
336 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
338 uint64_t samplerate, limit_samples, capture_ratio;
341 if (sdi->status != SR_ST_ACTIVE)
342 return SR_ERR_DEV_CLOSED;
347 case SR_CONF_LIMIT_SAMPLES:
348 limit_samples = g_variant_get_uint64(data);
349 ret = ikalogic_scanalogic2_set_limit_samples(sdi,
352 case SR_CONF_SAMPLERATE:
353 samplerate = g_variant_get_uint64(data);
354 ret = ikalogic_scanalogic2_set_samplerate(sdi, samplerate);
356 case SR_CONF_CAPTURE_RATIO:
357 capture_ratio = g_variant_get_uint64(data);
358 ret = ikalogic_scanalogic2_set_capture_ratio(sdi,
368 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
379 case SR_CONF_DEVICE_OPTIONS:
380 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, hwcaps,
381 ARRAY_SIZE(hwcaps), sizeof(int32_t));
383 case SR_CONF_SAMPLERATE:
384 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
385 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
386 ikalogic_scanalogic2_samplerates,
387 ARRAY_SIZE(ikalogic_scanalogic2_samplerates),
389 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
390 *data = g_variant_builder_end(&gvb);
392 case SR_CONF_TRIGGER_TYPE:
393 *data = g_variant_new_string(TRIGGER_TYPES);
402 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
404 const struct libusb_pollfd **pfd;
405 struct drv_context *drvc;
406 struct dev_context *devc;
407 uint16_t trigger_bytes, tmp;
411 if (sdi->status != SR_ST_ACTIVE)
412 return SR_ERR_DEV_CLOSED;
417 devc->cb_data = cb_data;
418 devc->wait_data_ready_locked = TRUE;
419 devc->stopping_in_progress = FALSE;
420 devc->transfer_error = FALSE;
421 devc->samples_processed = 0;
423 devc->sample_packet = 0;
426 * The trigger must be configured first because the calculation of the
427 * pre and post trigger samples depends on a configured trigger.
429 ikalogic_scanalogic2_configure_trigger(sdi);
430 ikalogic_scanalogic2_calculate_trigger_samples(sdi);
432 trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
434 /* Calculate the number of expected sample packets. */
435 devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
437 /* Round up the number of expected sample packets. */
438 if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
439 devc->num_sample_packets++;
441 devc->num_enabled_probes = 0;
444 * Count the number of enabled probes and number them for a sequential
447 for (i = 0, j = 0; i < NUM_PROBES; i++) {
448 if (devc->probes[i]->enabled) {
449 devc->num_enabled_probes++;
450 devc->probe_map[j] = i;
455 sr_dbg("Number of enabled probes: %i.", devc->num_enabled_probes);
457 /* Set up the transfer buffer for the acquisition. */
458 devc->xfer_data_out[0] = CMD_SAMPLE;
459 devc->xfer_data_out[1] = 0x00;
461 tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
462 memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
464 tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
465 memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
467 devc->xfer_data_out[6] = devc->samplerate_id;
468 devc->xfer_data_out[7] = devc->trigger_type;
469 devc->xfer_data_out[8] = devc->trigger_channel;
470 devc->xfer_data_out[9] = 0x00;
472 tmp = GUINT16_TO_LE(devc->after_trigger_delay);
473 memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
475 if (!(pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx))) {
476 sr_err("libusb_get_pollfds failed.");
480 /* Count the number of file descriptors. */
481 for (devc->num_usbfd = 0; pfd[devc->num_usbfd]; devc->num_usbfd++);
483 if (!(devc->usbfd = g_try_malloc(devc->num_usbfd * sizeof(int)))) {
484 sr_err("File descriptor array malloc failed.");
486 return SR_ERR_MALLOC;
489 if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
490 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
495 for (i = 0; i < devc->num_usbfd; i++) {
496 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
497 ikalogic_scanalogic2_receive_data, (void *)sdi);
499 devc->usbfd[i] = pfd[i]->fd;
504 sr_dbg("Acquisition started successfully.");
506 /* Send header packet to the session bus. */
507 std_session_send_df_header(cb_data, LOG_PREFIX);
509 devc->next_state = STATE_SAMPLE;
514 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
518 if (sdi->status != SR_ST_ACTIVE)
519 return SR_ERR_DEV_CLOSED;
521 sr_dbg("Stopping acquisition.");
523 sdi->status = SR_ST_STOPPING;
528 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
529 .name = "ikalogic-scanalogic2",
530 .longname = "IKALOGIC Scanalogic-2",
535 .dev_list = dev_list,
536 .dev_clear = dev_clear,
537 .config_get = config_get,
538 .config_set = config_set,
539 .config_list = config_list,
540 .dev_open = dev_open,
541 .dev_close = dev_close,
542 .dev_acquisition_start = dev_acquisition_start,
543 .dev_acquisition_stop = dev_acquisition_stop,