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 #define LOG_PREFIX "fx2lafw"
34 #define USB_INTERFACE 0
35 #define USB_CONFIGURATION 1
36 #define NUM_TRIGGER_STAGES 4
37 #define SOFT_TRIGGER_TYPES "01"
39 #define MAX_RENUM_DELAY_MS 3000
40 #define NUM_SIMUL_TRANSFERS 32
41 #define MAX_EMPTY_TRANSFERS (NUM_SIMUL_TRANSFERS * 2)
43 #define FX2LAFW_REQUIRED_VERSION_MAJOR 1
45 #define MAX_8BIT_SAMPLE_RATE SR_MHZ(24)
46 #define MAX_16BIT_SAMPLE_RATE SR_MHZ(12)
48 /* 6 delay states of up to 256 clock ticks */
49 #define MAX_SAMPLE_DELAY (6 * 256)
51 #define DEV_CAPS_16BIT_POS 0
53 #define DEV_CAPS_16BIT (1 << DEV_CAPS_16BIT_POS)
55 struct fx2lafw_profile {
61 const char *model_version;
67 const char *usb_manufacturer;
68 const char *usb_product;
72 const struct fx2lafw_profile *profile;
74 * Since we can't keep track of an fx2lafw device after upgrading
75 * the firmware (it renumerates into a different device address
76 * after the upgrade) this is like a global lock. No device will open
77 * until a proper delay after the last device was upgraded.
81 /* Device/capture settings */
82 uint64_t cur_samplerate;
83 uint64_t limit_samples;
85 /* Operational settings */
86 gboolean trigger_fired;
89 uint16_t trigger_mask[NUM_TRIGGER_STAGES];
90 uint16_t trigger_value[NUM_TRIGGER_STAGES];
91 unsigned int trigger_stage;
92 uint16_t trigger_buffer[NUM_TRIGGER_STAGES];
94 unsigned int sent_samples;
95 int submitted_transfers;
96 int empty_transfer_count;
99 unsigned int num_transfers;
100 struct libusb_transfer **transfers;
101 struct sr_context *ctx;
104 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi);
105 SR_PRIV gboolean fx2lafw_check_conf_profile(libusb_device *dev);
106 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
107 SR_PRIV int fx2lafw_configure_channels(const struct sr_dev_inst *sdi);
108 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
109 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
110 SR_PRIV void fx2lafw_receive_transfer(struct libusb_transfer *transfer);
111 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
112 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
113 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);