]> sigrok.org Git - libsigrok.git/blame - src/hardware/kingst-la2016/protocol.h
kingst-la2016: sort include directives
[libsigrok.git] / src / hardware / kingst-la2016 / protocol.h
CommitLineData
f2cd2deb
FS
1/*
2 * This file is part of the libsigrok project.
3 *
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>
8 *
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.
13 *
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.
18 *
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/>.
21 */
22
23#ifndef LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
24#define LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
25
f2cd2deb
FS
26#include <glib.h>
27#include <libsigrok/libsigrok.h>
a7740b06 28#include <stdint.h>
f2cd2deb
FS
29
30#define LOG_PREFIX "kingst-la2016"
31
f2cd2deb
FS
32#define LA2016_VID 0x77a1
33#define LA2016_PID 0x01a2
34#define USB_INTERFACE 0
40a0b2f4 35#define USB_CONFIGURATION 1
f2cd2deb
FS
36
37#define LA2016_BULK_MAX 8388608
38
e847645b
KG
39/*
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 of
43 * the transfer buffer is normally read from WinUSB_GetPipePolicy API but
44 * libusb does not expose this function. Typically, max size is 2MB.
45 */
46#define LA2016_EP6_PKTSZ 512 /* endpoint 6 max packet size */
47#define LA2016_USB_BUFSZ (256 * 2 * LA2016_EP6_PKTSZ) /* 256KB buffer */
48
f2cd2deb
FS
49#define MAX_RENUM_DELAY_MS 3000
50#define DEFAULT_TIMEOUT_MS 200
51
52#define LA2016_THR_VOLTAGE_MIN 0.40
53#define LA2016_THR_VOLTAGE_MAX 4.00
54
55#define LA2016_NUM_SAMPLES_MIN 256
56#define LA2016_NUM_SAMPLES_MAX (10UL * 1000 * 1000 * 1000)
57
58typedef struct pwm_setting_dev {
59 uint32_t period;
60 uint32_t duty;
c3d40037 61} pwm_setting_dev_t;
f2cd2deb
FS
62
63typedef struct trigger_cfg {
64 uint32_t channels;
65 uint32_t enabled;
66 uint32_t level;
67 uint32_t high_or_falling;
c3d40037 68} trigger_cfg_t;
f2cd2deb
FS
69
70typedef struct capture_info {
71 uint32_t n_rep_packets;
72 uint32_t n_rep_packets_before_trigger;
73 uint32_t write_pos;
c3d40037 74} capture_info_t;
f2cd2deb 75
c3d40037
HK
76#define NUM_PACKETS_IN_CHUNK 5
77#define TRANSFER_PACKET_LENGTH 16
f2cd2deb
FS
78
79typedef struct pwm_setting {
80 uint8_t enabled;
81 float freq;
82 float duty;
f2cd2deb
FS
83} pwm_setting_t;
84
85struct dev_context {
86 struct sr_context *ctx;
87
88 int64_t fw_updated;
89 pwm_setting_t pwm_setting[2];
90 unsigned int threshold_voltage_idx;
91 float threshold_voltage;
8b172e78 92 uint64_t max_samplerate;
f2cd2deb
FS
93 uint64_t cur_samplerate;
94 uint64_t limit_samples;
95 uint64_t capture_ratio;
96 uint16_t cur_channels;
97 int num_channels;
98
3f48ab02
FS
99 uint32_t bitstream_size;
100
f2cd2deb
FS
101 /* derived stuff */
102 uint64_t pre_trigger_size;
103
104 /* state after sampling */
105 int had_triggers_configured;
106 int have_trigger;
107 int transfer_finished;
108 capture_info_t info;
109 unsigned int n_transfer_packets_to_read; /* each with 5 acq packets */
110 unsigned int n_bytes_to_read;
111 unsigned int n_reps_until_trigger;
112 unsigned int reading_behind_trigger;
113 uint64_t total_samples;
114 uint32_t read_pos;
115
116 unsigned int convbuffer_size;
117 uint8_t *convbuffer;
118 struct libusb_transfer *transfer;
119};
120
121SR_PRIV int la2016_upload_firmware(struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id);
122SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi);
123SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi);
f2cd2deb 124SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);
388438e4 125SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data);
f2cd2deb
FS
126SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi);
127SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi);
128
f2cd2deb 129#endif