]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/dslogic/protocol.c
fx2lafw/dslogic: Split DSLogic into a separate driver
[libsigrok.git] / src / hardware / dslogic / protocol.c
diff --git a/src/hardware/dslogic/protocol.c b/src/hardware/dslogic/protocol.c
new file mode 100644 (file)
index 0000000..76e82a9
--- /dev/null
@@ -0,0 +1,411 @@
+/*
+ * This file is part of the libsigrok project.
+ *
+ * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <config.h>
+#include <glib.h>
+#include <glib/gstdio.h>
+#include "protocol.h"
+#include "dslogic.h"
+
+#pragma pack(push, 1)
+
+struct version_info {
+       uint8_t major;
+       uint8_t minor;
+};
+
+struct cmd_start_acquisition {
+       uint8_t flags;
+       uint8_t sample_delay_h;
+       uint8_t sample_delay_l;
+};
+
+#pragma pack(pop)
+
+#define USB_TIMEOUT 100
+
+static int command_get_fw_version(libusb_device_handle *devhdl,
+                                 struct version_info *vi)
+{
+       int ret;
+
+       ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
+               LIBUSB_ENDPOINT_IN, DS_CMD_GET_FW_VERSION, 0x0000, 0x0000,
+               (unsigned char *)vi, sizeof(struct version_info), USB_TIMEOUT);
+
+       if (ret < 0) {
+               sr_err("Unable to get version info: %s.",
+                      libusb_error_name(ret));
+               return SR_ERR;
+       }
+
+       return SR_OK;
+}
+
+static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid)
+{
+       struct sr_usb_dev_inst *usb = sdi->conn;
+       libusb_device_handle *devhdl = usb->devhdl;
+       int ret;
+
+       ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
+               LIBUSB_ENDPOINT_IN, DS_CMD_GET_REVID_VERSION, 0x0000, 0x0000,
+               revid, 1, USB_TIMEOUT);
+
+       if (ret < 0) {
+               sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
+               return SR_ERR;
+       }
+
+       return SR_OK;
+}
+
+SR_PRIV int dslogic_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di)
+{
+       libusb_device **devlist;
+       struct sr_usb_dev_inst *usb;
+       struct libusb_device_descriptor des;
+       struct dev_context *devc;
+       struct drv_context *drvc;
+       struct version_info vi;
+       int ret, i, device_count;
+       uint8_t revid;
+       char connection_id[64];
+
+       drvc = di->context;
+       devc = sdi->priv;
+       usb = sdi->conn;
+
+       if (sdi->status == SR_ST_ACTIVE)
+               /* Device is already in use. */
+               return SR_ERR;
+
+       device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
+       if (device_count < 0) {
+               sr_err("Failed to get device list: %s.",
+                      libusb_error_name(device_count));
+               return SR_ERR;
+       }
+
+       for (i = 0; i < device_count; i++) {
+               libusb_get_device_descriptor(devlist[i], &des);
+
+               if (des.idVendor != devc->profile->vid
+                   || des.idProduct != devc->profile->pid)
+                       continue;
+
+               if ((sdi->status == SR_ST_INITIALIZING) ||
+                               (sdi->status == SR_ST_INACTIVE)) {
+                       /*
+                        * Check device by its physical USB bus/port address.
+                        */
+                       usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
+                       if (strcmp(sdi->connection_id, connection_id))
+                               /* This is not the one. */
+                               continue;
+               }
+
+               if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
+                       if (usb->address == 0xff)
+                               /*
+                                * First time we touch this device after FW
+                                * upload, so we don't know the address yet.
+                                */
+                               usb->address = libusb_get_device_address(devlist[i]);
+               } else {
+                       sr_err("Failed to open device: %s.",
+                              libusb_error_name(ret));
+                       break;
+               }
+
+               if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
+                       if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
+                               if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
+                                       sr_err("Failed to detach kernel driver: %s.",
+                                               libusb_error_name(ret));
+                                       return SR_ERR;
+                               }
+                       }
+               }
+
+               ret = command_get_fw_version(usb->devhdl, &vi);
+               if (ret != SR_OK) {
+                       sr_err("Failed to get firmware version.");
+                       break;
+               }
+
+               ret = command_get_revid_version(sdi, &revid);
+               if (ret != SR_OK) {
+                       sr_err("Failed to get REVID.");
+                       break;
+               }
+
+               /*
+                * Changes in major version mean incompatible/API changes, so
+                * bail out if we encounter an incompatible version.
+                * Different minor versions are OK, they should be compatible.
+                */
+               if (vi.major != DSLOGIC_REQUIRED_VERSION_MAJOR) {
+                       sr_err("Expected firmware version %d.x, "
+                              "got %d.%d.", DSLOGIC_REQUIRED_VERSION_MAJOR,
+                              vi.major, vi.minor);
+                       break;
+               }
+
+               sdi->status = SR_ST_ACTIVE;
+               sr_info("Opened device on %d.%d (logical) / %s (physical), "
+                       "interface %d, firmware %d.%d.",
+                       usb->bus, usb->address, connection_id,
+                       USB_INTERFACE, vi.major, vi.minor);
+
+               sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
+                       revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
+
+               break;
+       }
+       libusb_free_device_list(devlist, 1);
+
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR;
+
+       return SR_OK;
+}
+
+SR_PRIV struct dev_context *dslogic_dev_new(void)
+{
+       struct dev_context *devc;
+
+       devc = g_malloc0(sizeof(struct dev_context));
+       devc->profile = NULL;
+       devc->fw_updated = 0;
+       devc->cur_samplerate = 0;
+       devc->limit_samples = 0;
+       devc->capture_ratio = 0;
+       devc->continuous_mode = FALSE;
+       devc->clock_edge = DS_EDGE_RISING;
+
+       return devc;
+}
+
+SR_PRIV void dslogic_abort_acquisition(struct dev_context *devc)
+{
+       int i;
+
+       devc->acq_aborted = TRUE;
+
+       for (i = devc->num_transfers - 1; i >= 0; i--) {
+               if (devc->transfers[i])
+                       libusb_cancel_transfer(devc->transfers[i]);
+       }
+}
+
+static void finish_acquisition(struct sr_dev_inst *sdi)
+{
+       struct dev_context *devc;
+
+       devc = sdi->priv;
+
+       std_session_send_df_end(sdi);
+
+       usb_source_remove(sdi->session, devc->ctx);
+
+       devc->num_transfers = 0;
+       g_free(devc->transfers);
+}
+
+static void free_transfer(struct libusb_transfer *transfer)
+{
+       struct sr_dev_inst *sdi;
+       struct dev_context *devc;
+       unsigned int i;
+
+       sdi = transfer->user_data;
+       devc = sdi->priv;
+
+       g_free(transfer->buffer);
+       transfer->buffer = NULL;
+       libusb_free_transfer(transfer);
+
+       for (i = 0; i < devc->num_transfers; i++) {
+               if (devc->transfers[i] == transfer) {
+                       devc->transfers[i] = NULL;
+                       break;
+               }
+       }
+
+       devc->submitted_transfers--;
+       if (devc->submitted_transfers == 0)
+               finish_acquisition(sdi);
+}
+
+static void resubmit_transfer(struct libusb_transfer *transfer)
+{
+       int ret;
+
+       if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
+               return;
+
+       sr_err("%s: %s", __func__, libusb_error_name(ret));
+       free_transfer(transfer);
+
+}
+
+SR_PRIV void dslogic_send_data(struct sr_dev_inst *sdi,
+       uint8_t *data, size_t length, size_t sample_width)
+{
+       const struct sr_datafeed_logic logic = {
+               .length = length,
+               .unitsize = sample_width,
+               .data = data
+       };
+
+       const struct sr_datafeed_packet packet = {
+               .type = SR_DF_LOGIC,
+               .payload = &logic
+       };
+
+       sr_session_send(sdi, &packet);
+}
+
+SR_PRIV void LIBUSB_CALL dslogic_receive_transfer(struct libusb_transfer *transfer)
+{
+       struct sr_dev_inst *sdi;
+       struct dev_context *devc;
+       gboolean packet_has_error = FALSE;
+       struct sr_datafeed_packet packet;
+       unsigned int num_samples;
+       int trigger_offset, cur_sample_count;
+       const int unitsize = 2;
+
+       sdi = transfer->user_data;
+       devc = sdi->priv;
+
+       /*
+        * If acquisition has already ended, just free any queued up
+        * transfer that come in.
+        */
+       if (devc->acq_aborted) {
+               free_transfer(transfer);
+               return;
+       }
+
+       sr_dbg("receive_transfer(): status %s received %d bytes.",
+               libusb_error_name(transfer->status), transfer->actual_length);
+
+       /* Save incoming transfer before reusing the transfer struct. */
+       cur_sample_count = transfer->actual_length / unitsize;
+
+       switch (transfer->status) {
+       case LIBUSB_TRANSFER_NO_DEVICE:
+               dslogic_abort_acquisition(devc);
+               free_transfer(transfer);
+               return;
+       case LIBUSB_TRANSFER_COMPLETED:
+       case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
+               break;
+       default:
+               packet_has_error = TRUE;
+               break;
+       }
+
+       if (transfer->actual_length == 0 || packet_has_error) {
+               devc->empty_transfer_count++;
+               if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
+                       /*
+                        * The FX2 gave up. End the acquisition, the frontend
+                        * will work out that the samplecount is short.
+                        */
+                       dslogic_abort_acquisition(devc);
+                       free_transfer(transfer);
+               } else {
+                       resubmit_transfer(transfer);
+               }
+               return;
+       } else {
+               devc->empty_transfer_count = 0;
+       }
+       if (devc->trigger_fired) {
+               if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) {
+                       /* Send the incoming transfer to the session bus. */
+                       if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
+                               num_samples = devc->limit_samples - devc->sent_samples;
+                       else
+                               num_samples = cur_sample_count;
+
+                       if (devc->trigger_pos > devc->sent_samples
+                               && devc->trigger_pos <= devc->sent_samples + num_samples) {
+                                       /* DSLogic trigger in this block. Send trigger position. */
+                                       trigger_offset = devc->trigger_pos - devc->sent_samples;
+                                       /* Pre-trigger samples. */
+                                       dslogic_send_data(sdi, (uint8_t *)transfer->buffer,
+                                               trigger_offset * unitsize, unitsize);
+                                       devc->sent_samples += trigger_offset;
+                                       /* Trigger position. */
+                                       devc->trigger_pos = 0;
+                                       packet.type = SR_DF_TRIGGER;
+                                       packet.payload = NULL;
+                                       sr_session_send(sdi, &packet);
+                                       /* Post trigger samples. */
+                                       num_samples -= trigger_offset;
+                                       dslogic_send_data(sdi, (uint8_t *)transfer->buffer
+                                                       + trigger_offset * unitsize, num_samples * unitsize, unitsize);
+                                       devc->sent_samples += num_samples;
+                       } else {
+                               dslogic_send_data(sdi, (uint8_t *)transfer->buffer,
+                                       num_samples * unitsize, unitsize);
+                               devc->sent_samples += num_samples;
+                       }
+               }
+       }
+
+       if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
+               dslogic_abort_acquisition(devc);
+               free_transfer(transfer);
+       } else
+               resubmit_transfer(transfer);
+}
+
+static unsigned int to_bytes_per_ms(unsigned int samplerate)
+{
+       return samplerate / 1000;
+}
+
+SR_PRIV size_t dslogic_get_buffer_size(struct dev_context *devc)
+{
+       size_t s;
+
+       /*
+        * The buffer should be large enough to hold 10ms of data and
+        * a multiple of 512.
+        */
+       s = 10 * to_bytes_per_ms(devc->cur_samplerate);
+       return (s + 511) & ~511;
+}
+
+SR_PRIV unsigned int dslogic_get_timeout(struct dev_context *devc)
+{
+       size_t total_size;
+       unsigned int timeout;
+
+       total_size = dslogic_get_buffer_size(devc) *
+                       dslogic_get_number_of_transfers(devc);
+       timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
+       return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
+}