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 USB_INTERFACE 0
34 #define USB_CONFIGURATION 1
37 * On Windows sigrok uses WinUSB RAW_IO policy which requires the
38 * USB transfer buffer size to be a multiple of the endpoint max packet
39 * size, which is 512 bytes in this case. Also, the maximum allowed size
40 * of the transfer buffer is normally read from WinUSB_GetPipePolicy API
41 * but libusb does not expose this function. Typically, max size is 2MB.
43 #define LA2016_EP6_PKTSZ 512 /* Max packet size of USB endpoint 6. */
44 #define LA2016_USB_BUFSZ (256 * 2 * LA2016_EP6_PKTSZ) /* 256KiB buffer. */
46 /* USB communication timeout during regular operation. */
47 #define DEFAULT_TIMEOUT_MS 200
50 * Check for MCU firmware to take effect after upload. Check the device
51 * presence for a maximum period of time, delay between checks in that
52 * phase. Allow for the device to vanish after upload and before checks,
53 * to not mistake its earlier incarnation for the successful operation
54 * of the most recently loaded firmware.
56 #define RENUM_CHECK_PERIOD_MS 3000
57 #define RENUM_GONE_DELAY_MS 1800
58 #define RENUM_POLL_INTERVAL_MS 200
60 #define LA2016_THR_VOLTAGE_MIN 0.40
61 #define LA2016_THR_VOLTAGE_MAX 4.00
63 #define LA2016_NUM_SAMPLES_MIN 256
64 #define LA2016_NUM_SAMPLES_MAX (10UL * 1000 * 1000 * 1000)
66 typedef struct pwm_setting_dev {
71 typedef struct trigger_cfg {
75 uint32_t high_or_falling;
78 typedef struct capture_info {
79 uint32_t n_rep_packets;
80 uint32_t n_rep_packets_before_trigger;
84 #define NUM_PACKETS_IN_CHUNK 5
85 #define TRANSFER_PACKET_LENGTH 16
87 typedef struct pwm_setting {
94 struct sr_context *ctx;
97 /* User specified parameters. */
98 pwm_setting_t pwm_setting[2];
99 unsigned int threshold_voltage_idx;
100 float threshold_voltage;
101 uint64_t max_samplerate;
102 uint64_t cur_samplerate;
103 uint64_t limit_samples;
104 uint64_t capture_ratio;
105 uint16_t cur_channels;
108 uint32_t bitstream_size;
110 /* Values derived from user specs. */
111 uint64_t pre_trigger_size;
113 /* Internal acquisition and download state. */
114 int had_triggers_configured;
116 int transfer_finished;
118 unsigned int n_transfer_packets_to_read; /* each with 5 acq packets */
119 unsigned int n_bytes_to_read;
120 unsigned int n_reps_until_trigger;
121 unsigned int reading_behind_trigger;
122 uint64_t total_samples;
125 unsigned int convbuffer_size;
127 struct libusb_transfer *transfer;
130 SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx,
131 libusb_device *dev, uint16_t product_id);
132 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi);
133 SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi);
134 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);
135 SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data);
136 SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi);
137 SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi);