2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <glib/gstdio.h>
34 struct cmd_start_acquisition {
36 uint8_t sample_delay_h;
37 uint8_t sample_delay_l;
42 #define USB_TIMEOUT 100
44 static int command_get_fw_version(libusb_device_handle *devhdl,
45 struct version_info *vi)
49 ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
50 LIBUSB_ENDPOINT_IN, CMD_GET_FW_VERSION, 0x0000, 0x0000,
51 (unsigned char *)vi, sizeof(struct version_info), USB_TIMEOUT);
54 sr_err("Unable to get version info: %s.",
55 libusb_error_name(ret));
62 static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid)
64 struct dev_context *devc = sdi->priv;
65 struct sr_usb_dev_inst *usb = sdi->conn;
66 libusb_device_handle *devhdl = usb->devhdl;
69 cmd = devc->dslogic ? DS_CMD_GET_REVID_VERSION : CMD_GET_REVID_VERSION;
70 ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
71 LIBUSB_ENDPOINT_IN, cmd, 0x0000, 0x0000, revid, 1, USB_TIMEOUT);
74 sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
81 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi)
83 struct dev_context *devc;
84 struct sr_usb_dev_inst *usb;
86 struct cmd_start_acquisition cmd;
91 samplerate = devc->cur_samplerate;
93 /* Compute the sample rate. */
94 if (devc->sample_wide && samplerate > MAX_16BIT_SAMPLE_RATE) {
95 sr_err("Unable to sample at %" PRIu64 "Hz "
96 "when collecting 16-bit samples.", samplerate);
101 cmd.flags = cmd.sample_delay_h = cmd.sample_delay_l = 0;
102 if ((SR_MHZ(48) % samplerate) == 0) {
103 cmd.flags = CMD_START_FLAGS_CLK_48MHZ;
104 delay = SR_MHZ(48) / samplerate - 1;
105 if (delay > MAX_SAMPLE_DELAY)
109 if (delay == 0 && (SR_MHZ(30) % samplerate) == 0) {
110 cmd.flags = CMD_START_FLAGS_CLK_30MHZ;
111 delay = SR_MHZ(30) / samplerate - 1;
114 sr_dbg("GPIF delay = %d, clocksource = %sMHz.", delay,
115 (cmd.flags & CMD_START_FLAGS_CLK_48MHZ) ? "48" : "30");
117 if (delay <= 0 || delay > MAX_SAMPLE_DELAY) {
118 sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
122 cmd.sample_delay_h = (delay >> 8) & 0xff;
123 cmd.sample_delay_l = delay & 0xff;
125 /* Select the sampling width. */
126 cmd.flags |= devc->sample_wide ? CMD_START_FLAGS_SAMPLE_16BIT :
127 CMD_START_FLAGS_SAMPLE_8BIT;
128 /* Enable CTL2 clock. */
129 cmd.flags |= (devc->profile->dev_caps & DEV_CAPS_AX_ANALOG) ? CMD_START_FLAGS_CLK_CTL2 : 0;
131 /* Send the control message. */
132 ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
133 LIBUSB_ENDPOINT_OUT, CMD_START, 0x0000, 0x0000,
134 (unsigned char *)&cmd, sizeof(cmd), USB_TIMEOUT);
136 sr_err("Unable to send start command: %s.",
137 libusb_error_name(ret));
145 * Check the USB configuration to determine if this is an fx2lafw device.
147 * @return TRUE if the device's configuration profile matches fx2lafw
148 * configuration, FALSE otherwise.
150 SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
153 struct libusb_device_descriptor des;
154 struct libusb_device_handle *hdl;
156 unsigned char strdesc[64];
161 /* Assume the FW has not been loaded, unless proven wrong. */
162 libusb_get_device_descriptor(dev, &des);
164 if (libusb_open(dev, &hdl) != 0)
167 if (libusb_get_string_descriptor_ascii(hdl,
168 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
170 if (strcmp((const char *)strdesc, manufacturer))
173 if (libusb_get_string_descriptor_ascii(hdl,
174 des.iProduct, strdesc, sizeof(strdesc)) < 0)
176 if (strcmp((const char *)strdesc, product))
187 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di)
189 libusb_device **devlist;
190 struct sr_usb_dev_inst *usb;
191 struct libusb_device_descriptor des;
192 struct dev_context *devc;
193 struct drv_context *drvc;
194 struct version_info vi;
195 int ret, i, device_count;
197 char connection_id[64];
203 if (sdi->status == SR_ST_ACTIVE)
204 /* Device is already in use. */
207 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
208 if (device_count < 0) {
209 sr_err("Failed to get device list: %s.",
210 libusb_error_name(device_count));
214 for (i = 0; i < device_count; i++) {
215 libusb_get_device_descriptor(devlist[i], &des);
217 if (des.idVendor != devc->profile->vid
218 || des.idProduct != devc->profile->pid)
221 if ((sdi->status == SR_ST_INITIALIZING) ||
222 (sdi->status == SR_ST_INACTIVE)) {
224 * Check device by its physical USB bus/port address.
226 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
227 if (strcmp(sdi->connection_id, connection_id))
228 /* This is not the one. */
232 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
233 if (usb->address == 0xff)
235 * First time we touch this device after FW
236 * upload, so we don't know the address yet.
238 usb->address = libusb_get_device_address(devlist[i]);
240 sr_err("Failed to open device: %s.",
241 libusb_error_name(ret));
245 if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
246 if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
247 if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
248 sr_err("Failed to detach kernel driver: %s.",
249 libusb_error_name(ret));
255 ret = command_get_fw_version(usb->devhdl, &vi);
257 sr_err("Failed to get firmware version.");
261 ret = command_get_revid_version(sdi, &revid);
263 sr_err("Failed to get REVID.");
268 * Changes in major version mean incompatible/API changes, so
269 * bail out if we encounter an incompatible version.
270 * Different minor versions are OK, they should be compatible.
272 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
273 sr_err("Expected firmware version %d.x, "
274 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
279 sdi->status = SR_ST_ACTIVE;
280 sr_info("Opened device on %d.%d (logical) / %s (physical), "
281 "interface %d, firmware %d.%d.",
282 usb->bus, usb->address, connection_id,
283 USB_INTERFACE, vi.major, vi.minor);
285 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
286 revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
290 libusb_free_device_list(devlist, 1);
292 if (sdi->status != SR_ST_ACTIVE)
298 SR_PRIV struct dev_context *fx2lafw_dev_new(void)
300 struct dev_context *devc;
302 devc = g_malloc0(sizeof(struct dev_context));
303 devc->profile = NULL;
304 devc->fw_updated = 0;
305 devc->cur_samplerate = 0;
306 devc->limit_samples = 0;
307 devc->capture_ratio = 0;
308 devc->sample_wide = FALSE;
309 devc->dslogic_continuous_mode = FALSE;
310 devc->dslogic_clock_edge = DS_EDGE_RISING;
316 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc)
320 devc->acq_aborted = TRUE;
322 for (i = devc->num_transfers - 1; i >= 0; i--) {
323 if (devc->transfers[i])
324 libusb_cancel_transfer(devc->transfers[i]);
328 static void finish_acquisition(struct sr_dev_inst *sdi)
330 struct dev_context *devc;
334 std_session_send_df_end(sdi);
336 usb_source_remove(sdi->session, devc->ctx);
338 devc->num_transfers = 0;
339 g_free(devc->transfers);
341 /* Free the deinterlace buffers if we had them */
342 g_free(devc->logic_buffer);
343 g_free(devc->analog_buffer);
346 soft_trigger_logic_free(devc->stl);
351 static void free_transfer(struct libusb_transfer *transfer)
353 struct sr_dev_inst *sdi;
354 struct dev_context *devc;
357 sdi = transfer->user_data;
360 g_free(transfer->buffer);
361 transfer->buffer = NULL;
362 libusb_free_transfer(transfer);
364 for (i = 0; i < devc->num_transfers; i++) {
365 if (devc->transfers[i] == transfer) {
366 devc->transfers[i] = NULL;
371 devc->submitted_transfers--;
372 if (devc->submitted_transfers == 0)
373 finish_acquisition(sdi);
376 static void resubmit_transfer(struct libusb_transfer *transfer)
380 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
383 sr_err("%s: %s", __func__, libusb_error_name(ret));
384 free_transfer(transfer);
388 SR_PRIV void mso_send_data_proc(struct sr_dev_inst *sdi,
389 uint8_t *data, size_t length, size_t sample_width)
392 struct dev_context *devc;
393 struct sr_datafeed_analog analog;
394 struct sr_analog_encoding encoding;
395 struct sr_analog_meaning meaning;
396 struct sr_analog_spec spec;
405 for (i = 0; i < length; i++) {
406 devc->logic_buffer[i] = data[i * 2];
407 /* Rescale to -10V - +10V from 0-255. */
408 devc->analog_buffer[i] = (data[i * 2 + 1] - 128.0f) / 12.8f;
411 const struct sr_datafeed_logic logic = {
414 .data = devc->logic_buffer
417 const struct sr_datafeed_packet logic_packet = {
422 sr_session_send(sdi, &logic_packet);
424 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
425 analog.meaning->channels = devc->enabled_analog_channels;
426 analog.meaning->mq = SR_MQ_VOLTAGE;
427 analog.meaning->unit = SR_UNIT_VOLT;
428 analog.meaning->mqflags = 0 /* SR_MQFLAG_DC */;
429 analog.num_samples = length;
430 analog.data = devc->analog_buffer;
432 const struct sr_datafeed_packet analog_packet = {
433 .type = SR_DF_ANALOG,
437 sr_session_send(sdi, &analog_packet);
440 SR_PRIV void la_send_data_proc(struct sr_dev_inst *sdi,
441 uint8_t *data, size_t length, size_t sample_width)
443 const struct sr_datafeed_logic logic = {
445 .unitsize = sample_width,
449 const struct sr_datafeed_packet packet = {
454 sr_session_send(sdi, &packet);
457 SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer)
459 struct sr_dev_inst *sdi;
460 struct dev_context *devc;
461 gboolean packet_has_error = FALSE;
462 struct sr_datafeed_packet packet;
463 unsigned int num_samples;
464 int trigger_offset, cur_sample_count, unitsize;
465 int pre_trigger_samples;
467 sdi = transfer->user_data;
471 * If acquisition has already ended, just free any queued up
472 * transfer that come in.
474 if (devc->acq_aborted) {
475 free_transfer(transfer);
479 sr_dbg("receive_transfer(): status %s received %d bytes.",
480 libusb_error_name(transfer->status), transfer->actual_length);
482 /* Save incoming transfer before reusing the transfer struct. */
483 unitsize = devc->sample_wide ? 2 : 1;
484 cur_sample_count = transfer->actual_length / unitsize;
486 switch (transfer->status) {
487 case LIBUSB_TRANSFER_NO_DEVICE:
488 fx2lafw_abort_acquisition(devc);
489 free_transfer(transfer);
491 case LIBUSB_TRANSFER_COMPLETED:
492 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
495 packet_has_error = TRUE;
499 if (transfer->actual_length == 0 || packet_has_error) {
500 devc->empty_transfer_count++;
501 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
503 * The FX2 gave up. End the acquisition, the frontend
504 * will work out that the samplecount is short.
506 fx2lafw_abort_acquisition(devc);
507 free_transfer(transfer);
509 resubmit_transfer(transfer);
513 devc->empty_transfer_count = 0;
515 if (devc->trigger_fired) {
516 if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) {
517 /* Send the incoming transfer to the session bus. */
518 if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
519 num_samples = devc->limit_samples - devc->sent_samples;
521 num_samples = cur_sample_count;
523 if (devc->dslogic && devc->trigger_pos > devc->sent_samples
524 && devc->trigger_pos <= devc->sent_samples + num_samples) {
525 /* DSLogic trigger in this block. Send trigger position. */
526 trigger_offset = devc->trigger_pos - devc->sent_samples;
527 /* Pre-trigger samples. */
528 devc->send_data_proc(sdi, (uint8_t *)transfer->buffer,
529 trigger_offset * unitsize, unitsize);
530 devc->sent_samples += trigger_offset;
531 /* Trigger position. */
532 devc->trigger_pos = 0;
533 packet.type = SR_DF_TRIGGER;
534 packet.payload = NULL;
535 sr_session_send(sdi, &packet);
536 /* Post trigger samples. */
537 num_samples -= trigger_offset;
538 devc->send_data_proc(sdi, (uint8_t *)transfer->buffer
539 + trigger_offset * unitsize, num_samples * unitsize, unitsize);
540 devc->sent_samples += num_samples;
542 devc->send_data_proc(sdi, (uint8_t *)transfer->buffer,
543 num_samples * unitsize, unitsize);
544 devc->sent_samples += num_samples;
548 trigger_offset = soft_trigger_logic_check(devc->stl,
549 transfer->buffer, transfer->actual_length, &pre_trigger_samples);
550 if (trigger_offset > -1) {
551 devc->sent_samples += pre_trigger_samples;
552 num_samples = cur_sample_count - trigger_offset;
553 if (devc->limit_samples &&
554 num_samples > devc->limit_samples - devc->sent_samples)
555 num_samples = devc->limit_samples - devc->sent_samples;
557 devc->send_data_proc(sdi, (uint8_t *)transfer->buffer
558 + trigger_offset * unitsize,
559 num_samples * unitsize, unitsize);
560 devc->sent_samples += num_samples;
562 devc->trigger_fired = TRUE;
566 if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
567 fx2lafw_abort_acquisition(devc);
568 free_transfer(transfer);
570 resubmit_transfer(transfer);
573 static unsigned int to_bytes_per_ms(unsigned int samplerate)
575 return samplerate / 1000;
578 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc)
583 * The buffer should be large enough to hold 10ms of data and
586 s = 10 * to_bytes_per_ms(devc->cur_samplerate);
587 return (s + 511) & ~511;
590 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc)
594 /* Total buffer size should be able to hold about 500ms of data. */
595 n = (500 * to_bytes_per_ms(devc->cur_samplerate) /
596 fx2lafw_get_buffer_size(devc));
598 if (n > NUM_SIMUL_TRANSFERS)
599 return NUM_SIMUL_TRANSFERS;
604 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc)
607 unsigned int timeout;
609 total_size = fx2lafw_get_buffer_size(devc) *
610 fx2lafw_get_number_of_transfers(devc);
611 timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
612 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */