2 * This file is part of the libsigrok project.
4 * Copyright (C) 2016 Andreas Zschunke <andreas.zschunke@gmx.net>
5 * Copyright (C) 2017 Andrej Valek <andy@skyrain.eu>
6 * Copyright (C) 2017 Uwe Hermann <uwe@hermann-uwe.de>
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef LIBSIGROK_HARDWARE_HANTEK_4032L_PROTOCOL_H
23 #define LIBSIGROK_HARDWARE_HANTEK_4032L_PROTOCOL_H
28 #include <libsigrok/libsigrok.h>
29 #include "libsigrok-internal.h"
31 #define LOG_PREFIX "hantek-4032l"
33 #define H4032L_USB_VENDOR 0x04b5
34 #define H4032L_USB_PRODUCT 0x4032
36 #define H4032L_DATA_BUFFER_SIZE (2 * 1024)
37 #define H4032L_DATA_TRANSFER_MAX_NUM 32
39 #define H4043L_NUM_SAMPLES_MIN (2 * 1024)
40 #define H4032L_NUM_SAMPLES_MAX (64 * 1024 * 1024)
42 #define H4032L_CMD_PKT_MAGIC 0x017f
43 #define H4032L_STATUS_PACKET_MAGIC 0x2B1A037F
44 #define H4032L_START_PACKET_MAGIC 0x2B1A027F
45 #define H4032L_END_PACKET_MAGIC 0x4D3C037F
47 enum h4032l_trigger_edge_type {
48 H4032L_TRIGGER_EDGE_TYPE_RISE,
49 H4032L_TRIGGER_EDGE_TYPE_FALL,
50 H4032L_TRIGGER_EDGE_TYPE_TOGGLE,
51 H4032L_TRIGGER_EDGE_TYPE_DISABLED
54 enum h4032l_trigger_data_range_type {
55 H4032L_TRIGGER_DATA_RANGE_TYPE_MAX,
56 H4032L_TRIGGER_DATA_RANGE_TYPE_MIN_OR_MAX,
57 H4032L_TRIGGER_DATA_RANGE_TYPE_OUT_OF_RANGE,
58 H4032L_TRIGGER_DATA_RANGE_TYPE_WITHIN_RANGE
61 enum h4032l_trigger_time_range_type {
62 H4032L_TRIGGER_TIME_RANGE_TYPE_MAX,
63 H4032L_TRIGGER_TIME_RANGE_TYPE_MIN_OR_MAX,
64 H4032L_TRIGGER_TIME_RANGE_TYPE_OUT_OF_RANGE,
65 H4032L_TRIGGER_TIME_RANGE_TYPE_WITHIN_RANGE
68 enum h4032l_trigger_data_selection {
69 H4032L_TRIGGER_DATA_SELECTION_NEXT,
70 H4032L_TRIGGER_DATA_SELECTION_CURRENT,
71 H4032L_TRIGGER_DATA_SELECTION_PREV
76 H4032L_STATUS_CMD_CONFIGURE,
77 H4032L_STATUS_CMD_STATUS,
78 H4032L_STATUS_RESPONSE_STATUS,
79 H4032L_STATUS_RESPONSE_STATUS_RETRY,
80 H4032L_STATUS_RESPONSE_STATUS_CONTINUE,
81 H4032L_STATUS_CMD_GET,
82 H4032L_STATUS_FIRST_TRANSFER,
83 H4032L_STATUS_TRANSFER
87 struct h4032l_trigger {
89 uint32_t edge_signal:5;
92 uint32_t data_range_type:2;
93 uint32_t time_range_type:2;
94 uint32_t data_range_enabled:1;
95 uint32_t time_range_enabled:1;
98 uint32_t combined_enabled:1;
100 uint32_t data_range_min;
101 uint32_t data_range_max;
102 uint32_t time_range_min;
103 uint32_t time_range_max;
104 uint32_t data_range_mask;
105 uint32_t combine_mask;
106 uint32_t combine_data;
109 struct h4032l_cmd_pkt {
110 uint16_t magic; /* 0x017f */
113 uint8_t enable_trigger1:1;
114 uint8_t enable_trigger2:1;
115 uint8_t trigger_and_logic:1;
120 uint32_t sample_size; /* Sample depth in bits per channel, 2k-64M, must be multiple of 512. */
121 uint32_t pre_trigger_size; /* Pretrigger buffer depth in bits, must be < sample_size. */
122 struct h4032l_trigger trigger[2];
128 enum h4032l_status status;
129 unsigned int sent_samples;
130 int submitted_transfers;
131 uint32_t remaining_samples;
132 gboolean acq_aborted;
133 struct h4032l_cmd_pkt cmd_pkt;
134 unsigned int num_transfers;
135 struct libusb_transfer **transfers;
137 uint64_t capture_ratio;
138 uint32_t trigger_pos;
139 double cur_threshold;
140 uint32_t fpga_version;
143 SR_PRIV int h4032l_receive_data(int fd, int revents, void *cb_data);
144 SR_PRIV uint16_t h4032l_voltage2pwm(double voltage);
145 SR_PRIV void LIBUSB_CALL h4032l_usb_callback(struct libusb_transfer *transfer);
146 SR_PRIV void LIBUSB_CALL h4032l_data_transfer_callback(struct libusb_transfer *transfer);
147 SR_PRIV int h4032l_start_data_transfers(const struct sr_dev_inst *sdi);
148 SR_PRIV int h4032l_start(const struct sr_dev_inst *sdi);
149 SR_PRIV int h4032l_stop(struct sr_dev_inst *sdi);
150 SR_PRIV int h4032l_dev_open(struct sr_dev_inst *sdi);
151 SR_PRIV int h4032l_get_fpga_version(const struct sr_dev_inst *sdi);