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 #define LOG_PREFIX "ols"
32 #define NUM_TRIGGER_STAGES 4
33 #define TRIGGER_TYPE "01"
34 #define SERIAL_SPEED B115200
35 #define CLOCK_RATE SR_MHZ(100)
36 #define MIN_NUM_SAMPLES 4
37 #define DEFAULT_SAMPLERATE SR_KHZ(200)
40 #define CMD_RESET 0x00
42 #define CMD_TESTMODE 0x03
44 #define CMD_METADATA 0x04
45 #define CMD_SET_FLAGS 0x82
46 #define CMD_SET_DIVIDER 0x80
47 #define CMD_CAPTURE_SIZE 0x81
48 #define CMD_SET_TRIGGER_MASK 0xc0
49 #define CMD_SET_TRIGGER_VALUE 0xc1
50 #define CMD_SET_TRIGGER_CONFIG 0xc2
53 #define TRIGGER_START (1 << 3)
55 /* Bitmasks for CMD_FLAGS */
56 /* 12-13 unused, 14-15 RLE mode (we hardcode mode 0). */
57 #define FLAG_INTERNAL_TEST_MODE (1 << 11)
58 #define FLAG_EXTERNAL_TEST_MODE (1 << 10)
59 #define FLAG_SWAP_PROBES (1 << 9)
60 #define FLAG_RLE (1 << 8)
61 #define FLAG_SLOPE_FALLING (1 << 7)
62 #define FLAG_CLOCK_EXTERNAL (1 << 6)
63 #define FLAG_CHANNELGROUP_4 (1 << 5)
64 #define FLAG_CHANNELGROUP_3 (1 << 4)
65 #define FLAG_CHANNELGROUP_2 (1 << 3)
66 #define FLAG_CHANNELGROUP_1 (1 << 2)
67 #define FLAG_FILTER (1 << 1)
68 #define FLAG_DEMUX (1 << 0)
70 /* Private, per-device-instance driver context. */
72 /* Fixed device settings */
75 uint32_t max_samplerate;
76 uint32_t protocol_version;
78 /* Acquisition settings */
79 uint64_t cur_samplerate;
80 uint32_t cur_samplerate_divider;
81 uint64_t limit_samples;
85 uint32_t trigger_mask[4];
86 uint32_t trigger_value[4];
90 /* Operational states */
91 unsigned int num_transfers;
92 unsigned int num_samples;
98 /* Temporary variables */
99 unsigned int rle_count;
100 unsigned char sample[4];
101 unsigned char tmp_sample[4];
102 unsigned char *raw_sample_buf;
106 SR_PRIV extern const char *ols_probe_names[NUM_PROBES + 1];
108 SR_PRIV int send_shortcommand(struct sr_serial_dev_inst *serial,
110 SR_PRIV int send_longcommand(struct sr_serial_dev_inst *serial,
111 uint8_t command, uint8_t *data);
112 SR_PRIV int ols_configure_probes(const struct sr_dev_inst *sdi);
113 SR_PRIV struct dev_context *ols_dev_new(void);
114 SR_PRIV struct sr_dev_inst *get_metadata(struct sr_serial_dev_inst *serial);
115 SR_PRIV int ols_set_samplerate(const struct sr_dev_inst *sdi,
116 uint64_t samplerate);
117 SR_PRIV void abort_acquisition(const struct sr_dev_inst *sdi);
118 SR_PRIV int ols_receive_data(int fd, int revents, void *cb_data);