ols: Rename "flags" to "capture flags".

[libsigrok.git] / src / hardware / openbench-logic-sniffer / protocol.h

diff --git a/src/hardware/openbench-logic-sniffer/protocol.h b/src/hardware/openbench-logic-sniffer/protocol.h
index 6e5d61fe2af8d49dc9b97516f17a18ac0b052c4f..fa78ca79a1ea9c624e5a1644b729796f5c7580cb 100644 (file)
--- a/src/hardware/openbench-logic-sniffer/protocol.h
+++ b/src/hardware/openbench-logic-sniffer/protocol.h
@@ -23,14 +23,12 @@
 #include <stdint.h>
 #include <string.h>
 #include <glib.h>
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
-#define LOG_PREFIX "ols"
+#define LOG_PREFIX "openbench-logic-sniffer"
 
-#define NUM_CHANNELS               32
 #define NUM_TRIGGER_STAGES         4
-#define SERIAL_SPEED               B115200
 #define CLOCK_RATE                 SR_MHZ(100)
 #define MIN_NUM_SAMPLES            4
 #define DEFAULT_SAMPLERATE         SR_KHZ(200)
@@ -38,12 +36,13 @@
 /* Command opcodes */
 #define CMD_RESET                  0x00
 #define CMD_RUN                    0x01
-#define CMD_TESTMODE               0x03
 #define CMD_ID                     0x02
 #define CMD_METADATA               0x04
-#define CMD_SET_FLAGS              0x82
 #define CMD_SET_DIVIDER            0x80
 #define CMD_CAPTURE_SIZE           0x81
+#define CMD_SET_FLAGS              0x82
+#define CMD_CAPTURE_DELAYCOUNT     0x83                /* extension for Pepino */
+#define CMD_CAPTURE_READCOUNT      0x84                /* extension for Pepino */
 #define CMD_SET_TRIGGER_MASK       0xc0
 #define CMD_SET_TRIGGER_VALUE      0xc1
 #define CMD_SET_TRIGGER_CONFIG     0xc2
@@ -51,42 +50,43 @@
 /* Trigger config */
 #define TRIGGER_START              (1 << 3)
 
-/* Bitmasks for CMD_FLAGS */
+/* Bitmasks for capture_flags */
 /* 12-13 unused, 14-15 RLE mode (we hardcode mode 0). */
-#define FLAG_INTERNAL_TEST_MODE    (1 << 11)
-#define FLAG_EXTERNAL_TEST_MODE    (1 << 10)
-#define FLAG_SWAP_CHANNELS         (1 << 9)
-#define FLAG_RLE                   (1 << 8)
-#define FLAG_SLOPE_FALLING         (1 << 7)
-#define FLAG_CLOCK_EXTERNAL        (1 << 6)
-#define FLAG_CHANNELGROUP_4        (1 << 5)
-#define FLAG_CHANNELGROUP_3        (1 << 4)
-#define FLAG_CHANNELGROUP_2        (1 << 3)
-#define FLAG_CHANNELGROUP_1        (1 << 2)
-#define FLAG_FILTER                (1 << 1)
-#define FLAG_DEMUX                 (1 << 0)
+#define CAPTURE_FLAG_INTERNAL_TEST_MODE (1 << 11)
+#define CAPTURE_FLAG_EXTERNAL_TEST_MODE (1 << 10)
+#define CAPTURE_FLAG_SWAP_CHANNELS      (1 << 9)
+#define CAPTURE_FLAG_RLE                (1 << 8)
+#define CAPTURE_FLAG_SLOPE_FALLING      (1 << 7)
+#define CAPTURE_FLAG_CLOCK_EXTERNAL     (1 << 6)
+#define CAPTURE_FLAG_CHANNELGROUP_4     (1 << 5)
+#define CAPTURE_FLAG_CHANNELGROUP_3     (1 << 4)
+#define CAPTURE_FLAG_CHANNELGROUP_2     (1 << 3)
+#define CAPTURE_FLAG_CHANNELGROUP_1     (1 << 2)
+#define CAPTURE_FLAG_NOISE_FILTER       (1 << 1)
+#define CAPTURE_FLAG_DEMUX              (1 << 0)
+
+/* Capture context magic numbers */
+#define OLS_NO_TRIGGER (-1)
 
-/* Private, per-device-instance driver context. */
 struct dev_context {
-       /* Fixed device settings */
+       /* constant device properties: */
        int max_channels;
        uint32_t max_samples;
        uint32_t max_samplerate;
        uint32_t protocol_version;
 
-       /* Acquisition settings */
+       /* acquisition-related properties: */
        uint64_t cur_samplerate;
        uint32_t cur_samplerate_divider;
        uint64_t limit_samples;
-       int capture_ratio;
-       int trigger_at;
+       uint64_t capture_ratio;
+       int trigger_at_smpl;
        uint32_t channel_mask;
        uint32_t trigger_mask[NUM_TRIGGER_STAGES];
        uint32_t trigger_value[NUM_TRIGGER_STAGES];
        int num_stages;
-       uint16_t flag_reg;
+       uint16_t capture_flags;
 
-       /* Operational states */
        unsigned int num_transfers;
        unsigned int num_samples;
        int num_bytes;
@@ -94,7 +94,6 @@ struct dev_context {
        int cnt_samples;
        int cnt_samples_rle;
 
-       /* Temporary variables */
        unsigned int rle_count;
        unsigned char sample[4];
        unsigned char tmp_sample[4];
@@ -107,6 +106,7 @@ SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
                uint8_t command);
 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
                uint8_t command, uint8_t *data);
+SR_PRIV int ols_send_reset(struct sr_serial_dev_inst *serial);
 SR_PRIV void ols_channel_mask(const struct sr_dev_inst *sdi);
 SR_PRIV int ols_convert_trigger(const struct sr_dev_inst *sdi);
 SR_PRIV struct dev_context *ols_dev_new(void);