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_PIPISTRELLO_OLS_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_PIPISTRELLO_OLS_PROTOCOL_H
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
30 #define LOG_PREFIX "p-ols"
32 #define USB_VENDOR_ID 0x0403
33 #define USB_DEVICE_ID 0x6010
34 #define USB_VENDOR_NAME "Saanlima"
35 #define USB_IPRODUCT "Pipistrello LX45"
37 #define FTDI_BUF_SIZE (16 * 1024)
39 #define NUM_CHANNELS 32
40 #define NUM_TRIGGER_STAGES 4
41 #define CLOCK_RATE SR_MHZ(100)
42 #define MIN_NUM_SAMPLES 4
43 #define DEFAULT_SAMPLERATE SR_MHZ(100)
46 #define CMD_RESET 0x00
48 #define CMD_TESTMODE 0x03
50 #define CMD_METADATA 0x04
51 #define CMD_SET_DIVIDER 0x80
52 #define CMD_SET_FLAGS 0x82
53 #define CMD_CAPTURE_COUNT 0x83
54 #define CMD_CAPTURE_DELAY 0x84
55 #define CMD_SET_TRIGGER_MASK 0xc0
56 #define CMD_SET_TRIGGER_VALUE 0xc1
57 #define CMD_SET_TRIGGER_CONFIG 0xc2
58 #define CMD_SET_TRIGGER_EDGE 0xc3
61 #define TRIGGER_START (1 << 3)
63 /* Bitmasks for CMD_FLAGS */
64 /* 12-13 unused, 14-15 RLE mode (we hardcode mode 0). */
65 #define FLAG_INTERNAL_TEST_MODE (1 << 11)
66 #define FLAG_EXTERNAL_TEST_MODE (1 << 10)
67 #define FLAG_SWAP_CHANNELS (1 << 9)
68 #define FLAG_RLE (1 << 8)
69 #define FLAG_SLOPE_FALLING (1 << 7)
70 #define FLAG_CLOCK_EXTERNAL (1 << 6)
71 #define FLAG_CHANNELGROUP_4 (1 << 5)
72 #define FLAG_CHANNELGROUP_3 (1 << 4)
73 #define FLAG_CHANNELGROUP_2 (1 << 3)
74 #define FLAG_CHANNELGROUP_1 (1 << 2)
75 #define FLAG_FILTER (1 << 1)
76 #define FLAG_DEMUX (1 << 0)
78 /* Private, per-device-instance driver context. */
80 /** FTDI device context (used by libftdi). */
81 struct ftdi_context *ftdic;
84 /* Fixed device settings */
86 uint32_t max_samplebytes;
87 uint32_t max_samplerate;
88 uint32_t protocol_version;
90 /* Acquisition settings */
91 uint64_t cur_samplerate;
92 uint32_t cur_samplerate_divider;
94 uint64_t limit_samples;
97 uint32_t channel_mask;
98 uint32_t trigger_mask[NUM_TRIGGER_STAGES];
99 uint32_t trigger_value[NUM_TRIGGER_STAGES];
100 uint32_t trigger_edge[NUM_TRIGGER_STAGES];
104 /* Operational states */
105 unsigned int num_transfers;
106 unsigned int num_samples;
109 unsigned int cnt_samples;
112 /* Temporary variables */
113 unsigned int rle_count;
114 unsigned char sample[4];
115 unsigned char tmp_sample[4];
116 unsigned char tmp_sample2[4];
117 unsigned char *raw_sample_buf;
120 SR_PRIV extern const char *p_ols_channel_names[];
121 SR_PRIV int write_shortcommand(struct dev_context *devc, uint8_t command);
122 SR_PRIV int write_longcommand(struct dev_context *devc, uint8_t command, uint8_t *data);
123 SR_PRIV int p_ols_open(struct dev_context *devc);
124 SR_PRIV int p_ols_close(struct dev_context *devc);
125 SR_PRIV void pols_channel_mask(const struct sr_dev_inst *sdi);
126 SR_PRIV int pols_convert_trigger(const struct sr_dev_inst *sdi);
127 SR_PRIV struct sr_dev_inst *p_ols_get_metadata(uint8_t *buf, int bytes_read, struct dev_context *devc);
128 SR_PRIV int p_ols_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
129 SR_PRIV int p_ols_receive_data(int fd, int revents, void *cb_data);