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 #define TRIGGER_TYPE            "01"
  38
  39 #define MAX_RENUM_DELAY_MS      3000
  40 #define NUM_SIMUL_TRANSFERS     32
  41 #define MAX_EMPTY_TRANSFERS     (NUM_SIMUL_TRANSFERS * 2)
  42
  43 #define FX2LAFW_REQUIRED_VERSION_MAJOR  1
  44
  45 #define MAX_8BIT_SAMPLE_RATE    SR_MHZ(24)
  46 #define MAX_16BIT_SAMPLE_RATE   SR_MHZ(12)
  47
  48 /* 6 delay states of up to 256 clock ticks */
  49 #define MAX_SAMPLE_DELAY        (6 * 256)
  50
  51 /* Software trigger implementation: positive values indicate trigger stage. */
  52 #define TRIGGER_FIRED          -1
  53
  54 #define DEV_CAPS_16BIT_POS      0
  55
  56 #define DEV_CAPS_16BIT          (1 << DEV_CAPS_16BIT_POS)
  57
  58 struct fx2lafw_profile {
  59         uint16_t vid;
  60         uint16_t pid;
  61
  62         const char *vendor;
  63         const char *model;
  64         const char *model_version;
  65
  66         const char *firmware;
  67
  68         uint32_t dev_caps;
  69 };
  70
  71 struct dev_context {
  72         const struct fx2lafw_profile *profile;
  73         /*
  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.
  78          */
  79         int64_t fw_updated;
  80
  81         /* Device/capture settings */
  82         uint64_t cur_samplerate;
  83         uint64_t limit_samples;
  84
  85         /* Operational settings */
  86         gboolean sample_wide;
  87         uint16_t trigger_mask[NUM_TRIGGER_STAGES];
  88         uint16_t trigger_value[NUM_TRIGGER_STAGES];
  89         int trigger_stage;
  90         uint16_t trigger_buffer[NUM_TRIGGER_STAGES];
  91
  92         int num_samples;
  93         int submitted_transfers;
  94         int empty_transfer_count;
  95
  96         void *cb_data;
  97         unsigned int num_transfers;
  98         struct libusb_transfer **transfers;
  99         struct sr_context *ctx;
 100 };
 101
 102 SR_PRIV int fx2lafw_command_start_acquisition(libusb_device_handle *devhdl,
 103                 uint64_t samplerate, gboolean samplewide);
 104 SR_PRIV gboolean fx2lafw_check_conf_profile(libusb_device *dev);
 105 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
 106 SR_PRIV int fx2lafw_configure_channels(const struct sr_dev_inst *sdi);
 107 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
 108 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
 109 SR_PRIV void fx2lafw_receive_transfer(struct libusb_transfer *transfer);
 110 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc);
 111 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc);
 112 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc);
 113
 114 #endif