hardware/fx2lafw/fx2lafw.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 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_FX2LAFW_H
  22 #define LIBSIGROK_HARDWARE_FX2LAFW_FX2LAFW_H
  23
  24 #include <glib.h>
  25
  26 /* Message logging helpers with driver-specific prefix string. */
  27 #define DRIVER_LOG_DOMAIN "fx2lafw: "
  28 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  29 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  30 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  31 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  32 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  34
  35 #define USB_INTERFACE           0
  36 #define USB_CONFIGURATION       1
  37 #define NUM_TRIGGER_STAGES      4
  38 #define TRIGGER_TYPE            "01"
  39
  40 #define MAX_RENUM_DELAY_MS      3000
  41 #define NUM_SIMUL_TRANSFERS     32
  42 #define MAX_EMPTY_TRANSFERS     (NUM_SIMUL_TRANSFERS * 2)
  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 /* Software trigger implementation: positive values indicate trigger stage. */
  53 #define TRIGGER_FIRED          -1
  54
  55 #define DEV_CAPS_16BIT_POS      0
  56
  57 #define DEV_CAPS_16BIT          (1 << DEV_CAPS_16BIT_POS)
  58
  59 struct fx2lafw_profile {
  60         uint16_t vid;
  61         uint16_t pid;
  62
  63         const char *vendor;
  64         const char *model;
  65         const char *model_version;
  66
  67         const char *firmware;
  68
  69         uint32_t dev_caps;
  70 };
  71
  72 struct dev_context {
  73         const struct fx2lafw_profile *profile;
  74
  75         /*
  76          * Since we can't keep track of an fx2lafw device after upgrading
  77          * the firmware (it renumerates into a different device address
  78          * after the upgrade) this is like a global lock. No device will open
  79          * until a proper delay after the last device was upgraded.
  80          */
  81         int64_t fw_updated;
  82
  83         /* Device/capture settings */
  84         uint64_t cur_samplerate;
  85         uint64_t limit_samples;
  86
  87         gboolean sample_wide;
  88
  89         uint16_t trigger_mask[NUM_TRIGGER_STAGES];
  90         uint16_t trigger_value[NUM_TRIGGER_STAGES];
  91         int trigger_stage;
  92         uint16_t trigger_buffer[NUM_TRIGGER_STAGES];
  93
  94         int num_samples;
  95         int submitted_transfers;
  96         int empty_transfer_count;
  97
  98         void *cb_data;
  99
 100         struct sr_usb_dev_inst *usb;
 101
 102         unsigned int num_transfers;
 103         struct libusb_transfer **transfers;
 104 };
 105
 106 #endif