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
  55 #define DEV_CAPS_16BIT          (1 << DEV_CAPS_16BIT_POS)
  56 #define DEV_CAPS_AX_ANALOG      (1 << DEV_CAPS_AX_ANALOG_POS)
  57
  58 /* Protocol commands */
  59 #define CMD_GET_FW_VERSION              0xb0
  60 #define CMD_START                       0xb1
  61 #define CMD_GET_REVID_VERSION           0xb2
  62
  63 #define CMD_START_FLAGS_CLK_CTL2_POS    4
  64 #define CMD_START_FLAGS_WIDE_POS        5
  65 #define CMD_START_FLAGS_CLK_SRC_POS     6
  66
  67 #define CMD_START_FLAGS_CLK_CTL2        (1 << CMD_START_FLAGS_CLK_CTL2_POS)
  68 #define CMD_START_FLAGS_SAMPLE_8BIT     (0 << CMD_START_FLAGS_WIDE_POS)
  69 #define CMD_START_FLAGS_SAMPLE_16BIT    (1 << CMD_START_FLAGS_WIDE_POS)
  70
  71 #define CMD_START_FLAGS_CLK_30MHZ       (0 << CMD_START_FLAGS_CLK_SRC_POS)
  72 #define CMD_START_FLAGS_CLK_48MHZ       (1 << CMD_START_FLAGS_CLK_SRC_POS)
  73
  74 struct fx2lafw_profile {
  75         uint16_t vid;
  76         uint16_t pid;
  77
  78         const char *vendor;
  79         const char *model;
  80         const char *model_version;
  81
  82         const char *firmware;
  83
  84         uint32_t dev_caps;
  85
  86         const char *usb_manufacturer;
  87         const char *usb_product;
  88 };
  89
  90 struct dev_context {
  91         const struct fx2lafw_profile *profile;
  92         GSList *enabled_analog_channels;
  93         /*
  94          * Since we can't keep track of an fx2lafw device after upgrading
  95          * the firmware (it renumerates into a different device address
  96          * after the upgrade) this is like a global lock. No device will open
  97          * until a proper delay after the last device was upgraded.
  98          */
  99         int64_t fw_updated;
 100
 101         const uint64_t *samplerates;
 102         int num_samplerates;
 103
 104         uint64_t cur_samplerate;
 105         uint64_t limit_frames;
 106         uint64_t limit_samples;
 107         uint64_t capture_ratio;
 108
 109         gboolean trigger_fired;
 110         gboolean acq_aborted;
 111         gboolean sample_wide;
 112         struct soft_trigger_logic *stl;
 113
 114         uint64_t num_frames;
 115         uint64_t sent_samples;
 116         int submitted_transfers;
 117         int empty_transfer_count;
 118
 119         unsigned int num_transfers;
 120         struct libusb_transfer **transfers;
 121         struct sr_context *ctx;
 122         void (*send_data_proc)(struct sr_dev_inst *sdi,
 123                 uint8_t *data, size_t length, size_t sample_width);
 124         uint8_t *logic_buffer;
 125         float *analog_buffer;
 126 };
 127
 128 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di);
 129 SR_PRIV struct dev_context *fx2lafw_dev_new(void);
 130 SR_PRIV int fx2lafw_start_acquisition(const struct sr_dev_inst *sdi);
 131 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc);
 132
 133 #endif