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
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "kingst-la2016"
33 #define LA2016_VID 0x77a1
34 #define LA2016_PID 0x01a2
35 #define USB_INTERFACE 0
36 #define USB_CONFIGURATION 1
38 #define LA2016_BULK_MAX 8388608
41 * On Windows sigrok uses WinUSB RAW_IO policy which requires the
42 * USB transfer buffer size to be a multiple of the endpoint max packet
43 * size, which is 512 bytes in this case. Also, the maximum allowed size of
44 * the transfer buffer is normally read from WinUSB_GetPipePolicy API but
45 * libusb does not expose this function. Typically, max size is 2MB.
47 #define LA2016_EP6_PKTSZ 512 /* endpoint 6 max packet size */
48 #define LA2016_USB_BUFSZ (256 * 2 * LA2016_EP6_PKTSZ) /* 256KB buffer */
50 #define MAX_RENUM_DELAY_MS 3000
51 #define DEFAULT_TIMEOUT_MS 200
53 #define LA2016_THR_VOLTAGE_MIN 0.40
54 #define LA2016_THR_VOLTAGE_MAX 4.00
56 #define LA2016_NUM_SAMPLES_MIN 256
57 #define LA2016_NUM_SAMPLES_MAX (10UL * 1000 * 1000 * 1000)
59 typedef struct pwm_setting_dev {
64 typedef struct trigger_cfg {
68 uint32_t high_or_falling;
71 typedef struct capture_info {
72 uint32_t n_rep_packets;
73 uint32_t n_rep_packets_before_trigger;
77 #define NUM_PACKETS_IN_CHUNK 5
78 #define TRANSFER_PACKET_LENGTH 16
80 typedef struct pwm_setting {
87 struct sr_context *ctx;
90 pwm_setting_t pwm_setting[2];
91 unsigned int threshold_voltage_idx;
92 float threshold_voltage;
93 uint64_t max_samplerate;
94 uint64_t cur_samplerate;
95 uint64_t limit_samples;
96 uint64_t capture_ratio;
97 uint16_t cur_channels;
100 uint32_t bitstream_size;
103 uint64_t pre_trigger_size;
105 /* state after sampling */
106 int had_triggers_configured;
108 int transfer_finished;
110 unsigned int n_transfer_packets_to_read; /* each with 5 acq packets */
111 unsigned int n_bytes_to_read;
112 unsigned int n_reps_until_trigger;
113 unsigned int reading_behind_trigger;
114 uint64_t total_samples;
117 unsigned int convbuffer_size;
119 struct libusb_transfer *transfer;
122 SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id);
123 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi);
124 SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi);
125 SR_PRIV int la2016_stop_acquisition(const struct sr_dev_inst *sdi);
126 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);
127 SR_PRIV int la2016_has_triggered(const struct sr_dev_inst *sdi);
128 SR_PRIV int la2016_start_retrieval(const struct sr_dev_inst *sdi, libusb_transfer_cb_fn cb);
129 SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi);
130 SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi);