kingst-la2016: complete hardware setup in probe, set features in open

[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 6d3cf2641cae298f8ba67af3c70f6e73effc10b7..c308005e3535cb02581da8bea5ffe3440ede2e32 100644 (file)
--- 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
@@ -66,78 +69,94 @@
 #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))
 
-typedef struct pwm_setting_dev {
+/* 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)
+
+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;
-       uint64_t fw_uploaded;
+       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;
-
-       /* 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