2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.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_SYSCLK_LWLA_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_SYSCLK_LWLA_PROTOCOL_H
26 #include <libsigrok/libsigrok.h>
27 #include <libsigrok-internal.h>
29 #define LOG_PREFIX "sysclk-lwla"
31 /* Maximum configurable sample count limit.
32 * Due to compression, there is no meaningful hardware limit the driver
33 * could report. So this value is less than 2^64-1 for no reason other
34 * than to safeguard against integer overflows.
36 #define MAX_LIMIT_SAMPLES (UINT64_C(1000) * 1000 * 1000 * 1000)
38 /* Maximum configurable acquisition time limit.
39 * Due to compression, there is no hardware limit that would be meaningful
40 * in practice. However, the LWLA1016 reports the elapsed time as a 32-bit
41 * value, so keep this below 2^32.
43 #define MAX_LIMIT_MSEC (1000 * 1000 * 1000)
45 struct acquisition_state;
47 /* USB vendor and product IDs. */
49 USB_VID_SYSCLK = 0x2961,
50 USB_PID_LWLA1016 = 0x6688,
51 USB_PID_LWLA1034 = 0x6689,
54 /* USB device characteristics. */
58 USB_TIMEOUT_MS = 1000,
61 /** USB device end points. */
65 EP_REPLY = 6 | LIBUSB_ENDPOINT_IN
68 /** LWLA1034 clock sources. */
74 /** LWLA1034 trigger sources. */
80 /** Edge choices for the LWLA1034 external clock and trigger inputs. */
86 /* Common indicator for no or unknown FPGA config. */
91 /** Acquisition protocol states. */
96 /* device command states */
101 /* command followed by response */
102 STATE_EXPECT_RESPONSE = 1 << 3,
103 STATE_STATUS_REQUEST = STATE_EXPECT_RESPONSE,
104 STATE_LENGTH_REQUEST,
109 uint64_t samplerate; /* requested samplerate */
110 uint64_t limit_msec; /* requested capture duration in ms */
111 uint64_t limit_samples; /* requested capture length in samples */
113 uint64_t channel_mask; /* bit mask of enabled channels */
114 uint64_t trigger_mask; /* trigger enable mask */
115 uint64_t trigger_edge_mask; /* trigger type mask */
116 uint64_t trigger_values; /* trigger level/slope bits */
118 const struct model_info *model; /* device model descriptor */
119 struct acquisition_state *acquisition; /* running capture state */
120 int active_fpga_config; /* FPGA configuration index */
121 gboolean short_transfer_quirk; /* 64 bytes response limit */
123 enum protocol_state state; /* async protocol state */
124 gboolean cancel_requested; /* stop after current transfer */
125 gboolean transfer_error; /* error during device communication */
127 gboolean cfg_rle; /* RLE compression setting */
128 enum clock_source cfg_clock_source; /* clock source setting */
129 enum signal_edge cfg_clock_edge; /* ext clock edge setting */
130 enum trigger_source cfg_trigger_source; /* trigger source setting */
131 enum signal_edge cfg_trigger_slope; /* ext trigger slope setting */
134 /** LWLA model descriptor. */
139 unsigned int num_devopts;
142 unsigned int num_samplerates;
143 uint64_t samplerates[20];
145 int (*apply_fpga_config)(const struct sr_dev_inst *sdi);
146 int (*device_init_check)(const struct sr_dev_inst *sdi);
147 int (*setup_acquisition)(const struct sr_dev_inst *sdi);
149 int (*prepare_request)(const struct sr_dev_inst *sdi);
150 int (*handle_response)(const struct sr_dev_inst *sdi);
153 extern SR_PRIV const struct model_info lwla1016_info;
154 extern SR_PRIV const struct model_info lwla1034_info;
156 SR_PRIV int lwla_start_acquisition(const struct sr_dev_inst *sdi);