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/>.
22 #include <glib/gstdio.h>
33 struct cmd_start_acquisition {
35 uint8_t sample_delay_h;
36 uint8_t sample_delay_l;
41 #define USB_TIMEOUT 100
43 static int command_get_fw_version(libusb_device_handle *devhdl,
44 struct version_info *vi)
48 ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
49 LIBUSB_ENDPOINT_IN, CMD_GET_FW_VERSION, 0x0000, 0x0000,
50 (unsigned char *)vi, sizeof(struct version_info), USB_TIMEOUT);
53 sr_err("Unable to get version info: %s.",
54 libusb_error_name(ret));
61 static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid)
63 struct dev_context *devc = sdi->priv;
64 struct sr_usb_dev_inst *usb = sdi->conn;
65 libusb_device_handle *devhdl = usb->devhdl;
68 cmd = devc->dslogic ? DS_CMD_GET_REVID_VERSION : CMD_GET_REVID_VERSION;
69 ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
70 LIBUSB_ENDPOINT_IN, cmd, 0x0000, 0x0000, revid, 1, USB_TIMEOUT);
73 sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
80 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi)
82 struct dev_context *devc;
83 struct sr_usb_dev_inst *usb;
85 struct cmd_start_acquisition cmd;
90 samplerate = devc->cur_samplerate;
92 /* Compute the sample rate. */
93 if (devc->sample_wide && samplerate > MAX_16BIT_SAMPLE_RATE) {
94 sr_err("Unable to sample at %" PRIu64 "Hz "
95 "when collecting 16-bit samples.", samplerate);
100 cmd.flags = cmd.sample_delay_h = cmd.sample_delay_l = 0;
101 if ((SR_MHZ(48) % samplerate) == 0) {
102 cmd.flags = CMD_START_FLAGS_CLK_48MHZ;
103 delay = SR_MHZ(48) / samplerate - 1;
104 if (delay > MAX_SAMPLE_DELAY)
108 if (delay == 0 && (SR_MHZ(30) % samplerate) == 0) {
109 cmd.flags = CMD_START_FLAGS_CLK_30MHZ;
110 delay = SR_MHZ(30) / samplerate - 1;
113 sr_dbg("GPIF delay = %d, clocksource = %sMHz.", delay,
114 (cmd.flags & CMD_START_FLAGS_CLK_48MHZ) ? "48" : "30");
116 if (delay <= 0 || delay > MAX_SAMPLE_DELAY) {
117 sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
121 cmd.sample_delay_h = (delay >> 8) & 0xff;
122 cmd.sample_delay_l = delay & 0xff;
124 /* Select the sampling width. */
125 cmd.flags |= devc->sample_wide ? CMD_START_FLAGS_SAMPLE_16BIT :
126 CMD_START_FLAGS_SAMPLE_8BIT;
128 /* Send the control message. */
129 ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
130 LIBUSB_ENDPOINT_OUT, CMD_START, 0x0000, 0x0000,
131 (unsigned char *)&cmd, sizeof(cmd), USB_TIMEOUT);
133 sr_err("Unable to send start command: %s.",
134 libusb_error_name(ret));
142 * Check the USB configuration to determine if this is an fx2lafw device.
144 * @return TRUE if the device's configuration profile matches fx2lafw
145 * configuration, FALSE otherwise.
147 SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
150 struct libusb_device_descriptor des;
151 struct libusb_device_handle *hdl;
153 unsigned char strdesc[64];
158 /* Assume the FW has not been loaded, unless proven wrong. */
159 if (libusb_get_device_descriptor(dev, &des) != 0)
162 if (libusb_open(dev, &hdl) != 0)
165 if (libusb_get_string_descriptor_ascii(hdl,
166 des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
168 if (strcmp((const char *)strdesc, manufacturer))
171 if (libusb_get_string_descriptor_ascii(hdl,
172 des.iProduct, strdesc, sizeof(strdesc)) < 0)
174 if (strcmp((const char *)strdesc, product))
185 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di)
187 libusb_device **devlist;
188 struct sr_usb_dev_inst *usb;
189 struct libusb_device_descriptor des;
190 struct dev_context *devc;
191 struct drv_context *drvc;
192 struct version_info vi;
193 int ret, i, device_count;
195 char connection_id[64];
201 if (sdi->status == SR_ST_ACTIVE)
202 /* Device is already in use. */
205 device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
206 if (device_count < 0) {
207 sr_err("Failed to get device list: %s.",
208 libusb_error_name(device_count));
212 for (i = 0; i < device_count; i++) {
213 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
214 sr_err("Failed to get device descriptor: %s.",
215 libusb_error_name(ret));
219 if (des.idVendor != devc->profile->vid
220 || des.idProduct != devc->profile->pid)
223 if ((sdi->status == SR_ST_INITIALIZING) ||
224 (sdi->status == SR_ST_INACTIVE)) {
226 * Check device by its physical USB bus/port address.
228 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
229 if (strcmp(sdi->connection_id, connection_id))
230 /* This is not the one. */
234 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
235 if (usb->address == 0xff)
237 * First time we touch this device after FW
238 * upload, so we don't know the address yet.
240 usb->address = libusb_get_device_address(devlist[i]);
242 sr_err("Failed to open device: %s.",
243 libusb_error_name(ret));
247 ret = command_get_fw_version(usb->devhdl, &vi);
249 sr_err("Failed to get firmware version.");
253 ret = command_get_revid_version(sdi, &revid);
255 sr_err("Failed to get REVID.");
260 * Changes in major version mean incompatible/API changes, so
261 * bail out if we encounter an incompatible version.
262 * Different minor versions are OK, they should be compatible.
264 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
265 sr_err("Expected firmware version %d.x, "
266 "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
271 sdi->status = SR_ST_ACTIVE;
272 sr_info("Opened device on %d.%d (logical) / %s (physical), "
273 "interface %d, firmware %d.%d.",
274 usb->bus, usb->address, connection_id,
275 USB_INTERFACE, vi.major, vi.minor);
277 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
278 revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
282 libusb_free_device_list(devlist, 1);
284 if (sdi->status != SR_ST_ACTIVE)
290 SR_PRIV struct dev_context *fx2lafw_dev_new(void)
292 struct dev_context *devc;
294 devc = g_malloc0(sizeof(struct dev_context));
295 devc->profile = NULL;
296 devc->fw_updated = 0;
297 devc->cur_samplerate = 0;
298 devc->limit_samples = 0;
299 devc->capture_ratio = 0;
300 devc->sample_wide = FALSE;
306 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc)
310 devc->acq_aborted = TRUE;
312 for (i = devc->num_transfers - 1; i >= 0; i--) {
313 if (devc->transfers[i])
314 libusb_cancel_transfer(devc->transfers[i]);
318 static void finish_acquisition(struct sr_dev_inst *sdi)
320 struct sr_datafeed_packet packet;
321 struct dev_context *devc;
325 /* Terminate session. */
326 packet.type = SR_DF_END;
327 sr_session_send(sdi, &packet);
329 /* Remove fds from polling. */
330 usb_source_remove(sdi->session, devc->ctx);
332 devc->num_transfers = 0;
333 g_free(devc->transfers);
336 soft_trigger_logic_free(devc->stl);
341 static void free_transfer(struct libusb_transfer *transfer)
343 struct sr_dev_inst *sdi;
344 struct dev_context *devc;
347 sdi = transfer->user_data;
350 g_free(transfer->buffer);
351 transfer->buffer = NULL;
352 libusb_free_transfer(transfer);
354 for (i = 0; i < devc->num_transfers; i++) {
355 if (devc->transfers[i] == transfer) {
356 devc->transfers[i] = NULL;
361 devc->submitted_transfers--;
362 if (devc->submitted_transfers == 0)
363 finish_acquisition(sdi);
366 static void resubmit_transfer(struct libusb_transfer *transfer)
370 if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
373 sr_err("%s: %s", __func__, libusb_error_name(ret));
374 free_transfer(transfer);
378 SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer)
380 struct sr_dev_inst *sdi;
381 struct dev_context *devc;
382 gboolean packet_has_error = FALSE;
383 struct sr_datafeed_packet packet;
384 struct sr_datafeed_logic logic;
385 unsigned int num_samples;
386 int trigger_offset, cur_sample_count, unitsize;
387 int pre_trigger_samples;
389 sdi = transfer->user_data;
393 * If acquisition has already ended, just free any queued up
394 * transfer that come in.
396 if (devc->acq_aborted) {
397 free_transfer(transfer);
401 sr_dbg("receive_transfer(): status %s received %d bytes.",
402 libusb_error_name(transfer->status), transfer->actual_length);
404 /* Save incoming transfer before reusing the transfer struct. */
405 unitsize = devc->sample_wide ? 2 : 1;
406 cur_sample_count = transfer->actual_length / unitsize;
408 switch (transfer->status) {
409 case LIBUSB_TRANSFER_NO_DEVICE:
410 fx2lafw_abort_acquisition(devc);
411 free_transfer(transfer);
413 case LIBUSB_TRANSFER_COMPLETED:
414 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
417 packet_has_error = TRUE;
421 if (transfer->actual_length == 0 || packet_has_error) {
422 devc->empty_transfer_count++;
423 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
425 * The FX2 gave up. End the acquisition, the frontend
426 * will work out that the samplecount is short.
428 fx2lafw_abort_acquisition(devc);
429 free_transfer(transfer);
431 resubmit_transfer(transfer);
435 devc->empty_transfer_count = 0;
438 if (devc->trigger_fired) {
439 if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) {
440 /* Send the incoming transfer to the session bus. */
441 packet.type = SR_DF_LOGIC;
442 packet.payload = &logic;
443 if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
444 num_samples = devc->limit_samples - devc->sent_samples;
446 num_samples = cur_sample_count;
447 logic.length = num_samples * unitsize;
448 logic.unitsize = unitsize;
449 logic.data = transfer->buffer;
450 sr_session_send(devc->cb_data, &packet);
451 devc->sent_samples += num_samples;
454 trigger_offset = soft_trigger_logic_check(devc->stl,
455 transfer->buffer, transfer->actual_length, &pre_trigger_samples);
456 if (trigger_offset > -1) {
457 devc->sent_samples += pre_trigger_samples;
458 packet.type = SR_DF_LOGIC;
459 packet.payload = &logic;
460 num_samples = cur_sample_count - trigger_offset;
461 if (devc->limit_samples &&
462 num_samples > devc->limit_samples - devc->sent_samples)
463 num_samples = devc->limit_samples - devc->sent_samples;
464 logic.length = num_samples * unitsize;
465 logic.unitsize = unitsize;
466 logic.data = transfer->buffer + trigger_offset * unitsize;
467 sr_session_send(devc->cb_data, &packet);
468 devc->sent_samples += num_samples;
470 devc->trigger_fired = TRUE;
474 if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
475 fx2lafw_abort_acquisition(devc);
476 free_transfer(transfer);
478 resubmit_transfer(transfer);
481 static unsigned int to_bytes_per_ms(unsigned int samplerate)
483 return samplerate / 1000;
486 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc)
491 * The buffer should be large enough to hold 10ms of data and
494 s = 10 * to_bytes_per_ms(devc->cur_samplerate);
495 return (s + 511) & ~511;
498 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc)
502 /* Total buffer size should be able to hold about 500ms of data. */
503 n = (500 * to_bytes_per_ms(devc->cur_samplerate) /
504 fx2lafw_get_buffer_size(devc));
506 if (n > NUM_SIMUL_TRANSFERS)
507 return NUM_SIMUL_TRANSFERS;
512 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc)
515 unsigned int timeout;
517 total_size = fx2lafw_get_buffer_size(devc) *
518 fx2lafw_get_number_of_transfers(devc);
519 timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
520 return timeout + timeout / 4; /* Leave a headroom of 25% percent. */