2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef LIBSIGROK_HARDWARE_FX2LAFW_PROTOCOL_H
22 #define LIBSIGROK_HARDWARE_FX2LAFW_PROTOCOL_H
29 #include <libsigrok/libsigrok.h>
30 #include "libsigrok-internal.h"
32 #define LOG_PREFIX "fx2lafw"
34 #define USB_INTERFACE 0
35 #define USB_CONFIGURATION 1
36 #define NUM_TRIGGER_STAGES 4
38 #define MAX_RENUM_DELAY_MS 3000
39 #define NUM_SIMUL_TRANSFERS 32
40 #define MAX_EMPTY_TRANSFERS (NUM_SIMUL_TRANSFERS * 2)
42 #define NUM_CHANNELS 16
44 #define FX2LAFW_REQUIRED_VERSION_MAJOR 1
46 #define MAX_8BIT_SAMPLE_RATE SR_MHZ(24)
47 #define MAX_16BIT_SAMPLE_RATE SR_MHZ(12)
49 /* 6 delay states of up to 256 clock ticks */
50 #define MAX_SAMPLE_DELAY (6 * 256)
52 #define DEV_CAPS_16BIT_POS 0
53 #define DEV_CAPS_AX_ANALOG_POS 1
55 #define DEV_CAPS_16BIT (1 << DEV_CAPS_16BIT_POS)
56 #define DEV_CAPS_AX_ANALOG (1 << DEV_CAPS_AX_ANALOG_POS)
58 #define DSLOGIC_FPGA_FIRMWARE_5V "dreamsourcelab-dslogic-fpga-5v.fw"
59 #define DSLOGIC_FPGA_FIRMWARE_3V3 "dreamsourcelab-dslogic-fpga-3v3.fw"
60 #define DSCOPE_FPGA_FIRMWARE "dreamsourcelab-dscope-fpga.fw"
61 #define DSLOGIC_PRO_FPGA_FIRMWARE "dreamsourcelab-dslogic-pro-fpga.fw"
63 /* Protocol commands */
64 #define CMD_GET_FW_VERSION 0xb0
65 #define CMD_START 0xb1
66 #define CMD_GET_REVID_VERSION 0xb2
68 #define CMD_START_FLAGS_CLK_CTL2_POS 4
69 #define CMD_START_FLAGS_WIDE_POS 5
70 #define CMD_START_FLAGS_CLK_SRC_POS 6
72 #define CMD_START_FLAGS_CLK_CTL2 (1 << CMD_START_FLAGS_CLK_CTL2_POS)
73 #define CMD_START_FLAGS_SAMPLE_8BIT (0 << CMD_START_FLAGS_WIDE_POS)
74 #define CMD_START_FLAGS_SAMPLE_16BIT (1 << CMD_START_FLAGS_WIDE_POS)
76 #define CMD_START_FLAGS_CLK_30MHZ (0 << CMD_START_FLAGS_CLK_SRC_POS)
77 #define CMD_START_FLAGS_CLK_48MHZ (1 << CMD_START_FLAGS_CLK_SRC_POS)
79 struct fx2lafw_profile {
85 const char *model_version;
91 const char *usb_manufacturer;
92 const char *usb_product;
96 const struct fx2lafw_profile *profile;
97 GSList *enabled_analog_channels;
99 * Since we can't keep track of an fx2lafw device after upgrading
100 * the firmware (it renumerates into a different device address
101 * after the upgrade) this is like a global lock. No device will open
102 * until a proper delay after the last device was upgraded.
106 /* Supported samplerates */
107 const uint64_t *samplerates;
110 /* Device/capture settings */
111 uint64_t cur_samplerate;
112 uint64_t limit_samples;
113 uint64_t capture_ratio;
115 /* Operational settings */
116 gboolean trigger_fired;
117 gboolean acq_aborted;
118 gboolean sample_wide;
119 struct soft_trigger_logic *stl;
121 unsigned int sent_samples;
122 int submitted_transfers;
123 int empty_transfer_count;
125 unsigned int num_transfers;
126 struct libusb_transfer **transfers;
127 struct sr_context *ctx;
128 void (*send_data_proc)(struct sr_dev_inst *sdi,
129 uint8_t *data, size_t length, size_t sample_width);
130 uint8_t *logic_buffer;
131 float *analog_buffer;
133 /* Is this a DSLogic? */
135 uint16_t dslogic_mode;
136 uint32_t trigger_pos;
137 gboolean dslogic_external_clock;
138 gboolean dslogic_continuous_mode;
139 int dslogic_clock_edge;
140 int dslogic_voltage_threshold;
143 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi);
144 SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
145 const char *product);
146 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
147 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
148 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
149 SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer);
150 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
151 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
152 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);
153 SR_PRIV void la_send_data_proc(struct sr_dev_inst *sdi, uint8_t *data,
154 size_t length, size_t sample_width);
155 SR_PRIV void mso_send_data_proc(struct sr_dev_inst *sdi, uint8_t *data,
156 size_t length, size_t sample_width);