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
23 #define LOG_PREFIX "sysclk-lwla"
28 #include <libsigrok/libsigrok.h>
29 #include <libsigrok-internal.h>
31 #define VENDOR_NAME "SysClk"
33 /* Maximum configurable sample count limit.
34 * Due to compression, there is no meaningful hardware limit the driver
35 * could report. So this value is less than 2^64-1 for no reason other
36 * than to safeguard against integer overflows.
38 #define MAX_LIMIT_SAMPLES (UINT64_C(1000) * 1000 * 1000 * 1000)
40 /* Maximum configurable acquisition time limit.
41 * Due to compression, there is no hardware limit that would be meaningful
42 * in practice. However, the LWLA1016 reports the elapsed time as a 32-bit
43 * value, so keep this below 2^32.
45 #define MAX_LIMIT_MSEC (1000 * 1000 * 1000)
47 struct acquisition_state;
49 /* USB vendor and product IDs.
52 USB_VID_SYSCLK = 0x2961,
53 USB_PID_LWLA1016 = 0x6688,
54 USB_PID_LWLA1034 = 0x6689,
57 /* USB device characteristics.
62 USB_TIMEOUT_MS = 1000,
65 /** USB device end points.
70 EP_REPLY = 6 | LIBUSB_ENDPOINT_IN
73 /** LWLA1034 clock sources.
80 /** LWLA1034 trigger sources.
87 /** Edge choices for the LWLA1034 external clock and trigger inputs.
94 /* Common indicator for no or unknown FPGA config. */
99 /** Acquisition protocol states.
101 enum protocol_state {
105 /* device command states */
110 /* command followed by response */
111 STATE_EXPECT_RESPONSE = 1 << 3,
112 STATE_STATUS_REQUEST = STATE_EXPECT_RESPONSE,
113 STATE_LENGTH_REQUEST,
117 /** Private, per-device-instance driver context.
120 uint64_t samplerate; /* requested samplerate */
121 uint64_t limit_msec; /* requested capture duration in ms */
122 uint64_t limit_samples; /* requested capture length in samples */
124 uint64_t channel_mask; /* bit mask of enabled channels */
125 uint64_t trigger_mask; /* trigger enable mask */
126 uint64_t trigger_edge_mask; /* trigger type mask */
127 uint64_t trigger_values; /* trigger level/slope bits */
129 const struct model_info *model; /* device model descriptor */
130 struct acquisition_state *acquisition; /* running capture state */
131 int active_fpga_config; /* FPGA configuration index */
132 gboolean short_transfer_quirk; /* 64 bytes response limit */
134 enum protocol_state state; /* async protocol state */
135 gboolean cancel_requested; /* stop after current transfer */
136 gboolean transfer_error; /* error during device communication */
138 gboolean cfg_rle; /* RLE compression setting */
139 enum clock_source cfg_clock_source; /* clock source setting */
140 enum signal_edge cfg_clock_edge; /* ext clock edge setting */
141 enum trigger_source cfg_trigger_source; /* trigger source setting */
142 enum signal_edge cfg_trigger_slope; /* ext trigger slope setting */
146 /** LWLA model descriptor.
152 unsigned int num_devopts;
155 unsigned int num_samplerates;
156 uint64_t samplerates[20];
158 int (*apply_fpga_config)(const struct sr_dev_inst *sdi);
159 int (*device_init_check)(const struct sr_dev_inst *sdi);
160 int (*setup_acquisition)(const struct sr_dev_inst *sdi);
162 int (*prepare_request)(const struct sr_dev_inst *sdi);
163 int (*handle_response)(const struct sr_dev_inst *sdi);
166 extern SR_PRIV const struct model_info lwla1016_info;
167 extern SR_PRIV const struct model_info lwla1034_info;
169 SR_PRIV int lwla_start_acquisition(const struct sr_dev_inst *sdi);