X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fapi.c;h=4d501450e9a3fa40a412dbeaea2efb8a592e7d01;hb=22cb067ab034ab95111f5bc388413dd244f64492;hp=3296a756bcf1f3588b0f974bbf4497c4ddc4fbf8;hpb=3ebc1cb204f4c81b0847d11b0f26b34e08731d34;p=libsigrok.git
diff --git a/src/hardware/kingst-la2016/api.c b/src/hardware/kingst-la2016/api.c
index 3296a756..4d501450 100644
--- a/src/hardware/kingst-la2016/api.c
+++ b/src/hardware/kingst-la2016/api.c
@@ -20,15 +20,16 @@
* 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
+
#include "libsigrok-internal.h"
#include "protocol.h"
@@ -141,7 +142,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
unsigned int i, j;
const char *conn;
char connection_id[64];
- int64_t fw_updated;
+ uint64_t fw_uploaded;
unsigned int dev_addr;
drvc = di->context;
@@ -160,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++) {
@@ -173,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;
}
}
@@ -187,25 +190,26 @@ 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;
sdi->connection_id = g_strdup(connection_id);
- fw_updated = 0;
+ fw_uploaded = 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 */
+ fw_uploaded = g_get_monotonic_time();
+ /* Will re-enumerate. Mark as "unknown address yet". */
+ dev_addr = 0xff;
}
sdi->vendor = g_strdup("Kingst");
@@ -218,7 +222,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
devc = g_malloc0(sizeof(struct dev_context));
sdi->priv = devc;
- devc->fw_updated = fw_updated;
+ devc->fw_uploaded = fw_uploaded;
devc->threshold_voltage_idx = 0;
devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];
@@ -263,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;
@@ -289,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) {
@@ -298,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;
}
@@ -333,47 +336,48 @@ static int la2016_dev_open(struct sr_dev_inst *sdi)
static int dev_open(struct sr_dev_inst *sdi)
{
struct dev_context *devc;
- int64_t timediff_us, timediff_ms;
- uint64_t reset_done;
- uint64_t now;
+ uint64_t reset_done, now, elapsed_ms;
int ret;
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 has uploaded MCU firmware,
+ * then wait for the FX2 to re-enumerate. Allow the USB device
+ * to vanish before it reappears. Timeouts are rough estimates
+ * after all, the imprecise time of the last check (potentially
+ * executes after the total check period) simplifies code paths
+ * with optional diagnostics. And increases the probability of
+ * successfully detecting "late/slow" devices.
*/
- ret = SR_ERR;
- if (devc->fw_updated > 0) {
+ if (devc->fw_uploaded) {
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 */
now = g_get_monotonic_time();
- if (reset_done > now)
+ reset_done = devc->fw_uploaded + RENUM_GONE_DELAY_MS * 1000;
+ if (now < reset_done)
g_usleep(reset_done - now);
- timediff_ms = 0;
- while (timediff_ms < MAX_RENUM_DELAY_MS) {
- g_usleep(200 * 1000);
-
- timediff_us = g_get_monotonic_time() - devc->fw_updated;
- timediff_ms = timediff_us / 1000;
-
- if ((ret = la2016_dev_open(sdi)) == SR_OK)
+ do {
+ now = g_get_monotonic_time();
+ elapsed_ms = (now - devc->fw_uploaded) / 1000;
+ sr_spew("Waited %" PRIu64 "ms.", elapsed_ms);
+ ret = la2016_dev_open(sdi);
+ if (ret == SR_OK) {
+ devc->fw_uploaded = 0;
break;
- sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
- }
+ }
+ g_usleep(RENUM_POLL_INTERVAL_MS * 1000);
+ } while (elapsed_ms < RENUM_CHECK_PERIOD_MS);
if (ret != SR_OK) {
sr_err("Device failed to re-enumerate.");
return SR_ERR;
}
- sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
+ sr_info("Device came back after %" PRIi64 "ms.", elapsed_ms);
} else {
ret = la2016_dev_open(sdi);
}
if (ret != SR_OK) {
- sr_err("Unable to open device.");
+ sr_err("Cannot open device.");
return SR_ERR;
}
@@ -418,9 +422,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);
@@ -514,8 +520,7 @@ static int config_list(uint32_t key, GVariant **data,
devc = sdi->priv;
if (devc->max_samplerate == SR_MHZ(200)) {
*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la2016));
- }
- else {
+ } else {
*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la1016));
}
break;
@@ -571,13 +576,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;
}