src/hardware/fx2lafw/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  */
  20
  21 #ifndef LIBSIGROK_HARDWARE_FX2LAFW_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_FX2LAFW_PROTOCOL_H
  23
  24 #include <glib.h>
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <libusb.h>
  29 #include <libsigrok/libsigrok.h>
  30 #include "libsigrok-internal.h"
  31
  32 #define LOG_PREFIX "fx2lafw"
  33
  34 #define USB_INTERFACE           0
  35 #define USB_CONFIGURATION       1
  36 #define NUM_TRIGGER_STAGES      4
  37
  38 #define MAX_RENUM_DELAY_MS      3000
  39 #define NUM_SIMUL_TRANSFERS     32
  40 #define MAX_EMPTY_TRANSFERS     (NUM_SIMUL_TRANSFERS * 2)
  41
  42 #define NUM_CHANNELS            16
  43
  44 #define FX2LAFW_REQUIRED_VERSION_MAJOR  1
  45
  46 #define MAX_8BIT_SAMPLE_RATE    SR_MHZ(24)
  47 #define MAX_16BIT_SAMPLE_RATE   SR_MHZ(12)
  48
  49 /* 6 delay states of up to 256 clock ticks */
  50 #define MAX_SAMPLE_DELAY        (6 * 256)
  51
  52 #define DEV_CAPS_16BIT_POS      0
  53 #define DEV_CAPS_AX_ANALOG_POS  1
  54 #define DEV_CAPS_DSLOGIC_FW_POS 2
  55
  56 #define DEV_CAPS_16BIT          (1 << DEV_CAPS_16BIT_POS)
  57 #define DEV_CAPS_AX_ANALOG      (1 << DEV_CAPS_AX_ANALOG_POS)
  58 #define DEV_CAPS_DSLOGIC_FW     (1 << DEV_CAPS_DSLOGIC_FW_POS)
  59
  60 #define DSLOGIC_FPGA_FIRMWARE_5V "dreamsourcelab-dslogic-fpga-5v.fw"
  61 #define DSLOGIC_FPGA_FIRMWARE_3V3 "dreamsourcelab-dslogic-fpga-3v3.fw"
  62 #define DSCOPE_FPGA_FIRMWARE "dreamsourcelab-dscope-fpga.fw"
  63 #define DSLOGIC_PRO_FPGA_FIRMWARE "dreamsourcelab-dslogic-pro-fpga.fw"
  64 #define DSLOGIC_PLUS_FPGA_FIRMWARE "dreamsourcelab-dslogic-plus-fpga.fw"
  65 #define DSLOGIC_BASIC_FPGA_FIRMWARE "dreamsourcelab-dslogic-basic-fpga.fw"
  66
  67 /* Protocol commands */
  68 #define CMD_GET_FW_VERSION              0xb0
  69 #define CMD_START                       0xb1
  70 #define CMD_GET_REVID_VERSION           0xb2
  71
  72 #define CMD_START_FLAGS_CLK_CTL2_POS    4
  73 #define CMD_START_FLAGS_WIDE_POS        5
  74 #define CMD_START_FLAGS_CLK_SRC_POS     6
  75
  76 #define CMD_START_FLAGS_CLK_CTL2        (1 << CMD_START_FLAGS_CLK_CTL2_POS)
  77 #define CMD_START_FLAGS_SAMPLE_8BIT     (0 << CMD_START_FLAGS_WIDE_POS)
  78 #define CMD_START_FLAGS_SAMPLE_16BIT    (1 << CMD_START_FLAGS_WIDE_POS)
  79
  80 #define CMD_START_FLAGS_CLK_30MHZ       (0 << CMD_START_FLAGS_CLK_SRC_POS)
  81 #define CMD_START_FLAGS_CLK_48MHZ       (1 << CMD_START_FLAGS_CLK_SRC_POS)
  82
  83 struct fx2lafw_profile {
  84         uint16_t vid;
  85         uint16_t pid;
  86
  87         const char *vendor;
  88         const char *model;
  89         const char *model_version;
  90
  91         const char *firmware;
  92
  93         uint32_t dev_caps;
  94
  95         const char *usb_manufacturer;
  96         const char *usb_product;
  97 };
  98
  99 struct dev_context {
 100         const struct fx2lafw_profile *profile;
 101         GSList *enabled_analog_channels;
 102         /*
 103          * Since we can't keep track of an fx2lafw device after upgrading
 104          * the firmware (it renumerates into a different device address
 105          * after the upgrade) this is like a global lock. No device will open
 106          * until a proper delay after the last device was upgraded.
 107          */
 108         int64_t fw_updated;
 109
 110         /* Supported samplerates */
 111         const uint64_t *samplerates;
 112         int num_samplerates;
 113
 114         /* Device/capture settings */
 115         uint64_t cur_samplerate;
 116         uint64_t limit_samples;
 117         uint64_t capture_ratio;
 118
 119         /* Operational settings */
 120         gboolean trigger_fired;
 121         gboolean acq_aborted;
 122         gboolean sample_wide;
 123         struct soft_trigger_logic *stl;
 124
 125         unsigned int sent_samples;
 126         int submitted_transfers;
 127         int empty_transfer_count;
 128
 129         unsigned int num_transfers;
 130         struct libusb_transfer **transfers;
 131         struct sr_context *ctx;
 132         void (*send_data_proc)(struct sr_dev_inst *sdi,
 133                 uint8_t *data, size_t length, size_t sample_width);
 134         uint8_t *logic_buffer;
 135         float *analog_buffer;
 136
 137         /* Is this a DSLogic? */
 138         gboolean dslogic;
 139         uint16_t dslogic_mode;
 140         uint32_t trigger_pos;
 141         gboolean dslogic_external_clock;
 142         gboolean dslogic_continuous_mode;
 143         int dslogic_clock_edge;
 144         int dslogic_voltage_threshold;
 145 };
 146
 147 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi);
 148 SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
 149                 const char *product);
 150 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
 151 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
 152 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
 153 SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer);
 154 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
 155 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
 156 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);
 157 SR_PRIV void la_send_data_proc(struct sr_dev_inst *sdi, uint8_t *data,
 158                 size_t length, size_t sample_width);
 159 SR_PRIV void mso_send_data_proc(struct sr_dev_inst *sdi, uint8_t *data,
 160                 size_t length, size_t sample_width);
 161
 162 #endif