src/hardware/kingst-la2016/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
   5  * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
   6  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   7  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   8  *
   9  * This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #ifndef LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
  24 #define LIBSIGROK_HARDWARE_KINGST_LA2016_PROTOCOL_H
  25
  26 #include <libsigrok/libsigrok.h>
  27 #include <stdint.h>
  28
  29 #define LOG_PREFIX      "kingst-la2016"
  30
  31 #define LA2016_VID              0x77a1
  32 #define LA2016_PID              0x01a2
  33 #define LA2016_IPRODUCT_INDEX   2
  34 #define USB_INTERFACE           0
  35 #define USB_CONFIGURATION       1
  36 #define USB_EP_FPGA_BITSTREAM   2
  37 #define USB_EP_CAPTURE_DATA     6
  38
  39 /*
  40  * On Windows sigrok uses WinUSB RAW_IO policy which requires the
  41  * USB transfer buffer size to be a multiple of the endpoint max packet
  42  * size, which is 512 bytes in this case. Also, the maximum allowed size
  43  * of the transfer buffer is normally read from WinUSB_GetPipePolicy API
  44  * but libusb does not expose this function. Typically, max size is 2MB.
  45  */
  46 #define LA2016_EP6_PKTSZ        512 /* Max packet size of USB endpoint 6. */
  47 #define LA2016_USB_BUFSZ        (256 * 2 * LA2016_EP6_PKTSZ) /* 256KiB buffer. */
  48
  49 /* USB communication timeout during regular operation. */
  50 #define DEFAULT_TIMEOUT_MS      200
  51
  52 /*
  53  * Check for MCU firmware to take effect after upload. Check the device
  54  * presence for a maximum period of time, delay between checks in that
  55  * phase. Allow for the device to vanish after upload and before checks,
  56  * to not mistake its earlier incarnation for the successful operation
  57  * of the most recently loaded firmware.
  58  */
  59 #define RENUM_CHECK_PERIOD_MS   3000
  60 #define RENUM_GONE_DELAY_MS     1800
  61 #define RENUM_POLL_INTERVAL_MS  200
  62
  63 /*
  64  * The device expects some zero padding to follow the content of the
  65  * file which contains the FPGA bitstream. Specify the chunk size here.
  66  */
  67 #define LA2016_EP2_PADDING      2048
  68
  69 #define LA2016_THR_VOLTAGE_MIN  0.40
  70 #define LA2016_THR_VOLTAGE_MAX  4.00
  71
  72 #define LA2016_NUM_SAMPLES_MIN  (UINT64_C(256))
  73 #define LA2016_NUM_SAMPLES_MAX  (UINT64_C(10 * 1000 * 1000 * 1000))
  74
  75 /* Maximum device capabilities. May differ between models. */
  76 #define MAX_SAMPLE_RATE_LA2016  SR_MHZ(200)
  77 #define MAX_SAMPLE_RATE_LA1016  SR_MHZ(100)
  78 #define MIN_SAMPLE_RATE_LA2016  SR_KHZ(10)
  79 #define MAX_PWM_FREQ            SR_MHZ(20)
  80 #define PWM_CLOCK               SR_MHZ(200)     /* 200MHz for both LA2016 and LA1016 */
  81
  82 /* TODO
  83  * What is the origin and motivation of that 128Mi literal? What is its
  84  * unit? How does it relate to a device's hardware capabilities? How to
  85  * map the 1GiB of RAM of an LA2016 (at 16 channels) to the 128Mi value?
  86  * It cannot be sample count. Is it memory size in bytes perhaps?
  87  */
  88 #define LA2016_PRE_MEM_LIMIT_BASE       (128 * 1024 * 1024)
  89
  90 #define LA2016_NUM_PWMCH_MAX    2
  91
  92 #define LA2016_CONVBUFFER_SIZE  (4 * 1024 * 1024)
  93
  94 struct kingst_model {
  95         uint8_t magic;          /* EEPROM magic byte value. */
  96         const char *name;       /* User perceived model name. */
  97         const char *fpga_stem;  /* Bitstream filename stem. */
  98         uint64_t samplerate;    /* Max samplerate in Hz. */
  99         size_t channel_count;   /* Max channel count (16, 32). */
 100         uint64_t memory_bits;   /* RAM capacity in Gbit (1, 2, 4). */
 101 };
 102
 103 struct pwm_setting_dev {
 104         uint32_t period;
 105         uint32_t duty;
 106 };
 107
 108 struct trigger_cfg {
 109         uint32_t channels;
 110         uint32_t enabled;
 111         uint32_t level;
 112         uint32_t high_or_falling;
 113 };
 114
 115 struct capture_info {
 116         uint32_t n_rep_packets;
 117         uint32_t n_rep_packets_before_trigger;
 118         uint32_t write_pos;
 119 };
 120
 121 #define NUM_PACKETS_IN_CHUNK    5
 122 #define TRANSFER_PACKET_LENGTH  16
 123
 124 struct pwm_setting {
 125         gboolean enabled;
 126         float freq;
 127         float duty;
 128 };
 129
 130 struct dev_context {
 131         uint16_t usb_pid;
 132         char *mcu_firmware;
 133         char *fpga_bitstream;
 134         uint64_t fw_uploaded; /* Timestamp of most recent FW upload. */
 135         uint8_t identify_magic;
 136         const struct kingst_model *model;
 137
 138         /* User specified parameters. */
 139         struct pwm_setting pwm_setting[LA2016_NUM_PWMCH_MAX];
 140         size_t threshold_voltage_idx;
 141         float threshold_voltage;
 142         uint64_t cur_samplerate;
 143         struct sr_sw_limits sw_limits;
 144         uint64_t capture_ratio;
 145
 146         /* Internal acquisition and download state. */
 147         gboolean trigger_involved;
 148         gboolean completion_seen;
 149         gboolean download_finished;
 150         struct capture_info info;
 151         uint32_t n_transfer_packets_to_read; /* each with 5 acq packets */
 152         uint32_t n_bytes_to_read;
 153         uint32_t n_reps_until_trigger;
 154         gboolean trigger_marked;
 155         uint64_t total_samples;
 156         uint32_t read_pos;
 157
 158         struct feed_queue_logic *feed_queue;
 159         struct libusb_transfer *transfer;
 160 };
 161
 162 SR_PRIV int la2016_upload_firmware(const struct sr_dev_inst *sdi,
 163         struct sr_context *sr_ctx, libusb_device *dev, uint16_t product_id);
 164 SR_PRIV int la2016_setup_acquisition(const struct sr_dev_inst *sdi);
 165 SR_PRIV int la2016_start_acquisition(const struct sr_dev_inst *sdi);
 166 SR_PRIV int la2016_abort_acquisition(const struct sr_dev_inst *sdi);
 167 SR_PRIV int la2016_receive_data(int fd, int revents, void *cb_data);
 168 SR_PRIV int la2016_identify_device(const struct sr_dev_inst *sdi,
 169         gboolean show_message);
 170 SR_PRIV int la2016_init_device(const struct sr_dev_inst *sdi);
 171 SR_PRIV int la2016_deinit_device(const struct sr_dev_inst *sdi);
 172
 173 #endif