X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fapi.c;h=34c64beb9830e1d4dc6095472f0fa05d5265f34c;hb=96dc954e1c17a34daafcccb0a6013873d7ec9ee4;hp=03edcf14c5e96929dbc6342807b27cac044d7515;hpb=a7740b06997b4d455428baaa995b777090c3b76e;p=libsigrok.git
diff --git a/src/hardware/kingst-la2016/api.c b/src/hardware/kingst-la2016/api.c
index 03edcf14..34c64beb 100644
--- a/src/hardware/kingst-la2016/api.c
+++ b/src/hardware/kingst-la2016/api.c
@@ -20,15 +20,14 @@
* along with this program. If not, see .
*/
-/* mostly stolen from src/hardware/saleae-logic16/ */
+/*
+ * This driver implementation initially was derived from the
+ * src/hardware/saleae-logic16/ source code.
+ */
#include
-#include
#include
-#include
-#include
-#include
#include
#include "libsigrok-internal.h"
@@ -162,7 +161,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
else
conn_devices = NULL;
- /* Find all LA2016 devices and upload firmware to them. */
+ /* Find all LA2016 devices, optionally upload firmware to them. */
devices = NULL;
libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
for (i = 0; devlist[i]; i++) {
@@ -175,8 +174,10 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
break;
}
if (!l) {
- /* This device matched none of the ones that
- * matched the conn specification. */
+ /*
+ * A connection parameter was specified and
+ * this device does not match the filter.
+ */
continue;
}
}
@@ -189,7 +190,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
continue;
- /* Already has the firmware */
+ /* USB identification matches, a device was found. */
sr_dbg("Found a LA2016 device.");
sdi = g_malloc0(sizeof(struct sr_dev_inst));
sdi->status = SR_ST_INITIALIZING;
@@ -198,16 +199,17 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
fw_updated = 0;
dev_addr = libusb_get_device_address(devlist[i]);
if (des.iProduct != 2) {
- sr_info("device at '%s' has no firmware loaded!", connection_id);
+ sr_info("Device at '%s' has no firmware loaded.", connection_id);
if (la2016_upload_firmware(drvc->sr_ctx, devlist[i], des.idProduct) != SR_OK) {
- sr_err("uC firmware upload failed!");
+ sr_err("MCU firmware upload failed.");
g_free(sdi->connection_id);
g_free(sdi);
continue;
}
fw_updated = g_get_monotonic_time();
- dev_addr = 0xff; /* to mark that we don't know address yet... ugly */
+ /* Will re-enumerate. Mark as "unknown address yet". */
+ dev_addr = 0xff;
}
sdi->vendor = g_strdup("Kingst");
@@ -265,24 +267,24 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
continue;
if ((sdi->status == SR_ST_INITIALIZING) || (sdi->status == SR_ST_INACTIVE)) {
- /*
- * Check device by its physical USB bus/port address.
- */
+ /* Check physical USB bus/port address. */
if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
continue;
- if (strcmp(sdi->connection_id, connection_id))
- /* This is not the one. */
+ if (strcmp(sdi->connection_id, connection_id)) {
+ /* Not the device we looked up before. */
continue;
+ }
}
if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
- if (usb->address == 0xff)
+ if (usb->address == 0xff) {
/*
- * First time we touch this device after FW
- * upload, so we don't know the address yet.
+ * First encounter after firmware upload.
+ * Grab current address after enumeration.
*/
usb->address = libusb_get_device_address(devlist[i]);
+ }
} else {
sr_err("Failed to open device: %s.", libusb_error_name(ret));
ret = SR_ERR;
@@ -291,8 +293,7 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
if (ret == LIBUSB_ERROR_BUSY) {
- sr_err("Unable to claim USB interface. Another "
- "program or driver has already claimed it.");
+ sr_err("Cannot claim USB interface. Another program or driver using it?");
ret = SR_ERR;
break;
} else if (ret == LIBUSB_ERROR_NO_DEVICE) {
@@ -300,13 +301,13 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
ret = SR_ERR;
break;
} else if (ret != 0) {
- sr_err("Unable to claim interface: %s.", libusb_error_name(ret));
+ sr_err("Cannot claim USB interface: %s.", libusb_error_name(ret));
ret = SR_ERR;
break;
}
if ((ret = la2016_init_device(sdi)) != SR_OK) {
- sr_err("Failed to init device.");
+ sr_err("Cannot initialize device.");
break;
}
@@ -343,14 +344,16 @@ static int dev_open(struct sr_dev_inst *sdi)
devc = sdi->priv;
/*
- * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
- * milliseconds for the FX2 to renumerate.
+ * When the sigrok driver recently uploaded firmware, wait for
+ * the FX2 to re-enumerate. Deal with the condition that the
+ * MCU can take some 2000ms to be gone from the bus before it
+ * re-appears executing the recently uploaded firmware.
*/
ret = SR_ERR;
if (devc->fw_updated > 0) {
sr_info("Waiting for device to reset after firmware upload.");
- /* Takes >= 2000ms for the uC to be gone from the USB bus. */
- reset_done = devc->fw_updated + 18 * (uint64_t)1e5; /* 1.8 seconds */
+ reset_done = devc->fw_updated;
+ reset_done += 1800 * 1000; /* 1.8 seconds */
now = g_get_monotonic_time();
if (reset_done > now)
g_usleep(reset_done - now);
@@ -375,7 +378,7 @@ static int dev_open(struct sr_dev_inst *sdi)
}
if (ret != SR_OK) {
- sr_err("Unable to open device.");
+ sr_err("Cannot open device.");
return SR_ERR;
}
@@ -420,9 +423,11 @@ static int config_get(uint32_t key, GVariant **data,
if (!sdi->conn)
return SR_ERR_ARG;
usb = sdi->conn;
- if (usb->address == 255) {
- /* Device still needs to re-enumerate after firmware
- * upload, so we don't know its (future) address. */
+ if (usb->address == 0xff) {
+ /*
+ * Device still needs to re-enumerate after firmware
+ * upload, so we don't know its (future) address.
+ */
return SR_ERR;
}
*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
@@ -573,13 +578,13 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
devc = sdi->priv;
if (configure_channels(sdi) != SR_OK) {
- sr_err("Failed to configure channels.");
+ sr_err("Cannot configure channels.");
return SR_ERR;
}
devc->convbuffer_size = 4 * 1024 * 1024;
if (!(devc->convbuffer = g_try_malloc(devc->convbuffer_size))) {
- sr_err("Conversion buffer malloc failed.");
+ sr_err("Cannot allocate conversion buffer.");
return SR_ERR_MALLOC;
}