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.h"
30 #include "libsigrok-internal.h"
32 /* Message logging helpers with subsystem-specific prefix string. */
33 #define LOG_PREFIX "fx2lafw: "
34 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
35 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
36 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
37 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
38 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
39 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
41 #define USB_INTERFACE 0
42 #define USB_CONFIGURATION 1
43 #define NUM_TRIGGER_STAGES 4
44 #define TRIGGER_TYPE "01"
46 #define MAX_RENUM_DELAY_MS 3000
47 #define NUM_SIMUL_TRANSFERS 32
48 #define MAX_EMPTY_TRANSFERS (NUM_SIMUL_TRANSFERS * 2)
50 #define FX2LAFW_REQUIRED_VERSION_MAJOR 1
52 #define MAX_8BIT_SAMPLE_RATE SR_MHZ(24)
53 #define MAX_16BIT_SAMPLE_RATE SR_MHZ(12)
55 /* 6 delay states of up to 256 clock ticks */
56 #define MAX_SAMPLE_DELAY (6 * 256)
58 /* Software trigger implementation: positive values indicate trigger stage. */
59 #define TRIGGER_FIRED -1
61 #define DEV_CAPS_16BIT_POS 0
63 #define DEV_CAPS_16BIT (1 << DEV_CAPS_16BIT_POS)
65 struct fx2lafw_profile {
71 const char *model_version;
79 const struct fx2lafw_profile *profile;
81 * Since we can't keep track of an fx2lafw device after upgrading
82 * the firmware (it renumerates into a different device address
83 * after the upgrade) this is like a global lock. No device will open
84 * until a proper delay after the last device was upgraded.
88 /* Device/capture settings */
89 uint64_t cur_samplerate;
90 uint64_t limit_samples;
92 /* Operational settings */
94 uint16_t trigger_mask[NUM_TRIGGER_STAGES];
95 uint16_t trigger_value[NUM_TRIGGER_STAGES];
97 uint16_t trigger_buffer[NUM_TRIGGER_STAGES];
100 int submitted_transfers;
101 int empty_transfer_count;
104 unsigned int num_transfers;
105 struct libusb_transfer **transfers;
109 SR_PRIV int fx2lafw_command_start_acquisition(libusb_device_handle *devhdl,
110 uint64_t samplerate, gboolean samplewide);
111 SR_PRIV gboolean fx2lafw_check_conf_profile(libusb_device *dev);
112 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
113 SR_PRIV int fx2lafw_configure_probes(const struct sr_dev_inst *sdi);
114 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
115 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
116 SR_PRIV void fx2lafw_receive_transfer(struct libusb_transfer *transfer);
117 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
118 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
119 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);