2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef LIBSIGROK_HARDWARE_OPENBENCH_LOGIC_SNIFFER_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_OPENBENCH_LOGIC_SNIFFER_PROTOCOL_H
26 #include "libsigrok.h"
27 #include "libsigrok-internal.h"
29 /* Message logging helpers with subsystem-specific prefix string. */
30 #define LOG_PREFIX "ols: "
31 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
32 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
33 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
34 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
35 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
36 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
39 #define NUM_TRIGGER_STAGES 4
40 #define TRIGGER_TYPE "01"
41 #define SERIAL_SPEED B115200
42 #define CLOCK_RATE SR_MHZ(100)
43 #define MIN_NUM_SAMPLES 4
44 #define DEFAULT_SAMPLERATE SR_KHZ(200)
47 #define CMD_RESET 0x00
49 #define CMD_TESTMODE 0x03
51 #define CMD_METADATA 0x04
52 #define CMD_SET_FLAGS 0x82
53 #define CMD_SET_DIVIDER 0x80
54 #define CMD_CAPTURE_SIZE 0x81
55 #define CMD_SET_TRIGGER_MASK_0 0xc0
56 #define CMD_SET_TRIGGER_MASK_1 0xc4
57 #define CMD_SET_TRIGGER_MASK_2 0xc8
58 #define CMD_SET_TRIGGER_MASK_3 0xcc
59 #define CMD_SET_TRIGGER_VALUE_0 0xc1
60 #define CMD_SET_TRIGGER_VALUE_1 0xc5
61 #define CMD_SET_TRIGGER_VALUE_2 0xc9
62 #define CMD_SET_TRIGGER_VALUE_3 0xcd
63 #define CMD_SET_TRIGGER_CONFIG_0 0xc2
64 #define CMD_SET_TRIGGER_CONFIG_1 0xc6
65 #define CMD_SET_TRIGGER_CONFIG_2 0xca
66 #define CMD_SET_TRIGGER_CONFIG_3 0xce
68 /* Bitmasks for CMD_FLAGS */
69 #define FLAG_DEMUX 0x01
70 #define FLAG_FILTER 0x02
71 #define FLAG_CHANNELGROUP_1 0x04
72 #define FLAG_CHANNELGROUP_2 0x08
73 #define FLAG_CHANNELGROUP_3 0x10
74 #define FLAG_CHANNELGROUP_4 0x20
75 #define FLAG_CLOCK_EXTERNAL 0x40
76 #define FLAG_CLOCK_INVERTED 0x80
77 #define FLAG_RLE 0x0100
78 #define FLAG_SWAP_PROBES 0x0200
79 #define FLAG_EXTERNAL_TEST_MODE 0x0400
80 #define FLAG_INTERNAL_TEST_MODE 0x0800
82 /* Private, per-device-instance driver context. */
84 /* Fixed device settings */
87 uint32_t max_samplerate;
88 uint32_t protocol_version;
90 /* Acquisition settings */
91 uint64_t cur_samplerate;
92 uint32_t cur_samplerate_divider;
93 uint64_t limit_samples;
97 uint32_t trigger_mask[4];
98 uint32_t trigger_value[4];
102 /* Operational states */
103 unsigned int num_transfers;
104 unsigned int num_samples;
107 /* Temporary variables */
108 unsigned int rle_count;
109 unsigned char sample[4];
110 unsigned char tmp_sample[4];
111 unsigned char *raw_sample_buf;
115 SR_PRIV extern const char *ols_probe_names[NUM_PROBES + 1];
117 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
119 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
120 uint8_t command, uint32_t data);
121 SR_PRIV int ols_configure_probes(const struct sr_dev_inst *sdi);
122 SR_PRIV uint32_t reverse16(uint32_t in);
123 SR_PRIV uint32_t reverse32(uint32_t in);
124 SR_PRIV struct dev_context *ols_dev_new(void);
125 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
126 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
127 uint64_t samplerate);
128 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
129 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);