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 uint32_t devopts[] = {
23 SR_CONF_LOGIC_ANALYZER,
24 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
25 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
26 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
27 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
30 static const int32_t trigger_matches[] = {
36 SR_PRIV const uint64_t sl2_samplerates[NUM_SAMPLERATES] = {
50 static const char *channel_names[] = {
54 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
56 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
58 return std_init(sr_ctx, di, LOG_PREFIX);
61 static GSList *scan(struct sr_dev_driver *di, GSList *options)
63 GSList *usb_devices, *devices, *l;
64 struct drv_context *drvc;
65 struct sr_dev_inst *sdi;
66 struct dev_context *devc;
67 struct sr_usb_dev_inst *usb;
68 struct device_info dev_info;
76 drvc->instances = NULL;
78 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_VID_PID);
83 for (l = usb_devices; l; l = l->next) {
86 if ((ret = sl2_get_device_info(*usb, &dev_info)) < 0) {
87 sr_warn("Failed to get device information: %d.", ret);
88 sr_usb_dev_inst_free(usb);
92 devc = g_malloc0(sizeof(struct dev_context));
94 if (!(devc->xfer_in = libusb_alloc_transfer(0))) {
95 sr_err("Transfer malloc failed.");
96 sr_usb_dev_inst_free(usb);
101 if (!(devc->xfer_out = libusb_alloc_transfer(0))) {
102 sr_err("Transfer malloc failed.");
103 sr_usb_dev_inst_free(usb);
104 libusb_free_transfer(devc->xfer_in);
109 sdi = g_malloc0(sizeof(struct sr_dev_inst));
110 sdi->status = SR_ST_INACTIVE;
111 sdi->vendor = g_strdup(VENDOR_NAME);
112 sdi->model = g_strdup(MODEL_NAME);
113 sdi->version = g_strdup_printf("%u.%u", dev_info.fw_ver_major, dev_info.fw_ver_minor);
114 sdi->serial_num = g_strdup_printf("%d", dev_info.serial);
117 sdi->inst_type = SR_INST_USB;
120 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
121 devc->channels[i] = sr_channel_new(sdi, i,
122 SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
124 devc->state = STATE_IDLE;
125 devc->next_state = STATE_IDLE;
127 /* Set default samplerate. */
128 sl2_set_samplerate(sdi, DEFAULT_SAMPLERATE);
130 /* Set default capture ratio. */
131 devc->capture_ratio = 0;
133 /* Set default after trigger delay. */
134 devc->after_trigger_delay = 0;
136 memset(devc->xfer_buf_in, 0, LIBUSB_CONTROL_SETUP_SIZE +
138 memset(devc->xfer_buf_out, 0, LIBUSB_CONTROL_SETUP_SIZE +
141 libusb_fill_control_setup(devc->xfer_buf_in,
142 USB_REQUEST_TYPE_IN, USB_HID_GET_REPORT,
143 USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
145 libusb_fill_control_setup(devc->xfer_buf_out,
146 USB_REQUEST_TYPE_OUT, USB_HID_SET_REPORT,
147 USB_HID_REPORT_TYPE_FEATURE, USB_INTERFACE,
150 devc->xfer_data_in = devc->xfer_buf_in +
151 LIBUSB_CONTROL_SETUP_SIZE;
152 devc->xfer_data_out = devc->xfer_buf_out +
153 LIBUSB_CONTROL_SETUP_SIZE;
155 drvc->instances = g_slist_append(drvc->instances, sdi);
156 devices = g_slist_append(devices, sdi);
159 g_slist_free(usb_devices);
164 static GSList *dev_list(const struct sr_dev_driver *di)
166 return ((struct drv_context *)(di->context))->instances;
169 static void clear_dev_context(void *priv)
171 struct dev_context *devc;
175 sr_dbg("Device context cleared.");
177 libusb_free_transfer(devc->xfer_in);
178 libusb_free_transfer(devc->xfer_out);
182 static int dev_clear(const struct sr_dev_driver *di)
184 return std_dev_clear(di, &clear_dev_context);
187 static int dev_open(struct sr_dev_inst *sdi)
189 struct sr_dev_driver *di = sdi->driver;
190 struct drv_context *drvc;
191 struct dev_context *devc;
192 struct sr_usb_dev_inst *usb;
193 uint8_t buffer[PACKET_LENGTH];
196 if (!(drvc = di->context)) {
197 sr_err("Driver was not initialized.");
204 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
208 * Determine if a kernel driver is active on this interface and, if so,
211 if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
212 ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE);
214 sr_err("Failed to detach kernel driver: %s.",
215 libusb_error_name(ret));
220 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE)) < 0) {
221 sr_err("Failed to claim interface: %s.",
222 libusb_error_name(ret));
226 libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
227 devc->xfer_buf_in, sl2_receive_transfer_in,
228 sdi, USB_TIMEOUT_MS);
230 libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
231 devc->xfer_buf_out, sl2_receive_transfer_out,
232 sdi, USB_TIMEOUT_MS);
234 memset(buffer, 0, sizeof(buffer));
236 buffer[0] = CMD_RESET;
237 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
238 sr_err("Device reset failed: %s.", libusb_error_name(ret));
243 * Set the device to idle state. If the device is not in idle state it
244 * possibly will reset itself after a few seconds without being used
245 * and thereby close the connection.
247 buffer[0] = CMD_IDLE;
248 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
249 sr_err("Failed to set device in idle state: %s.",
250 libusb_error_name(ret));
254 sdi->status = SR_ST_ACTIVE;
259 static int dev_close(struct sr_dev_inst *sdi)
261 struct sr_dev_driver *di = sdi->driver;
262 struct sr_usb_dev_inst *usb;
265 sr_err("Driver was not initialized.");
274 libusb_release_interface(usb->devhdl, USB_INTERFACE);
275 libusb_close(usb->devhdl);
278 sdi->status = SR_ST_INACTIVE;
283 static int cleanup(const struct sr_dev_driver *di)
285 return dev_clear(di);
288 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
289 const struct sr_channel_group *cg)
291 struct dev_context *devc;
300 case SR_CONF_SAMPLERATE:
301 *data = g_variant_new_uint64(devc->samplerate);
303 case SR_CONF_CAPTURE_RATIO:
304 *data = g_variant_new_uint64(devc->capture_ratio);
313 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
314 const struct sr_channel_group *cg)
316 uint64_t samplerate, limit_samples, capture_ratio;
321 if (sdi->status != SR_ST_ACTIVE)
322 return SR_ERR_DEV_CLOSED;
327 case SR_CONF_LIMIT_SAMPLES:
328 limit_samples = g_variant_get_uint64(data);
329 ret = sl2_set_limit_samples(sdi, limit_samples);
331 case SR_CONF_SAMPLERATE:
332 samplerate = g_variant_get_uint64(data);
333 ret = sl2_set_samplerate(sdi, samplerate);
335 case SR_CONF_CAPTURE_RATIO:
336 capture_ratio = g_variant_get_uint64(data);
337 ret = sl2_set_capture_ratio(sdi, capture_ratio);
346 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
347 const struct sr_channel_group *cg)
349 GVariant *gvar, *grange[2];
358 case SR_CONF_DEVICE_OPTIONS:
359 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
360 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
362 case SR_CONF_SAMPLERATE:
363 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
364 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
365 sl2_samplerates, ARRAY_SIZE(sl2_samplerates),
367 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
368 *data = g_variant_builder_end(&gvb);
370 case SR_CONF_TRIGGER_MATCH:
371 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
372 trigger_matches, ARRAY_SIZE(trigger_matches),
375 case SR_CONF_LIMIT_SAMPLES:
376 grange[0] = g_variant_new_uint64(0);
377 grange[1] = g_variant_new_uint64(MAX_SAMPLES);
378 *data = g_variant_new_tuple(grange, 2);
387 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
389 struct sr_dev_driver *di = sdi->driver;
390 struct drv_context *drvc;
391 struct dev_context *devc;
392 uint16_t trigger_bytes, tmp;
396 if (sdi->status != SR_ST_ACTIVE)
397 return SR_ERR_DEV_CLOSED;
402 devc->cb_data = cb_data;
403 devc->wait_data_ready_locked = TRUE;
404 devc->stopping_in_progress = FALSE;
405 devc->transfer_error = FALSE;
406 devc->samples_processed = 0;
408 devc->sample_packet = 0;
411 * The trigger must be configured first because the calculation of the
412 * pre and post trigger samples depends on a configured trigger.
414 sl2_convert_trigger(sdi);
415 sl2_calculate_trigger_samples(sdi);
417 trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
419 /* Calculate the number of expected sample packets. */
420 devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
422 /* Round up the number of expected sample packets. */
423 if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
424 devc->num_sample_packets++;
426 devc->num_enabled_channels = 0;
429 * Count the number of enabled channels and number them for a sequential
432 for (i = 0, j = 0; i < NUM_CHANNELS; i++) {
433 if (devc->channels[i]->enabled) {
434 devc->num_enabled_channels++;
435 devc->channel_map[j] = i;
440 sr_dbg("Number of enabled channels: %i.", devc->num_enabled_channels);
442 /* Set up the transfer buffer for the acquisition. */
443 devc->xfer_data_out[0] = CMD_SAMPLE;
444 devc->xfer_data_out[1] = 0x00;
446 tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
447 memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
449 tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
450 memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
452 devc->xfer_data_out[6] = devc->samplerate_id;
453 devc->xfer_data_out[7] = devc->trigger_type;
454 devc->xfer_data_out[8] = devc->trigger_channel;
455 devc->xfer_data_out[9] = 0x00;
457 tmp = GUINT16_TO_LE(devc->after_trigger_delay);
458 memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
460 if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
461 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
465 usb_source_add(sdi->session, drvc->sr_ctx, 100,
466 ikalogic_scanalogic2_receive_data, (void *)sdi);
468 sr_dbg("Acquisition started successfully.");
470 /* Send header packet to the session bus. */
471 std_session_send_df_header(cb_data, LOG_PREFIX);
473 devc->next_state = STATE_SAMPLE;
478 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
482 if (sdi->status != SR_ST_ACTIVE)
483 return SR_ERR_DEV_CLOSED;
485 sr_dbg("Stopping acquisition.");
487 sdi->status = SR_ST_STOPPING;
492 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
493 .name = "ikalogic-scanalogic2",
494 .longname = "IKALOGIC Scanalogic-2",
499 .dev_list = dev_list,
500 .dev_clear = dev_clear,
501 .config_get = config_get,
502 .config_set = config_set,
503 .config_list = config_list,
504 .dev_open = dev_open,
505 .dev_close = dev_close,
506 .dev_acquisition_start = dev_acquisition_start,
507 .dev_acquisition_stop = dev_acquisition_stop,