2 * This file is part of the libsigrok project.
4 * Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
5 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
6 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
7 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
9 * This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #ifndef LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
24 #define LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
26 #include <libsigrok/libsigrok.h>
29 #define LOG_PREFIX "kingst-la2016"
31 #define LA2016_VID 0x77a1
32 #define LA2016_PID 0x01a2
33 #define LA2016_IPRODUCT_INDEX 2
34 #define USB_INTERFACE 0
35 #define USB_CONFIGURATION 1
36 #define USB_EP_FPGA_BITSTREAM 2
37 #define USB_EP_CAPTURE_DATA 6
40 * On Windows sigrok uses WinUSB RAW_IO policy which requires the
41 * USB transfer buffer size to be a multiple of the endpoint max packet
42 * size, which is 512 bytes in this case. Also, the maximum allowed size
43 * of the transfer buffer is normally read from WinUSB_GetPipePolicy API
44 * but libusb does not expose this function. Typically, max size is 2MB.
46 #define LA2016_EP6_PKTSZ 512 /* Max packet size of USB endpoint 6. */
47 #define LA2016_USB_BUFSZ (256 * 2 * LA2016_EP6_PKTSZ) /* 256KiB buffer. */
49 /* USB communication timeout during regular operation. */
50 #define DEFAULT_TIMEOUT_MS 200
53 * Check for MCU firmware to take effect after upload. Check the device
54 * presence for a maximum period of time, delay between checks in that
55 * phase. Allow for the device to vanish after upload and before checks,
56 * to not mistake its earlier incarnation for the successful operation
57 * of the most recently loaded firmware.
59 #define RENUM_CHECK_PERIOD_MS 3000
60 #define RENUM_GONE_DELAY_MS 1800
61 #define RENUM_POLL_INTERVAL_MS 200
64 * The device expects some zero padding to follow the content of the
65 * file which contains the FPGA bitstream. Specify the chunk size here.
67 #define LA2016_EP2_PADDING 2048
70 * Whether the logic input threshold voltage is a config item of the
71 * "Logic" channel group or a global config item of the device. Ideally
72 * it would be the former (being strictly related to the Logic channels)
73 * but mainline applications work better with the latter, and many other
74 * device drivers implement it that way, too.
76 #define WITH_THRESHOLD_DEVCFG 1
78 #define LA2016_THR_VOLTAGE_MIN 0.40
79 #define LA2016_THR_VOLTAGE_MAX 4.00
81 #define LA2016_NUM_SAMPLES_MAX (UINT64_C(10 * 1000 * 1000 * 1000))
83 /* Maximum device capabilities. May differ between models. */
84 #define MAX_PWM_FREQ SR_MHZ(20)
85 #define PWM_CLOCK SR_MHZ(200) /* 200MHz for both LA2016 and LA1016 */
87 #define LA2016_NUM_PWMCH_MAX 2
90 * Whether to de-initialize the device hardware in the driver's close
91 * callback. It is desirable to e.g. configure PWM channels and leave
92 * the generator running after the application shuts down. Users can
93 * always disable channels on their way out if they want to.
95 #define WITH_DEINIT_IN_CLOSE 0
97 #define LA2016_CONVBUFFER_SIZE (4 * 1024 * 1024)
100 uint8_t magic; /* EEPROM magic byte value. */
101 const char *name; /* User perceived model name. */
102 const char *fpga_stem; /* Bitstream filename stem. */
103 uint64_t samplerate; /* Max samplerate in Hz. */
104 size_t channel_count; /* Max channel count (16, 32). */
105 uint64_t memory_bits; /* RAM capacity in Gbit (1, 2, 4). */
111 char *fpga_bitstream;
112 uint64_t fw_uploaded; /* Timestamp of most recent FW upload. */
113 uint8_t identify_magic;
114 const struct kingst_model *model;
115 struct sr_channel_group *cg_logic, *cg_pwm;
117 /* User specified parameters. */
122 } pwm_setting[LA2016_NUM_PWMCH_MAX];
123 size_t threshold_voltage_idx;
125 struct sr_sw_limits sw_limits;
126 uint64_t capture_ratio;
128 /* Internal acquisition and download state. */
129 gboolean trigger_involved;
130 gboolean completion_seen;
131 gboolean download_finished;
132 struct capture_info {
133 uint32_t n_rep_packets;
134 uint32_t n_rep_packets_before_trigger;
137 uint32_t n_transfer_packets_to_read; /* each with 5 acq packets */
138 uint32_t n_bytes_to_read;
139 uint32_t n_reps_until_trigger;
140 gboolean trigger_marked;
141 uint64_t total_samples;
144 struct feed_queue_logic *feed_queue;
145 struct libusb_transfer *transfer;
148 SR_PRIV int la2016_upload_firmware(const struct sr_dev_inst *sdi,
149 struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id);
150 SR_PRIV int la2016_identify_device(const struct sr_dev_inst *sdi,
151 gboolean show_message);
152 SR_PRIV int la2016_init_hardware(const struct sr_dev_inst *sdi);
153 SR_PRIV int la2016_deinit_hardware(const struct sr_dev_inst *sdi);
154 SR_PRIV int la2016_write_pwm_config(const struct sr_dev_inst *sdi, size_t idx);
155 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi,
157 SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi);
158 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);
159 SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data);