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,
28 SR_CONF_MAX_UNCOMPRESSED_SAMPLES,
31 SR_PRIV const uint64_t sl2_samplerates[NUM_SAMPLERATES] = {
45 static const char *probe_names[NUM_PROBES + 1] = {
50 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
51 static struct sr_dev_driver *di = &ikalogic_scanalogic2_driver_info;
53 static int init(struct sr_context *sr_ctx)
55 return std_init(sr_ctx, di, LOG_PREFIX);
58 static GSList *scan(GSList *options)
60 GSList *usb_devices, *devices, *l;
61 struct drv_context *drvc;
62 struct sr_dev_inst *sdi;
63 struct sr_probe *probe;
64 struct dev_context *devc;
65 struct sr_usb_dev_inst *usb;
66 struct device_info dev_info;
67 int ret, device_index, i;
74 drvc->instances = NULL;
77 usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_VID_PID);
79 if (usb_devices == NULL)
82 for (l = usb_devices; l; l = l->next) {
85 if ((ret = sl2_get_device_info(*usb, &dev_info)) < 0) {
86 sr_warn("Failed to get device information: %d.", ret);
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 sl2_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_GET_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: %s.",
239 libusb_error_name(ret));
244 if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE)) < 0) {
245 sr_err("Failed to claim interface: %s.",
246 libusb_error_name(ret));
250 libusb_fill_control_transfer(devc->xfer_in, usb->devhdl,
251 devc->xfer_buf_in, sl2_receive_transfer_in,
254 libusb_fill_control_transfer(devc->xfer_out, usb->devhdl,
255 devc->xfer_buf_out, sl2_receive_transfer_out,
258 memset(buffer, 0, sizeof(buffer));
260 buffer[0] = CMD_RESET;
261 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
262 sr_err("Device reset failed: %s.", libusb_error_name(ret));
267 * Set the device to idle state. If the device is not in idle state it
268 * possibly will reset itself after a few seconds without being used
269 * and thereby close the connection.
271 buffer[0] = CMD_IDLE;
272 if ((ret = sl2_transfer_out(usb->devhdl, buffer)) != PACKET_LENGTH) {
273 sr_err("Failed to set device in idle state: %s.",
274 libusb_error_name(ret));
278 sdi->status = SR_ST_ACTIVE;
283 static int dev_close(struct sr_dev_inst *sdi)
285 struct sr_usb_dev_inst *usb;
288 sr_err("Driver was not initialized.");
297 libusb_release_interface(usb->devhdl, USB_INTERFACE);
298 libusb_close(usb->devhdl);
301 sdi->status = SR_ST_INACTIVE;
306 static int cleanup(void)
311 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
312 const struct sr_probe_group *probe_group)
314 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);
329 case SR_CONF_MAX_UNCOMPRESSED_SAMPLES:
330 *data = g_variant_new_uint64(MAX_SAMPLES);
339 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
340 const struct sr_probe_group *probe_group)
342 uint64_t samplerate, limit_samples, capture_ratio;
347 if (sdi->status != SR_ST_ACTIVE)
348 return SR_ERR_DEV_CLOSED;
353 case SR_CONF_LIMIT_SAMPLES:
354 limit_samples = g_variant_get_uint64(data);
355 ret = sl2_set_limit_samples(sdi, limit_samples);
357 case SR_CONF_SAMPLERATE:
358 samplerate = g_variant_get_uint64(data);
359 ret = sl2_set_samplerate(sdi, samplerate);
361 case SR_CONF_CAPTURE_RATIO:
362 capture_ratio = g_variant_get_uint64(data);
363 ret = sl2_set_capture_ratio(sdi, capture_ratio);
372 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
373 const struct sr_probe_group *probe_group)
385 case SR_CONF_DEVICE_OPTIONS:
386 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, hwcaps,
387 ARRAY_SIZE(hwcaps), sizeof(int32_t));
389 case SR_CONF_SAMPLERATE:
390 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
391 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
392 sl2_samplerates, ARRAY_SIZE(sl2_samplerates),
394 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
395 *data = g_variant_builder_end(&gvb);
397 case SR_CONF_TRIGGER_TYPE:
398 *data = g_variant_new_string(TRIGGER_TYPES);
407 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
409 struct drv_context *drvc;
410 struct dev_context *devc;
411 uint16_t trigger_bytes, tmp;
415 if (sdi->status != SR_ST_ACTIVE)
416 return SR_ERR_DEV_CLOSED;
421 devc->cb_data = cb_data;
422 devc->wait_data_ready_locked = TRUE;
423 devc->stopping_in_progress = FALSE;
424 devc->transfer_error = FALSE;
425 devc->samples_processed = 0;
427 devc->sample_packet = 0;
430 * The trigger must be configured first because the calculation of the
431 * pre and post trigger samples depends on a configured trigger.
433 sl2_configure_trigger(sdi);
434 sl2_calculate_trigger_samples(sdi);
436 trigger_bytes = devc->pre_trigger_bytes + devc->post_trigger_bytes;
438 /* Calculate the number of expected sample packets. */
439 devc->num_sample_packets = trigger_bytes / PACKET_NUM_SAMPLE_BYTES;
441 /* Round up the number of expected sample packets. */
442 if (trigger_bytes % PACKET_NUM_SAMPLE_BYTES != 0)
443 devc->num_sample_packets++;
445 devc->num_enabled_probes = 0;
448 * Count the number of enabled probes and number them for a sequential
451 for (i = 0, j = 0; i < NUM_PROBES; i++) {
452 if (devc->probes[i]->enabled) {
453 devc->num_enabled_probes++;
454 devc->probe_map[j] = i;
459 sr_dbg("Number of enabled probes: %i.", devc->num_enabled_probes);
461 /* Set up the transfer buffer for the acquisition. */
462 devc->xfer_data_out[0] = CMD_SAMPLE;
463 devc->xfer_data_out[1] = 0x00;
465 tmp = GUINT16_TO_LE(devc->pre_trigger_bytes);
466 memcpy(devc->xfer_data_out + 2, &tmp, sizeof(tmp));
468 tmp = GUINT16_TO_LE(devc->post_trigger_bytes);
469 memcpy(devc->xfer_data_out + 4, &tmp, sizeof(tmp));
471 devc->xfer_data_out[6] = devc->samplerate_id;
472 devc->xfer_data_out[7] = devc->trigger_type;
473 devc->xfer_data_out[8] = devc->trigger_channel;
474 devc->xfer_data_out[9] = 0x00;
476 tmp = GUINT16_TO_LE(devc->after_trigger_delay);
477 memcpy(devc->xfer_data_out + 10, &tmp, sizeof(tmp));
479 if ((ret = libusb_submit_transfer(devc->xfer_out)) != 0) {
480 sr_err("Submit transfer failed: %s.", libusb_error_name(ret));
484 usb_source_add(drvc->sr_ctx, 100, ikalogic_scanalogic2_receive_data, (void *)sdi);
486 sr_dbg("Acquisition started successfully.");
488 /* Send header packet to the session bus. */
489 std_session_send_df_header(cb_data, LOG_PREFIX);
491 devc->next_state = STATE_SAMPLE;
496 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
500 if (sdi->status != SR_ST_ACTIVE)
501 return SR_ERR_DEV_CLOSED;
503 sr_dbg("Stopping acquisition.");
505 sdi->status = SR_ST_STOPPING;
510 SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info = {
511 .name = "ikalogic-scanalogic2",
512 .longname = "IKALOGIC Scanalogic-2",
517 .dev_list = dev_list,
518 .dev_clear = dev_clear,
519 .config_get = config_get,
520 .config_set = config_set,
521 .config_list = config_list,
522 .dev_open = dev_open,
523 .dev_close = dev_close,
524 .dev_acquisition_start = dev_acquisition_start,
525 .dev_acquisition_stop = dev_acquisition_stop,