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.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 FX2LAFW_REQUIRED_VERSION_MAJOR  1
  43
  44 #define MAX_8BIT_SAMPLE_RATE    SR_MHZ(24)
  45 #define MAX_16BIT_SAMPLE_RATE   SR_MHZ(12)
  46
  47 /* 6 delay states of up to 256 clock ticks */
  48 #define MAX_SAMPLE_DELAY        (6 * 256)
  49
  50 #define DEV_CAPS_16BIT_POS      0
  51
  52 #define DEV_CAPS_16BIT          (1 << DEV_CAPS_16BIT_POS)
  53
  54 #define DSLOGIC_FPGA_FIRMWARE FIRMWARE_DIR "/dreamsourcelab-dslogic-fpga.fw"
  55
  56 /* Protocol commands */
  57 #define CMD_GET_FW_VERSION              0xb0
  58 #define CMD_START                       0xb1
  59 #define CMD_GET_REVID_VERSION           0xb2
  60
  61 #define CMD_START_FLAGS_WIDE_POS        5
  62 #define CMD_START_FLAGS_CLK_SRC_POS     6
  63
  64 #define CMD_START_FLAGS_SAMPLE_8BIT     (0 << CMD_START_FLAGS_WIDE_POS)
  65 #define CMD_START_FLAGS_SAMPLE_16BIT    (1 << CMD_START_FLAGS_WIDE_POS)
  66
  67 #define CMD_START_FLAGS_CLK_30MHZ       (0 << CMD_START_FLAGS_CLK_SRC_POS)
  68 #define CMD_START_FLAGS_CLK_48MHZ       (1 << CMD_START_FLAGS_CLK_SRC_POS)
  69
  70 struct fx2lafw_profile {
  71         uint16_t vid;
  72         uint16_t pid;
  73
  74         const char *vendor;
  75         const char *model;
  76         const char *model_version;
  77
  78         const char *firmware;
  79
  80         uint32_t dev_caps;
  81
  82         const char *usb_manufacturer;
  83         const char *usb_product;
  84 };
  85
  86 struct dev_context {
  87         const struct fx2lafw_profile *profile;
  88         /*
  89          * Since we can't keep track of an fx2lafw device after upgrading
  90          * the firmware (it renumerates into a different device address
  91          * after the upgrade) this is like a global lock. No device will open
  92          * until a proper delay after the last device was upgraded.
  93          */
  94         int64_t fw_updated;
  95
  96         /* Supported samplerates */
  97         const uint64_t *samplerates;
  98         int num_samplerates;
  99
 100         /* Device/capture settings */
 101         uint64_t cur_samplerate;
 102         uint64_t limit_samples;
 103         uint64_t capture_ratio;
 104
 105         /* Operational settings */
 106         gboolean trigger_fired;
 107         gboolean acq_aborted;
 108         gboolean sample_wide;
 109         struct soft_trigger_logic *stl;
 110
 111         unsigned int sent_samples;
 112         int submitted_transfers;
 113         int empty_transfer_count;
 114
 115         void *cb_data;
 116         unsigned int num_transfers;
 117         struct libusb_transfer **transfers;
 118         struct sr_context *ctx;
 119
 120         /* Is this a DSLogic? */
 121         gboolean dslogic;
 122         uint16_t dslogic_mode;
 123         int dslogic_external_clock;
 124 };
 125
 126 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi);
 127 SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
 128                 const char *product);
 129 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
 130 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
 131 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
 132 SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer);
 133 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
 134 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
 135 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);
 136
 137 #endif