]>
Commit | Line | Data |
---|---|---|
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 | ||
26 | #include <libsigrok/libsigrok.h> | |
27 | #include <stdint.h> | |
28 | ||
29 | #define LOG_PREFIX "kingst-la2016" | |
30 | ||
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 | |
38 | ||
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 | |
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. | |
45 | */ | |
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. */ | |
48 | ||
49 | /* USB communication timeout during regular operation. */ | |
50 | #define DEFAULT_TIMEOUT_MS 200 | |
51 | ||
52 | /* | |
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. | |
58 | */ | |
59 | #define RENUM_CHECK_PERIOD_MS 3000 | |
60 | #define RENUM_GONE_DELAY_MS 1800 | |
61 | #define RENUM_POLL_INTERVAL_MS 200 | |
62 | ||
63 | /* | |
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. | |
66 | */ | |
67 | #define LA2016_EP2_PADDING 2048 | |
68 | ||
69 | /* | |
70 | * The complex logic input threshold voltage support with a custom level | |
71 | * is not operational yet. Ideally we could support the set of pre-made | |
72 | * voltages with their pretty text labels, and one of them referencing | |
73 | * a voltage which is user specified. But not all applications support | |
74 | * this setup equally well, or present it most appropriately to users. | |
75 | * So let's implement something simpler for the moment until the more | |
76 | * complex approach becomes accessible in all applications. | |
77 | * | |
78 | * Strictly speaking the logic input threshold voltage is a property of | |
79 | * the "Logic" channel group. Again not all applications support such | |
80 | * an approach, and like to see them as global device properties. | |
81 | */ | |
82 | #define WITH_THRESHOLD_DEVCFG 1 | |
83 | #define WITH_THRESHOLD_SIMPLE 1 | |
84 | #if !WITH_THRESHOLD_DEVCFG && !WITH_THRESHOLD_SIMPLE | |
85 | # error "Custom threshold in Logic group is not implemented." | |
86 | #endif | |
87 | ||
88 | #define LA2016_THR_VOLTAGE_MIN 0.40 | |
89 | #define LA2016_THR_VOLTAGE_MAX 4.00 | |
90 | ||
91 | #define LA2016_NUM_SAMPLES_MAX (UINT64_C(10 * 1000 * 1000 * 1000)) | |
92 | ||
93 | /* Maximum device capabilities. May differ between models. */ | |
94 | #define MAX_PWM_FREQ SR_MHZ(20) | |
95 | #define PWM_CLOCK SR_MHZ(200) /* 200MHz for both LA2016 and LA1016 */ | |
96 | ||
97 | #define LA2016_NUM_PWMCH_MAX 2 | |
98 | ||
99 | #define LA2016_CONVBUFFER_SIZE (4 * 1024 * 1024) | |
100 | ||
101 | struct kingst_model { | |
102 | uint8_t magic; /* EEPROM magic byte value. */ | |
103 | const char *name; /* User perceived model name. */ | |
104 | const char *fpga_stem; /* Bitstream filename stem. */ | |
105 | uint64_t samplerate; /* Max samplerate in Hz. */ | |
106 | size_t channel_count; /* Max channel count (16, 32). */ | |
107 | uint64_t memory_bits; /* RAM capacity in Gbit (1, 2, 4). */ | |
108 | }; | |
109 | ||
110 | struct dev_context { | |
111 | uint16_t usb_pid; | |
112 | char *mcu_firmware; | |
113 | char *fpga_bitstream; | |
114 | uint64_t fw_uploaded; /* Timestamp of most recent FW upload. */ | |
115 | uint8_t identify_magic; | |
116 | const struct kingst_model *model; | |
117 | struct sr_channel_group *cg_logic, *cg_pwm; | |
118 | ||
119 | /* User specified parameters. */ | |
120 | struct pwm_setting { | |
121 | gboolean enabled; | |
122 | float freq; | |
123 | float duty; | |
124 | } pwm_setting[LA2016_NUM_PWMCH_MAX]; | |
125 | size_t threshold_voltage_idx; | |
126 | float threshold_voltage; | |
127 | uint64_t cur_samplerate; | |
128 | struct sr_sw_limits sw_limits; | |
129 | uint64_t capture_ratio; | |
130 | ||
131 | /* Internal acquisition and download state. */ | |
132 | gboolean trigger_involved; | |
133 | gboolean completion_seen; | |
134 | gboolean download_finished; | |
135 | struct capture_info { | |
136 | uint32_t n_rep_packets; | |
137 | uint32_t n_rep_packets_before_trigger; | |
138 | uint32_t write_pos; | |
139 | } info; | |
140 | uint32_t n_transfer_packets_to_read; /* each with 5 acq packets */ | |
141 | uint32_t n_bytes_to_read; | |
142 | uint32_t n_reps_until_trigger; | |
143 | gboolean trigger_marked; | |
144 | uint64_t total_samples; | |
145 | uint32_t read_pos; | |
146 | ||
147 | struct feed_queue_logic *feed_queue; | |
148 | struct libusb_transfer *transfer; | |
149 | }; | |
150 | ||
151 | SR_PRIV int la2016_upload_firmware(const struct sr_dev_inst *sdi, | |
152 | struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id); | |
153 | SR_PRIV int la2016_identify_device(const struct sr_dev_inst *sdi, | |
154 | gboolean show_message); | |
155 | SR_PRIV int la2016_init_hardware(const struct sr_dev_inst *sdi); | |
156 | SR_PRIV int la2016_deinit_hardware(const struct sr_dev_inst *sdi); | |
157 | SR_PRIV int la2016_write_pwm_config(const struct sr_dev_inst *sdi, size_t idx); | |
158 | SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi, | |
159 | double voltage); | |
160 | SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi); | |
161 | SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi); | |
162 | SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data); | |
163 | ||
164 | #endif |