kingst-la2016: keep FPGA active after device close

[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 8b1121ec726eea19f2b86ab1ee3c718aaf0150f9..3b251ed1d16aef4d1863168b6f061328e9ad1d44 100644 (file)
--- a/src/hardware/kingst-la2016/protocol.h
+++ b/src/hardware/kingst-la2016/protocol.h
@@ -66,6 +66,15 @@
  */
 #define LA2016_EP2_PADDING     2048
 
+/*
+ * Whether the logic input threshold voltage is a config item of the
+ * "Logic" channel group or a global config item of the device. Ideally
+ * it would be the former (being strictly related to the Logic channels)
+ * but mainline applications work better with the latter, and many other
+ * device drivers implement it that way, too.
+ */
+#define WITH_THRESHOLD_DEVCFG  1
+
 #define LA2016_THR_VOLTAGE_MIN 0.40
 #define LA2016_THR_VOLTAGE_MAX 4.00
 
@@ -77,6 +86,14 @@
 
 #define LA2016_NUM_PWMCH_MAX   2
 
+/*
+ * Whether to de-initialize the device hardware in the driver's close
+ * callback. It is desirable to e.g. configure PWM channels and leave
+ * the generator running after the application shuts down. Users can
+ * always disable channels on their way out if they want to.
+ */
+#define WITH_DEINIT_IN_CLOSE   0
+
 #define LA2016_CONVBUFFER_SIZE (4 * 1024 * 1024)
 
 struct kingst_model {
@@ -88,33 +105,6 @@ struct kingst_model {
        uint64_t memory_bits;   /* RAM capacity in Gbit (1, 2, 4). */
 };
 
-struct pwm_setting_dev {
-       uint32_t period;
-       uint32_t duty;
-};
-
-struct trigger_cfg {
-       uint32_t channels;
-       uint32_t enabled;
-       uint32_t level;
-       uint32_t high_or_falling;
-};
-
-struct capture_info {
-       uint32_t n_rep_packets;
-       uint32_t n_rep_packets_before_trigger;
-       uint32_t write_pos;
-};
-
-#define NUM_PACKETS_IN_CHUNK   5
-#define TRANSFER_PACKET_LENGTH 16
-
-struct pwm_setting {
-       gboolean enabled;
-       float freq;
-       float duty;
-};
-
 struct dev_context {
        uint16_t usb_pid;
        char *mcu_firmware;
@@ -122,12 +112,16 @@ struct dev_context {
        uint64_t fw_uploaded; /* Timestamp of most recent FW upload. */
        uint8_t identify_magic;
        const struct kingst_model *model;
+       struct sr_channel_group *cg_logic, *cg_pwm;
 
        /* User specified parameters. */
-       struct pwm_setting pwm_setting[LA2016_NUM_PWMCH_MAX];
+       struct pwm_setting {
+               gboolean enabled;
+               float freq;
+               float duty;
+       } pwm_setting[LA2016_NUM_PWMCH_MAX];
        size_t threshold_voltage_idx;
-       float threshold_voltage;
-       uint64_t cur_samplerate;
+       uint64_t samplerate;
        struct sr_sw_limits sw_limits;
        uint64_t capture_ratio;
 
@@ -135,7 +129,11 @@ struct dev_context {
        gboolean trigger_involved;
        gboolean completion_seen;
        gboolean download_finished;
-       struct capture_info info;
+       struct capture_info {
+               uint32_t n_rep_packets;
+               uint32_t n_rep_packets_before_trigger;
+               uint32_t write_pos;
+       } 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;
@@ -149,13 +147,15 @@ struct dev_context {
 
 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_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_deinit_hardware(const struct sr_dev_inst *sdi);
+SR_PRIV int la2016_write_pwm_config(const struct sr_dev_inst *sdi, size_t idx);
+SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi,
+       double voltage);
 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_identify_device(const struct sr_dev_inst *sdi,
-       gboolean show_message);
-SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi);
-SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi);
 
 #endif