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 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
57 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
59 return std_init(sr_ctx, di, LOG_PREFIX);
62 static GSList *scan(struct sr_dev_driver *di, GSList *options)
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;
77 drvc->instances = NULL;
79 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_VID_PID);
84 for (l = usb_devices; l; l = l->next) {
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);
93 devc = g_malloc0(sizeof(struct dev_context));
95 if (!(devc->xfer_in = libusb_alloc_transfer(0))) {
96 sr_err("Transfer malloc failed.");
97 sr_usb_dev_inst_free(usb);
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);
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);
118 sdi->inst_type = SR_INST_USB;
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]);
125 devc->state = STATE_IDLE;
126 devc->next_state = STATE_IDLE;
128 /* Set default samplerate. */
129 sl2_set_samplerate(sdi, DEFAULT_SAMPLERATE);
131 /* Set default capture ratio. */
132 devc->capture_ratio = 0;
134 /* Set default after trigger delay. */
135 devc->after_trigger_delay = 0;
137 memset(devc->xfer_buf_in, 0, LIBUSB_CONTROL_SETUP_SIZE +
139 memset(devc->xfer_buf_out, 0, LIBUSB_CONTROL_SETUP_SIZE +
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,
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,
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;
156 drvc->instances = g_slist_append(drvc->instances, sdi);
157 devices = g_slist_append(devices, sdi);
160 g_slist_free(usb_devices);
165 static GSList *dev_list(const struct sr_dev_driver *di)
167 return ((struct drv_context *)(di->context))->instances;
170 static void clear_dev_context(void *priv)
172 struct dev_context *devc;
176 sr_dbg("Device context cleared.");
178 libusb_free_transfer(devc->xfer_in);
179 libusb_free_transfer(devc->xfer_out);
183 static int dev_clear(const struct sr_dev_driver *di)
185 return std_dev_clear(di, &clear_dev_context);
188 static int dev_open(struct sr_dev_inst *sdi)
190 struct sr_dev_driver *di = sdi->driver;
191 struct drv_context *drvc;
192 struct dev_context *devc;
193 struct sr_usb_dev_inst *usb;
194 uint8_t buffer[PACKET_LENGTH];
197 if (!(drvc = di->context)) {
198 sr_err("Driver was not initialized.");
205 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
209 * Determine if a kernel driver is active on this interface and, if so,
212 if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
213 ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE);
215 sr_err("Failed to detach kernel driver: %s.",
216 libusb_error_name(ret));
221 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE)) < 0) {
222 sr_err("Failed to claim interface: %s.",
223 libusb_error_name(ret));
227 libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
228 devc->xfer_buf_in, sl2_receive_transfer_in,
229 sdi, USB_TIMEOUT_MS);
231 libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
232 devc->xfer_buf_out, sl2_receive_transfer_out,
233 sdi, USB_TIMEOUT_MS);
235 memset(buffer, 0, sizeof(buffer));
237 buffer[0] = CMD_RESET;
238 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
239 sr_err("Device reset failed: %s.", libusb_error_name(ret));
244 * Set the device to idle state. If the device is not in idle state it
245 * possibly will reset itself after a few seconds without being used
246 * and thereby close the connection.
248 buffer[0] = CMD_IDLE;
249 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
250 sr_err("Failed to set device in idle state: %s.",
251 libusb_error_name(ret));
255 sdi->status = SR_ST_ACTIVE;
260 static int dev_close(struct sr_dev_inst *sdi)
262 struct sr_dev_driver *di = sdi->driver;
263 struct sr_usb_dev_inst *usb;
266 sr_err("Driver was not initialized.");
275 libusb_release_interface(usb->devhdl, USB_INTERFACE);
276 libusb_close(usb->devhdl);
279 sdi->status = SR_ST_INACTIVE;
284 static int cleanup(const struct sr_dev_driver *di)
286 return dev_clear(di);
289 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
290 const struct sr_channel_group *cg)
292 struct dev_context *devc;
301 case SR_CONF_SAMPLERATE:
302 *data = g_variant_new_uint64(devc->samplerate);
304 case SR_CONF_CAPTURE_RATIO:
305 *data = g_variant_new_uint64(devc->capture_ratio);
314 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
315 const struct sr_channel_group *cg)
317 uint64_t samplerate, limit_samples, capture_ratio;
322 if (sdi->status != SR_ST_ACTIVE)
323 return SR_ERR_DEV_CLOSED;
326 case SR_CONF_LIMIT_SAMPLES:
327 limit_samples = g_variant_get_uint64(data);
328 ret = sl2_set_limit_samples(sdi, limit_samples);
330 case SR_CONF_SAMPLERATE:
331 samplerate = g_variant_get_uint64(data);
332 ret = sl2_set_samplerate(sdi, samplerate);
334 case SR_CONF_CAPTURE_RATIO:
335 capture_ratio = g_variant_get_uint64(data);
336 ret = sl2_set_capture_ratio(sdi, capture_ratio);
345 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
346 const struct sr_channel_group *cg)
348 GVariant *gvar, *grange[2];
357 case SR_CONF_DEVICE_OPTIONS:
358 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
359 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
361 case SR_CONF_SAMPLERATE:
362 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
363 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
364 sl2_samplerates, ARRAY_SIZE(sl2_samplerates),
366 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
367 *data = g_variant_builder_end(&gvb);
369 case SR_CONF_TRIGGER_MATCH:
370 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
371 trigger_matches, ARRAY_SIZE(trigger_matches),
374 case SR_CONF_LIMIT_SAMPLES:
375 grange[0] = g_variant_new_uint64(0);
376 grange[1] = g_variant_new_uint64(MAX_SAMPLES);
377 *data = g_variant_new_tuple(grange, 2);
386 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
388 struct sr_dev_driver *di = sdi->driver;
389 struct drv_context *drvc;
390 struct dev_context *devc;
391 uint16_t trigger_bytes, tmp;
395 if (sdi->status != SR_ST_ACTIVE)
396 return SR_ERR_DEV_CLOSED;
401 devc->cb_data = cb_data;
402 devc->wait_data_ready_locked = TRUE;
403 devc->stopping_in_progress = FALSE;
404 devc->transfer_error = FALSE;
405 devc->samples_processed = 0;
407 devc->sample_packet = 0;
410 * The trigger must be configured first because the calculation of the
411 * pre and post trigger samples depends on a configured trigger.
413 sl2_convert_trigger(sdi);
414 sl2_calculate_trigger_samples(sdi);
416 trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
418 /* Calculate the number of expected sample packets. */
419 devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
421 /* Round up the number of expected sample packets. */
422 if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
423 devc->num_sample_packets++;
425 devc->num_enabled_channels = 0;
428 * Count the number of enabled channels and number them for a sequential
431 for (i = 0, j = 0; i < NUM_CHANNELS; i++) {
432 if (devc->channels[i]->enabled) {
433 devc->num_enabled_channels++;
434 devc->channel_map[j] = i;
439 sr_dbg("Number of enabled channels: %i.", devc->num_enabled_channels);
441 /* Set up the transfer buffer for the acquisition. */
442 devc->xfer_data_out[0] = CMD_SAMPLE;
443 devc->xfer_data_out[1] = 0x00;
445 tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
446 memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
448 tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
449 memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
451 devc->xfer_data_out[6] = devc->samplerate_id;
452 devc->xfer_data_out[7] = devc->trigger_type;
453 devc->xfer_data_out[8] = devc->trigger_channel;
454 devc->xfer_data_out[9] = 0x00;
456 tmp = GUINT16_TO_LE(devc->after_trigger_delay);
457 memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
459 if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
460 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
464 usb_source_add(sdi->session, drvc->sr_ctx, 100,
465 ikalogic_scanalogic2_receive_data, (void *)sdi);
467 sr_dbg("Acquisition started successfully.");
469 /* Send header packet to the session bus. */
470 std_session_send_df_header(cb_data, LOG_PREFIX);
472 devc->next_state = STATE_SAMPLE;
477 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
481 if (sdi->status != SR_ST_ACTIVE)
482 return SR_ERR_DEV_CLOSED;
484 sr_dbg("Stopping acquisition.");
486 sdi->status = SR_ST_STOPPING;
491 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
492 .name = "ikalogic-scanalogic2",
493 .longname = "IKALOGIC Scanalogic-2",
498 .dev_list = dev_list,
499 .dev_clear = dev_clear,
500 .config_get = config_get,
501 .config_set = config_set,
502 .config_list = config_list,
503 .dev_open = dev_open,
504 .dev_close = dev_close,
505 .dev_acquisition_start = dev_acquisition_start,
506 .dev_acquisition_stop = dev_acquisition_stop,