]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/kingst-la2016/protocol.h
kingst-la2016: rephrase comments for style, readability, and text length
[libsigrok.git] / src / hardware / kingst-la2016 / protocol.h
index e7ad010e073af0387569c28518de2c5c895210f0..cc5776f7dfd311b617018d38a78ffc9a28e4bbbb 100644 (file)
 #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"
-
-#define LOG_PREFIX "kingst-la2016"
+#include <stdint.h>
 
-/* device is little endian */
+#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
+#define DEFAULT_TIMEOUT_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;
        uint32_t duty;
-} __attribute__((__packed__)) pwm_setting_dev_t;
+} pwm_setting_dev_t;
 
 typedef struct trigger_cfg {
        uint32_t channels;
        uint32_t enabled;
        uint32_t level;
        uint32_t high_or_falling;
-} __attribute__((__packed__)) trigger_cfg_t;
-
-typedef struct sample_config {
-       uint32_t sample_depth;
-       uint32_t psa;
-       uint16_t u1;
-       uint32_t u2;
-       uint16_t clock_divisor;
-} __attribute__((__packed__)) sample_config_t;
+} trigger_cfg_t;
 
 typedef struct capture_info {
        uint32_t n_rep_packets;
        uint32_t n_rep_packets_before_trigger;
        uint32_t write_pos;
-} __attribute__((__packed__)) capture_info_t;
+} capture_info_t;
 
-typedef struct acq_packet {
-       uint16_t state;
-       uint8_t repetitions;
-} __attribute__((__packed__)) acq_packet_t;
-
-typedef struct transfer_packet {
-       acq_packet_t packet[5];
-       uint8_t seq;
-} __attribute__((__packed__)) transfer_packet_t;
+#define NUM_PACKETS_IN_CHUNK   5
+#define TRANSFER_PACKET_LENGTH 16
 
 typedef struct pwm_setting {
        uint8_t enabled;
        float freq;
        float duty;
-       pwm_setting_dev_t dev;
 } pwm_setting_t;
 
 struct dev_context {
        struct sr_context *ctx;
 
        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;
        uint16_t cur_channels;
        int num_channels;
 
-       /* derived stuff */
+       uint32_t bitstream_size;
+
+       /* 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;
@@ -126,62 +120,9 @@ struct dev_context {
 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);
 
-#ifndef WORDS_BIGENDIAN
-/* this host is big-endian, need to swap from/to device inplace */
-#define inplace_WL32(obj) do { uint32_t tmp = obj; WL32(&(obj), tmp); } while (0)
-#define inplace_RL32(obj) obj = RL32(&(obj))
-#define inplace_WL16(obj) do { uint16_t tmp = obj; WL16(&(obj), tmp); } while (0)
-#define inplace_RL16(obj) obj = RL16(&(obj))
-
-#define pwm_setting_dev_le(obj) do {           \
-               inplace_WL32((obj).period);     \
-               inplace_WL32((obj).duty);       \
-       } while (0)
-#define trigger_cfg_le(obj) do {                       \
-               inplace_WL32((obj).channels);           \
-               inplace_WL32((obj).enabled);            \
-               inplace_WL32((obj).level);              \
-               inplace_WL32((obj).high_or_falling);    \
-       } while (0)
-#define sample_config_le(obj) do {                     \
-               inplace_WL32((obj).sample_depth);       \
-               inplace_WL32((obj).psa);                \
-               inplace_WL16((obj).u1);                 \
-               inplace_WL32((obj).u2);                 \
-               inplace_WL16((obj).clock_divisor);      \
-       } while (0)
-
-#define capture_info_host(obj) do {                                    \
-               inplace_RL32((obj).n_rep_packets);                      \
-               inplace_RL32((obj).n_rep_packets_before_trigger);       \
-               inplace_RL32((obj).write_pos);                          \
-       } while (0)
-#define acq_packet_host(obj)                   \
-       inplace_RL16((obj).state)
-#define transfer_packet_host(obj) do {                 \
-               acq_packet_host((obj).packet[0]);       \
-               acq_packet_host((obj).packet[1]);       \
-               acq_packet_host((obj).packet[2]);       \
-               acq_packet_host((obj).packet[3]);       \
-               acq_packet_host((obj).packet[4]);       \
-       } while (0)
-
-#else
-/* this host is little-endian, same as device */
-#define pwm_setting_dev_le(obj)   (void)obj
-#define trigger_cfg_le(obj)       (void)obj
-#define sample_config_le(obj)     (void)obj
-
-#define capture_info_host(obj)    (void)obj
-#define acq_packet_host(obj)      (void)obj
-#define transfer_packet_host(obj) (void)obj
-#endif
-
 #endif