src/hardware/asix-sigma/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
   5  * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
   6  * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
   7  * Copyright (C) 2020 Gerhard Sittig <gerhard.sittig@gmx.net>
   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_ASIX_SIGMA_PROTOCOL_H
  24 #define LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H
  25
  26 #include <stdint.h>
  27 #include <stdlib.h>
  28 #include <glib.h>
  29 #include <ftdi.h>
  30 #include <string.h>
  31 #include <libsigrok/libsigrok.h>
  32 #include "libsigrok-internal.h"
  33
  34 #define LOG_PREFIX "asix-sigma"
  35
  36 /*
  37  * Triggers are not working in this implementation. Stop claiming
  38  * support for the feature which effectively is not available, until
  39  * the implementation got fixed. Yet keep the code in place and allow
  40  * developers to turn on this switch during development.
  41  */
  42 #define ASIX_SIGMA_WITH_TRIGGER 0
  43
  44 /* Experimental support for OMEGA (scan only, operation is ENOIMPL). */
  45 #define ASIX_WITH_OMEGA 0
  46
  47 #define USB_VENDOR_ASIX                 0xa600
  48 #define USB_PRODUCT_SIGMA               0xa000
  49 #define USB_PRODUCT_OMEGA               0xa004
  50
  51 enum asix_device_type {
  52         ASIX_TYPE_NONE,
  53         ASIX_TYPE_SIGMA,
  54         ASIX_TYPE_OMEGA,
  55 };
  56
  57 /*
  58  * FPGA commands are 8bits wide. The upper nibble is a command opcode,
  59  * the lower nibble can carry operand values. 8bit register addresses
  60  * and 8bit data values get communicated in two steps.
  61  */
  62
  63 /* Register access. */
  64 #define REG_ADDR_LOW            (0x0 << 4)
  65 #define REG_ADDR_HIGH           (0x1 << 4)
  66 #define REG_DATA_LOW            (0x2 << 4)
  67 #define REG_DATA_HIGH_WRITE     (0x3 << 4)
  68 #define REG_READ_ADDR           (0x4 << 4)
  69 #define REG_ADDR_ADJUST         (1 << 0) /* Auto adjust register address. */
  70 #define REG_ADDR_DOWN           (1 << 1) /* 1 decrement, 0 increment. */
  71 #define REG_ADDR_INC            (REG_ADDR_ADJUST)
  72 #define REG_ADDR_DEC            (REG_ADDR_ADJUST | REG_ADDR_DOWN)
  73
  74 /* Sample memory access. */
  75 #define REG_DRAM_WAIT_ACK       (0x5 << 4) /* Wait for completion. */
  76 #define REG_DRAM_BLOCK          (0x6 << 4) /* DRAM to BRAM, plus bank select. */
  77 #define REG_DRAM_BLOCK_BEGIN    (0x8 << 4) /* Read first BRAM bytes. */
  78 #define REG_DRAM_BLOCK_DATA     (0xa << 4) /* Read full BRAM block. */
  79 #define REG_DRAM_SEL_N          (0x1 << 4) /* Bank select, added to 6/8/a. */
  80 #define REG_DRAM_SEL_BOOL(b)    ((b) ? REG_DRAM_SEL_N : 0)
  81
  82 /*
  83  * Registers at a specific address can have different meanings depending
  84  * on whether data is read or written. This is why direction is part of
  85  * the programming language identifiers.
  86  *
  87  * The vendor documentation suggests that in addition to the first 16
  88  * register addresses which implement the logic analyzer's feature set,
  89  * there are 240 more registers in the 16 to 255 address range which
  90  * are available to applications and plugin features. Can libsigrok's
  91  * asix-sigma driver store configuration data there, to avoid expensive
  92  * operations (think: firmware re-load).
  93  */
  94
  95 enum sigma_write_register {
  96         WRITE_CLOCK_SELECT      = 0,
  97         WRITE_TRIGGER_SELECT    = 1,
  98         WRITE_TRIGGER_SELECT2   = 2,
  99         WRITE_MODE              = 3,
 100         WRITE_MEMROW            = 4,
 101         WRITE_POST_TRIGGER      = 5,
 102         WRITE_TRIGGER_OPTION    = 6,
 103         WRITE_PIN_VIEW          = 7,
 104         /* Unassigned register locations. */
 105         WRITE_TEST              = 15,
 106 };
 107
 108 enum sigma_read_register {
 109         READ_ID                 = 0,
 110         READ_TRIGGER_POS_LOW    = 1,
 111         READ_TRIGGER_POS_HIGH   = 2,
 112         READ_TRIGGER_POS_UP     = 3,
 113         READ_STOP_POS_LOW       = 4,
 114         READ_STOP_POS_HIGH      = 5,
 115         READ_STOP_POS_UP        = 6,
 116         READ_MODE               = 7,
 117         READ_PIN_CHANGE_LOW     = 8,
 118         READ_PIN_CHANGE_HIGH    = 9,
 119         READ_BLOCK_LAST_TS_LOW  = 10,
 120         READ_BLOCK_LAST_TS_HIGH = 11,
 121         READ_BLOCK_TS_OVERRUN   = 12,
 122         READ_PIN_VIEW           = 13,
 123         /* Unassigned register location. */
 124         READ_TEST               = 15,
 125 };
 126
 127 #define TRGSEL2_LEDSEL0         (1 << 6)
 128 #define TRGSEL2_LEDSEL1         (1 << 7)
 129
 130 /* WRITE_MODE register fields. */
 131 #define WMR_SDRAMWRITEEN        (1 << 0)
 132 #define WMR_SDRAMREADEN         (1 << 1)
 133 #define WMR_TRGRES              (1 << 2)
 134 #define WMR_TRGEN               (1 << 3)
 135 #define WMR_FORCESTOP           (1 << 4)
 136 #define WMR_TRGSW               (1 << 5)
 137 /* not used: bit position 6 */
 138 #define WMR_SDRAMINIT           (1 << 7)
 139
 140 /* READ_MODE register fields. */
 141 #define RMR_SDRAMWRITEEN        (1 << 0)
 142 #define RMR_SDRAMREADEN         (1 << 1)
 143 /* not used: bit position 2 */
 144 #define RMR_TRGEN               (1 << 3)
 145 #define RMR_ROUND               (1 << 4)
 146 #define RMR_TRIGGERED           (1 << 5)
 147 #define RMR_POSTTRIGGERED       (1 << 6)
 148 /* not used: bit position 7 */
 149
 150 /*
 151  * Trigger options. First and second write are similar, but _some_
 152  * positions change their meaning.
 153  */
 154 #define TRGOPT_TRGIEN           (1 << 7)
 155 #define TRGOPT_TRGOEN           (1 << 6)
 156 #define TRGOPT_TRGOINEN         (1 << 5) /* 1st write */
 157 #define TRGOPT_TRGINEG          TRGOPT1_TRGOINEN /* 2nd write */
 158 #define TRGOPT_TRGOEVNTEN       (1 << 4) /* 1st write */
 159 #define TRGOPT_TRGOPIN          TRGOPT1_TRGOEVNTEN /* 2nd write */
 160 #define TRGOPT_TRGOOUTEN        (1 << 3) /* 1st write */
 161 #define TRGOPT_TRGOLONG         TRGOPT1_TRGOOUTEN /* 2nd write */
 162 #define TRGOPT_TRGOUTR_OUT      (1 << 1)
 163 #define TRGOPT_TRGOUTR_EN       (1 << 0)
 164 #define TRGOPT_CLEAR_MASK       (TRGOPT_TRGOINEN | TRGOPT_TRGOEVNTEN | TRGOPT_TRGOOUTEN)
 165
 166 /*
 167  * Layout of the sample data DRAM, which will be downloaded to the PC:
 168  *
 169  * Sigma memory is organized in 32K rows. Each row contains 64 clusters.
 170  * Each cluster contains a timestamp (16bit) and 7 events (16bits each).
 171  * Events contain 16 bits of sample data (potentially taken at multiple
 172  * sample points, see below).
 173  *
 174  * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MiB (256 Mbit). The
 175  * size of a memory row is 1024 bytes. Assuming x16 organization of the
 176  * memory array, address specs (sample count, trigger position) are kept
 177  * in 24bit entities. The upper 15 bit address the "row", the lower 9 bit
 178  * refer to the "event" within the row. Because there is one timestamp for
 179  * seven events each, one memory row can hold up to 64x7 == 448 events.
 180  *
 181  * Sample data is represented in 16bit quantities. The first sample in
 182  * the cluster corresponds to the cluster's timestamp. Each next sample
 183  * corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
 184  * one sample period, according to the samplerate). In the absence of
 185  * pin level changes, no data is provided (RLE compression). A cluster
 186  * is enforced for each 64K ticks of the timestamp, to reliably handle
 187  * rollover and determine the next timestamp of the next cluster.
 188  *
 189  * For samplerates up to 50MHz, an event directly translates to one set
 190  * of sample data at a single sample point, spanning up to 16 channels.
 191  * For samplerates of 100MHz, there is one 16 bit entity for each 20ns
 192  * period (50MHz rate). The 16 bit memory contains 2 samples of up to
 193  * 8 channels. Bits of multiple samples are interleaved. For samplerates
 194  * of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
 195  * each 5ns apart.
 196  */
 197
 198 #define ROW_COUNT               32768
 199 #define ROW_LENGTH_BYTES        1024
 200 #define ROW_LENGTH_U16          (ROW_LENGTH_BYTES / sizeof(uint16_t))
 201 #define ROW_SHIFT               9 /* log2 of u16 count */
 202 #define ROW_MASK                ((1UL << ROW_SHIFT) - 1)
 203 #define EVENTS_PER_CLUSTER      7
 204 #define CLUSTERS_PER_ROW        (ROW_LENGTH_U16 / (1 + EVENTS_PER_CLUSTER))
 205 #define EVENTS_PER_ROW          (CLUSTERS_PER_ROW * EVENTS_PER_CLUSTER)
 206
 207 struct sigma_dram_line {
 208         struct sigma_dram_cluster {
 209                 uint16_t timestamp;
 210                 uint16_t samples[EVENTS_PER_CLUSTER];
 211         } cluster[CLUSTERS_PER_ROW];
 212 };
 213
 214 struct clockselect_50 {
 215         uint8_t async;
 216         uint64_t fraction;
 217         uint16_t disabled_channels;
 218 };
 219
 220 /* The effect of all these are still a bit unclear. */
 221 struct triggerinout {
 222         uint8_t trgout_resistor_enable : 1;
 223         uint8_t trgout_resistor_pullup : 1;
 224         uint8_t reserved1 : 1;
 225         uint8_t trgout_bytrigger : 1;
 226         uint8_t trgout_byevent : 1;
 227         uint8_t trgout_bytriggerin : 1;
 228         uint8_t reserved2 : 2;
 229
 230         /* Should be set same as the first two */
 231         uint8_t trgout_resistor_enable2 : 1;
 232         uint8_t trgout_resistor_pullup2 : 1;
 233
 234         uint8_t reserved3 : 1;
 235         uint8_t trgout_long : 1;
 236         uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
 237         uint8_t trgin_negate : 1;
 238         uint8_t trgout_enable : 1;
 239         uint8_t trgin_enable : 1;
 240 };
 241
 242 struct triggerlut {
 243         /* The actual LUTs. */
 244         uint16_t m0d[4], m1d[4], m2d[4];
 245         uint16_t m3, m3s, m4;
 246
 247         /* Parameters should be sent as a single register write. */
 248         struct {
 249                 uint8_t selc : 2;
 250                 uint8_t selpresc : 6;
 251
 252                 uint8_t selinc : 2;
 253                 uint8_t selres : 2;
 254                 uint8_t sela : 2;
 255                 uint8_t selb : 2;
 256
 257                 uint16_t cmpb;
 258                 uint16_t cmpa;
 259         } params;
 260 };
 261
 262 /* Trigger configuration */
 263 struct sigma_trigger {
 264         /* Only two channels can be used in mask. */
 265         uint16_t risingmask;
 266         uint16_t fallingmask;
 267
 268         /* Simple trigger support (<= 50 MHz). */
 269         uint16_t simplemask;
 270         uint16_t simplevalue;
 271
 272         /* TODO: Advanced trigger support (boolean expressions). */
 273 };
 274
 275 /* Events for trigger operation. */
 276 enum triggerop {
 277         OP_LEVEL = 1,
 278         OP_NOT,
 279         OP_RISE,
 280         OP_FALL,
 281         OP_RISEFALL,
 282         OP_NOTRISE,
 283         OP_NOTFALL,
 284         OP_NOTRISEFALL,
 285 };
 286
 287 /* Logical functions for trigger operation. */
 288 enum triggerfunc {
 289         FUNC_AND = 1,
 290         FUNC_NAND,
 291         FUNC_OR,
 292         FUNC_NOR,
 293         FUNC_XOR,
 294         FUNC_NXOR,
 295 };
 296
 297 struct sigma_state {
 298         enum {
 299                 SIGMA_UNINITIALIZED = 0,
 300                 SIGMA_CONFIG,
 301                 SIGMA_IDLE,
 302                 SIGMA_CAPTURE,
 303                 SIGMA_STOPPING,
 304                 SIGMA_DOWNLOAD,
 305         } state;
 306         uint16_t lastts;
 307         uint16_t lastsample;
 308 };
 309
 310 enum sigma_firmware_idx {
 311         SIGMA_FW_NONE,
 312         SIGMA_FW_50MHZ,
 313         SIGMA_FW_100MHZ,
 314         SIGMA_FW_200MHZ,
 315         SIGMA_FW_SYNC,
 316         SIGMA_FW_FREQ,
 317 };
 318
 319 struct submit_buffer;
 320
 321 struct dev_context {
 322         struct {
 323                 uint16_t vid, pid;
 324                 uint32_t serno;
 325                 uint16_t prefix;
 326                 enum asix_device_type type;
 327         } id;
 328         struct {
 329                 struct ftdi_context ctx;
 330                 gboolean is_open, must_close;
 331         } ftdi;
 332         uint64_t samplerate;
 333         struct sr_sw_limits cfg_limits; /* Configured limits (user specified). */
 334         struct sr_sw_limits acq_limits; /* Acquisition limits (internal use). */
 335         struct sr_sw_limits feed_limits; /* Datafeed limits (internal use). */
 336         enum sigma_firmware_idx firmware_idx;
 337         int num_channels;
 338         int samples_per_event;
 339         uint64_t capture_ratio;
 340         struct sigma_trigger trigger;
 341         int use_triggers;
 342         struct sigma_state state;
 343         struct submit_buffer *buffer;
 344 };
 345
 346 /* "Automatic" and forced USB connection open/close support. */
 347 SR_PRIV int sigma_check_open(const struct sr_dev_inst *sdi);
 348 SR_PRIV int sigma_check_close(struct dev_context *devc);
 349 SR_PRIV int sigma_force_open(const struct sr_dev_inst *sdi);
 350 SR_PRIV int sigma_force_close(struct dev_context *devc);
 351
 352 /* Send register content (simple and complex) to the hardware. */
 353 SR_PRIV int sigma_write_register(struct dev_context *devc,
 354         uint8_t reg, uint8_t *data, size_t len);
 355 SR_PRIV int sigma_set_register(struct dev_context *devc,
 356         uint8_t reg, uint8_t value);
 357 SR_PRIV int sigma_write_trigger_lut(struct dev_context *devc,
 358         struct triggerlut *lut);
 359
 360 /* Samplerate constraints check, get/set/list helpers. */
 361 SR_PRIV int sigma_normalize_samplerate(uint64_t want_rate, uint64_t *have_rate);
 362
 363 extern SR_PRIV const uint64_t samplerates[];
 364 extern SR_PRIV const size_t samplerates_count;
 365
 366 /* Preparation of data acquisition, spec conversion, hardware configuration. */
 367 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi);
 368 SR_PRIV int sigma_set_acquire_timeout(struct dev_context *devc);
 369 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
 370 SR_PRIV int sigma_build_basic_trigger(struct dev_context *devc,
 371         struct triggerlut *lut);
 372
 373 /* Callback to periodically drive acuisition progress. */
 374 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
 375
 376 #endif