kingst-la2016: rephrase comments for style, readability, and text length

[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 0de7a566b0a7cd443dc4966bbf128d90cb166ed6..cc5776f7dfd311b617018d38a78ffc9a28e4bbbb 100644 (file)
--- a/src/hardware/kingst-la2016/protocol.h
+++ b/src/hardware/kingst-la2016/protocol.h
@@ -23,37 +23,34 @@
 #ifndef LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
 #define LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
 
-#include <glib.h>
 #include <libsigrok/libsigrok.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.
+ * 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 /* endpoint 6 max packet size */
-#define LA2016_USB_BUFSZ       (256 * 2 * LA2016_EP6_PKTSZ) /* 256KB buffer */
+#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;
@@ -73,8 +70,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;
@@ -86,6 +83,8 @@ 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;
@@ -98,10 +97,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;