X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fprotocol.h;h=b0dc3d04845912d2f28535dd88cfb4fb218bb7a6;hb=480efba284cbf84801af16d1997ce853d7fe5c63;hp=4065e6bca0c8b5f092facc7ec20e40139953091b;hpb=e9430410c4fe1f7376062a718e365e31ff0bf254;p=libsigrok.git

diff --git a/src/hardware/kingst-la2016/protocol.h b/src/hardware/kingst-la2016/protocol.h
index 4065e6bc..b0dc3d04 100644
--- a/src/hardware/kingst-la2016/protocol.h
+++ b/src/hardware/kingst-la2016/protocol.h
@@ -30,60 +30,85 @@
 
 #define LA2016_VID		0x77a1
 #define LA2016_PID		0x01a2
+#define LA2016_IPRODUCT_INDEX	2
 #define USB_INTERFACE		0
 #define USB_CONFIGURATION	1
+#define USB_EP_FPGA_BITSTREAM	2
+#define USB_EP_CAPTURE_DATA	6
 
 /*
  * 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
+
+/*
+ * The device expects some zero padding to follow the content of the
+ * file which contains the FPGA bitstream. Specify the chunk size here.
+ */
+#define LA2016_EP2_PADDING	2048
+
 #define LA2016_THR_VOLTAGE_MIN	0.40
 #define LA2016_THR_VOLTAGE_MAX	4.00
 
 #define LA2016_NUM_SAMPLES_MIN	256
 #define LA2016_NUM_SAMPLES_MAX	(10UL * 1000 * 1000 * 1000)
 
-typedef struct pwm_setting_dev {
+#define LA2016_NUM_PWMCH_MAX	2
+
+#define LA2016_CONVBUFFER_SIZE	(4 * 1024 * 1024)
+
+struct pwm_setting_dev {
 	uint32_t period;
 	uint32_t duty;
-} pwm_setting_dev_t;
+};
 
-typedef struct trigger_cfg {
+struct trigger_cfg {
 	uint32_t channels;
 	uint32_t enabled;
 	uint32_t level;
 	uint32_t high_or_falling;
-} trigger_cfg_t;
+};
 
-typedef struct capture_info {
+struct capture_info {
 	uint32_t n_rep_packets;
 	uint32_t n_rep_packets_before_trigger;
 	uint32_t write_pos;
-} capture_info_t;
+};
 
 #define NUM_PACKETS_IN_CHUNK	5
 #define TRANSFER_PACKET_LENGTH	16
 
-typedef struct pwm_setting {
-	uint8_t enabled;
+struct pwm_setting {
+	gboolean enabled;
 	float freq;
 	float duty;
-} pwm_setting_t;
+};
 
 struct dev_context {
 	struct sr_context *ctx;
+	uint64_t fw_uploaded;
 
-	int64_t fw_updated;
-	pwm_setting_t pwm_setting[2];
+	/* User specified parameters. */
+	struct pwm_setting pwm_setting[LA2016_NUM_PWMCH_MAX];
 	unsigned int threshold_voltage_idx;
 	float threshold_voltage;
 	uint64_t max_samplerate;
@@ -91,31 +116,26 @@ struct dev_context {
 	uint64_t limit_samples;
 	uint64_t capture_ratio;
 	uint16_t cur_channels;
-	int num_channels;
-
-	uint32_t bitstream_size;
-
-	/* derived stuff */
-	uint64_t pre_trigger_size;
-
-	/* state after sampling */
-	int had_triggers_configured;
-	int have_trigger;
-	int transfer_finished;
-	capture_info_t info;
-	unsigned int n_transfer_packets_to_read; /* each with 5 acq packets */
-	unsigned int n_bytes_to_read;
-	unsigned int n_reps_until_trigger;
-	unsigned int reading_behind_trigger;
+
+	/* Internal acquisition and download state. */
+	gboolean trigger_involved;
+	gboolean completion_seen;
+	gboolean download_finished;
+	struct capture_info info;
+	uint32_t n_transfer_packets_to_read; /* each with 5 acq packets */
+	uint32_t n_bytes_to_read;
+	uint32_t n_reps_until_trigger;
+	gboolean trigger_marked;
 	uint64_t total_samples;
 	uint32_t read_pos;
 
-	unsigned int convbuffer_size;
+	size_t convbuffer_size;
 	uint8_t *convbuffer;
 	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);