X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fprotocol.h;h=8ea01809e439ccc7aa4743a0af02b9a9897db2c8;hb=22cb067ab034ab95111f5bc388413dd244f64492;hp=7518cb759f9a768cb373a78ca885fdfaa0f6d652;hpb=c3d4003710edfe193de072f6032401bcba098672;p=libsigrok.git

diff --git a/src/hardware/kingst-la2016/protocol.h b/src/hardware/kingst-la2016/protocol.h
index 7518cb75..8ea01809 100644
--- a/src/hardware/kingst-la2016/protocol.h
+++ b/src/hardware/kingst-la2016/protocol.h
@@ -23,28 +23,45 @@
 #ifndef LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
 #define LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
 
-#include <stdint.h>
-#include <glib.h>
 #include <libsigrok/libsigrok.h>
-#include "libsigrok-internal.h"
+#include <stdint.h>
 
-#define LOG_PREFIX "kingst-la2016"
+#define LOG_PREFIX	"kingst-la2016"
 
 #define LA2016_VID		0x77a1
 #define LA2016_PID		0x01a2
 #define USB_INTERFACE		0
 #define USB_CONFIGURATION	1
 
-#define LA2016_BULK_MAX         8388608
+/*
+ * 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.
+ */
+#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
-#define DEFAULT_TIMEOUT_MS      200
+/* 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
+#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)
+#define LA2016_NUM_SAMPLES_MIN	256
+#define LA2016_NUM_SAMPLES_MAX	(10UL * 1000 * 1000 * 1000)
 
 typedef struct pwm_setting_dev {
 	uint32_t period;
@@ -64,8 +81,8 @@ typedef struct capture_info {
 	uint32_t write_pos;
 } capture_info_t;
 
-#define NUM_PACKETS_IN_CHUNK 5
-#define TRANSFER_PACKET_LENGTH 16
+#define NUM_PACKETS_IN_CHUNK	5
+#define TRANSFER_PACKET_LENGTH	16
 
 typedef struct pwm_setting {
 	uint8_t enabled;
@@ -75,11 +92,13 @@ 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;
+	uint64_t max_samplerate;
 	uint64_t cur_samplerate;
 	uint64_t limit_samples;
 	uint64_t capture_ratio;
@@ -88,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;
@@ -108,13 +127,12 @@ 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_stop_acquisition(const struct sr_dev_inst *sdi);
 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);
-SR_PRIV int la2016_has_triggered(const struct sr_dev_inst *sdi);
-SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfer_cb_fn cb);
+SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data);
 SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi);
 SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi);