]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/openbench-logic-sniffer/protocol.h
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / hardware / openbench-logic-sniffer / protocol.h
index 873b3d8fbf0188477bf03875e9fc9e6d6f74f31c..00ed35bed177fdba2b031b8c5d579cbdd04b15fb 100644 (file)
 
 #define LOG_PREFIX "openbench-logic-sniffer"
 
-#define NUM_TRIGGER_STAGES         4
-#define CLOCK_RATE                 SR_MHZ(100)
-#define MIN_NUM_SAMPLES            4
-#define DEFAULT_SAMPLERATE         SR_KHZ(200)
+#define NUM_BASIC_TRIGGER_STAGES     4
+#define CLOCK_RATE                   SR_MHZ(100)
+#define MIN_NUM_SAMPLES              4
+#define DEFAULT_SAMPLERATE           SR_KHZ(200)
 
 /* Command opcodes */
-#define CMD_RESET                  0x00
-#define CMD_RUN                    0x01
-#define CMD_ID                     0x02
-#define CMD_TESTMODE               0x03
-#define CMD_METADATA               0x04
-#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
-
-/* Trigger config */
+#define CMD_RESET                     0x00
+#define CMD_ARM_BASIC_TRIGGER         0x01
+#define CMD_ID                        0x02
+#define CMD_METADATA                  0x04
+#define CMD_FINISH_NOW                0x05 /* extension of Demon Core */
+#define CMD_QUERY_INPUT_DATA          0x06 /* extension of Demon Core */
+#define CMD_QUERY_CAPTURE_STATE       0x07 /* extension of Demon Core */
+#define CMD_RETURN_CAPTURE_DATA       0x08 /* extension of Demon Core */
+#define CMD_ARM_ADVANCED_TRIGGER      0x0F /* extension of Demon Core */
+#define CMD_XON                       0x11
+#define CMD_XOFF                      0x13
+#define CMD_SET_DIVIDER               0x80
+#define CMD_CAPTURE_SIZE              0x81
+#define CMD_SET_FLAGS                 0x82
+#define CMD_CAPTURE_DELAYCOUNT        0x83 /* extension of Pepino */
+#define CMD_CAPTURE_READCOUNT         0x84 /* extension of Pepino */
+#define CMD_SET_ADVANCED_TRIG_SEL     0x9E /* extension of Demon Core */
+#define CMD_SET_ADVANCED_TRIG_WRITE   0x9F /* extension of Demon Core */
+#define CMD_SET_BASIC_TRIGGER_MASK0   0xC0 /* 4 stages: 0xC0, 0xC4, 0xC8, 0xCC */
+#define CMD_SET_BASIC_TRIGGER_VALUE0  0xC1 /* 4 stages: 0xC1, 0xC5, 0xC9, 0xCD */
+#define CMD_SET_BASIC_TRIGGER_CONFIG0 0xC2 /* 4 stages: 0xC2, 0xC6, 0xCA, 0xCE */
+
+/* Metadata tokens */
+#define METADATA_TOKEN_END                    0x0
+#define METADATA_TOKEN_DEVICE_NAME            0x1
+#define METADATA_TOKEN_FPGA_VERSION           0x2
+#define METADATA_TOKEN_ANCILLARY_VERSION      0x3
+#define METADATA_TOKEN_NUM_PROBES_LONG        0x20
+#define METADATA_TOKEN_SAMPLE_MEMORY_BYTES    0x21
+#define METADATA_TOKEN_DYNAMIC_MEMORY_BYTES   0x22
+#define METADATA_TOKEN_MAX_SAMPLE_RATE_HZ     0x23
+#define METADATA_TOKEN_PROTOCOL_VERSION_LONG  0x24
+#define METADATA_TOKEN_CAPABILITIES           0x25 /* not implemented in Demon Core v3.07 */
+#define METADATA_TOKEN_NUM_PROBES_SHORT       0x40
+#define METADATA_TOKEN_PROTOCOL_VERSION_SHORT 0x41
+
+/* Device config flags */
+#define DEVICE_FLAG_IS_DEMON_CORE (1 << 0)
+
+/* Basic Trigger Config */
 #define TRIGGER_START              (1 << 3)
 
-/* Bitmasks for CMD_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)
+/* Bit mask used for "set flags" command (0x82) */
+/* Take care about bit positions in diagrams, they are inverted. */
+#define CAPTURE_FLAG_RLEMODE1            (1 << 15)
+#define CAPTURE_FLAG_RLEMODE0            (1 << 14)
+#define CAPTURE_FLAG_RESERVED1           (1 << 13)
+#define CAPTURE_FLAG_RESERVED0           (1 << 12)
+#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_INVERT_EXT_CLOCK    (1 << 7)
+#define CAPTURE_FLAG_CLOCK_EXTERNAL      (1 << 6)
+#define CAPTURE_FLAG_DISABLE_CHANGROUP_4 (1 << 5)
+#define CAPTURE_FLAG_DISABLE_CHANGROUP_3 (1 << 4)
+#define CAPTURE_FLAG_DISABLE_CHANGROUP_2 (1 << 3)
+#define CAPTURE_FLAG_DISABLE_CHANGROUP_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)
 
 struct dev_context {
+       char **channel_names;
+
        /* constant device properties: */
-       int max_channels;
+       size_t max_channels;
        uint32_t max_samples;
        uint32_t max_samplerate;
        uint32_t protocol_version;
+       uint16_t device_flags;
 
        /* acquisition-related properties: */
        uint64_t cur_samplerate;
        uint32_t cur_samplerate_divider;
        uint64_t limit_samples;
        uint64_t capture_ratio;
-       int trigger_at;
-       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;
+       int trigger_at_smpl;
+       uint16_t capture_flags;
 
        unsigned int num_transfers;
        unsigned int num_samples;
@@ -94,23 +125,21 @@ struct dev_context {
 
        unsigned int rle_count;
        unsigned char sample[4];
-       unsigned char tmp_sample[4];
        unsigned char *raw_sample_buf;
 };
 
 SR_PRIV extern const char *ols_channel_names[];
 
 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);
+                             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);
-SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
+SR_PRIV int ols_prepare_acquisition(const struct sr_dev_inst *sdi);
+SR_PRIV uint32_t ols_channel_mask(const struct sr_dev_inst *sdi);
+SR_PRIV int ols_get_metadata(struct sr_dev_inst *sdi);
 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
-               uint64_t samplerate);
+                              uint64_t samplerate);
 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);