kingst-la2016: rephrase USB renum code path after firmware upload

[libsigrok.git] / src / hardware / kingst-la2016 / protocol.h

diff --git a/src/hardware/kingst-la2016/protocol.h b/src/hardware/kingst-la2016/protocol.h
index 4065e6bca0c8b5f092facc7ec20e40139953091b..8ea01809e439ccc7aa4743a0af02b9a9897db2c8 100644 (file)
--- a/src/hardware/kingst-la2016/protocol.h
+++ b/src/hardware/kingst-la2016/protocol.h
@@ -36,16 +36,27 @@
 /*
  * On Windows sigrok uses WinUSB RAW_IO policy which requires the
  * USB transfer buffer size to be a multiple of the endpoint max packet
- * size, which is 512 bytes in this case. Also, the maximum allowed size of
- * the transfer buffer is normally read from WinUSB_GetPipePolicy API but
- * libusb does not expose this function. Typically, max size is 2MB.
+ * size, which is 512 bytes in this case. Also, the maximum allowed size
+ * of the transfer buffer is normally read from WinUSB_GetPipePolicy API
+ * but libusb does not expose this function. Typically, max size is 2MB.
  */
-#define LA2016_EP6_PKTSZ       512 /* endpoint 6 max packet size */
-#define LA2016_USB_BUFSZ       (256 * 2 * LA2016_EP6_PKTSZ) /* 256KB buffer */
+#define LA2016_EP6_PKTSZ       512 /* Max packet size of USB endpoint 6. */
+#define LA2016_USB_BUFSZ       (256 * 2 * LA2016_EP6_PKTSZ) /* 256KiB buffer. */
 
-#define MAX_RENUM_DELAY_MS     3000
+/* USB communication timeout during regular operation. */
 #define DEFAULT_TIMEOUT_MS     200
 
+/*
+ * Check for MCU firmware to take effect after upload. Check the device
+ * presence for a maximum period of time, delay between checks in that
+ * phase. Allow for the device to vanish after upload and before checks,
+ * to not mistake its earlier incarnation for the successful operation
+ * of the most recently loaded firmware.
+ */
+#define RENUM_CHECK_PERIOD_MS  3000
+#define RENUM_GONE_DELAY_MS    1800
+#define RENUM_POLL_INTERVAL_MS 200
+
 #define LA2016_THR_VOLTAGE_MIN 0.40
 #define LA2016_THR_VOLTAGE_MAX 4.00
 
@@ -81,8 +92,9 @@ typedef struct pwm_setting {
 
 struct dev_context {
        struct sr_context *ctx;
+       uint64_t fw_uploaded;
 
-       int64_t fw_updated;
+       /* User specified parameters. */
        pwm_setting_t pwm_setting[2];
        unsigned int threshold_voltage_idx;
        float threshold_voltage;
@@ -95,10 +107,10 @@ struct dev_context {
 
        uint32_t bitstream_size;
 
-       /* derived stuff */
+       /* Values derived from user specs. */
        uint64_t pre_trigger_size;
 
-       /* state after sampling */
+       /* Internal acquisition and download state. */
        int had_triggers_configured;
        int have_trigger;
        int transfer_finished;
@@ -115,7 +127,8 @@ struct dev_context {
        struct libusb_transfer *transfer;
 };
 
-SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id);
+SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx,
+       libusb_device *dev, uint16_t product_id);
 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi);
 SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi);
 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);