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 FX2LAFW_REQUIRED_VERSION_MAJOR 1
44 #define MAX_8BIT_SAMPLE_RATE SR_MHZ(24)
45 #define MAX_16BIT_SAMPLE_RATE SR_MHZ(12)
47 /* 6 delay states of up to 256 clock ticks */
48 #define MAX_SAMPLE_DELAY (6 * 256)
50 #define DEV_CAPS_16BIT_POS 0
52 #define DEV_CAPS_16BIT (1 << DEV_CAPS_16BIT_POS)
54 #define DSLOGIC_FPGA_FIRMWARE "dreamsourcelab-dslogic-fpga.fw"
55 #define DSCOPE_FPGA_FIRMWARE "dreamsourcelab-dscope-fpga.fw"
56 #define DSLOGIC_PRO_FPGA_FIRMWARE "dreamsourcelab-dslogic-pro-fpga.fw"
58 /* Protocol commands */
59 #define CMD_GET_FW_VERSION 0xb0
60 #define CMD_START 0xb1
61 #define CMD_GET_REVID_VERSION 0xb2
63 #define CMD_START_FLAGS_WIDE_POS 5
64 #define CMD_START_FLAGS_CLK_SRC_POS 6
66 #define CMD_START_FLAGS_SAMPLE_8BIT (0 << CMD_START_FLAGS_WIDE_POS)
67 #define CMD_START_FLAGS_SAMPLE_16BIT (1 << CMD_START_FLAGS_WIDE_POS)
69 #define CMD_START_FLAGS_CLK_30MHZ (0 << CMD_START_FLAGS_CLK_SRC_POS)
70 #define CMD_START_FLAGS_CLK_48MHZ (1 << CMD_START_FLAGS_CLK_SRC_POS)
72 struct fx2lafw_profile {
78 const char *model_version;
84 const char *usb_manufacturer;
85 const char *usb_product;
89 const struct fx2lafw_profile *profile;
91 * Since we can't keep track of an fx2lafw device after upgrading
92 * the firmware (it renumerates into a different device address
93 * after the upgrade) this is like a global lock. No device will open
94 * until a proper delay after the last device was upgraded.
98 /* Supported samplerates */
99 const uint64_t *samplerates;
102 /* Device/capture settings */
103 uint64_t cur_samplerate;
104 uint64_t limit_samples;
105 uint64_t capture_ratio;
107 /* Operational settings */
108 gboolean trigger_fired;
109 gboolean acq_aborted;
110 gboolean sample_wide;
111 struct soft_trigger_logic *stl;
113 unsigned int sent_samples;
114 int submitted_transfers;
115 int empty_transfer_count;
118 unsigned int num_transfers;
119 struct libusb_transfer **transfers;
120 struct sr_context *ctx;
122 /* Is this a DSLogic? */
124 uint16_t dslogic_mode;
125 int dslogic_external_clock;
128 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi);
129 SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
130 const char *product);
131 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
132 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
133 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
134 SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer);
135 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
136 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
137 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);