X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fkingst-la2016%2Fprotocol.h;h=c308005e3535cb02581da8bea5ffe3440ede2e32;hb=6d53e9497892df15e13899465ce4c2962a70a782;hp=4a35c9ee95f0347a31711e45b2e9f6cdeaa3ebaa;hpb=1ed93110c3c31233dfce10ed6e67e21ecfcdae7d;p=libsigrok.git

diff --git a/src/hardware/kingst-la2016/protocol.h b/src/hardware/kingst-la2016/protocol.h
index 4a35c9ee..c308005e 100644
--- a/src/hardware/kingst-la2016/protocol.h
+++ b/src/hardware/kingst-la2016/protocol.h
@@ -30,8 +30,11 @@
 
 #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
@@ -43,87 +46,117 @@
 #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)
+#define LA2016_NUM_SAMPLES_MAX	(UINT64_C(10 * 1000 * 1000 * 1000))
+
+/* Maximum device capabilities. May differ between models. */
+#define MAX_PWM_FREQ		SR_MHZ(20)
+#define PWM_CLOCK		SR_MHZ(200)	/* 200MHz for both LA2016 and LA1016 */
+
+#define LA2016_NUM_PWMCH_MAX	2
+
+#define LA2016_CONVBUFFER_SIZE	(4 * 1024 * 1024)
 
-typedef struct pwm_setting_dev {
+struct kingst_model {
+	uint8_t magic;		/* EEPROM magic byte value. */
+	const char *name;	/* User perceived model name. */
+	const char *fpga_stem;	/* Bitstream filename stem. */
+	uint64_t samplerate;	/* Max samplerate in Hz. */
+	size_t channel_count;	/* Max channel count (16, 32). */
+	uint64_t memory_bits;	/* RAM capacity in Gbit (1, 2, 4). */
+};
+
+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;
-
-	int64_t fw_updated;
+	uint16_t usb_pid;
+	char *mcu_firmware;
+	char *fpga_bitstream;
+	uint64_t fw_uploaded; /* Timestamp of most recent FW upload. */
+	uint8_t identify_magic;
+	const struct kingst_model *model;
 
 	/* User specified parameters. */
-	pwm_setting_t pwm_setting[2];
-	unsigned int threshold_voltage_idx;
+	struct pwm_setting pwm_setting[LA2016_NUM_PWMCH_MAX];
+	size_t threshold_voltage_idx;
 	float threshold_voltage;
-	uint64_t max_samplerate;
 	uint64_t cur_samplerate;
-	uint64_t limit_samples;
+	struct sr_sw_limits sw_limits;
 	uint64_t capture_ratio;
-	uint16_t cur_channels;
-	int num_channels;
-
-	uint32_t bitstream_size;
-
-	/* Values derived from user specs. */
-	uint64_t pre_trigger_size;
 
 	/* Internal acquisition and download state. */
-	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;
+	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;
-	uint8_t *convbuffer;
+	struct feed_queue_logic *feed_queue;
 	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(const struct sr_dev_inst *sdi,
+	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);
 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);
+SR_PRIV int la2016_identify_device(const struct sr_dev_inst *sdi,
+	gboolean show_message);
+SR_PRIV int la2016_init_hardware(const struct sr_dev_inst *sdi);
+SR_PRIV int la2016_init_params(const struct sr_dev_inst *sdi);
+SR_PRIV int la2016_deinit_hardware(const struct sr_dev_inst *sdi);
 
 #endif