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 HI4(b)                  (((b) >> 4) & 0x0f)
 128 #define LO4(b)                  (((b) >> 0) & 0x0f)
 129
 130 #define BIT_MASK(l)     ((1UL << (l)) - 1)
 131
 132 #define CLKSEL_CLKSEL8          (1 << 0)
 133 #define CLKSEL_PINMASK          BIT_MASK(4)
 134 #define CLKSEL_RISING           (1 << 4)
 135 #define CLKSEL_FALLING          (1 << 5)
 136
 137 #define TRGSEL_SELINC_MASK      BIT_MASK(2)
 138 #define TRGSEL_SELINC_SHIFT     0
 139 #define TRGSEL_SELRES_MASK      BIT_MASK(2)
 140 #define TRGSEL_SELRES_SHIFT     2
 141 #define TRGSEL_SELA_MASK        BIT_MASK(2)
 142 #define TRGSEL_SELA_SHIFT       4
 143 #define TRGSEL_SELB_MASK        BIT_MASK(2)
 144 #define TRGSEL_SELB_SHIFT       6
 145 #define TRGSEL_SELC_MASK        BIT_MASK(2)
 146 #define TRGSEL_SELC_SHIFT       8
 147 #define TRGSEL_SELPRESC_MASK    BIT_MASK(4)
 148 #define TRGSEL_SELPRESC_SHIFT   12
 149
 150 enum trgsel_selcode_t {
 151         TRGSEL_SELCODE_LEVEL = 0,
 152         TRGSEL_SELCODE_FALL = 1,
 153         TRGSEL_SELCODE_RISE = 2,
 154         TRGSEL_SELCODE_EVENT = 3,
 155         TRGSEL_SELCODE_NEVER = 3,
 156 };
 157
 158 #define TRGSEL2_PINS_MASK       BIT_MASK(3)
 159 #define TRGSEL2_PINPOL_RISE     (1 << 3)
 160 #define TRGSEL2_LUT_ADDR_MASK   BIT_MASK(4)
 161 #define TRGSEL2_LUT_WRITE       (1 << 4)
 162 #define TRGSEL2_RESET           (1 << 5)
 163 #define TRGSEL2_LEDSEL0         (1 << 6)
 164 #define TRGSEL2_LEDSEL1         (1 << 7)
 165
 166 /* WRITE_MODE register fields. */
 167 #define WMR_SDRAMWRITEEN        (1 << 0)
 168 #define WMR_SDRAMREADEN         (1 << 1)
 169 #define WMR_TRGRES              (1 << 2)
 170 #define WMR_TRGEN               (1 << 3)
 171 #define WMR_FORCESTOP           (1 << 4)
 172 #define WMR_TRGSW               (1 << 5)
 173 /* not used: bit position 6 */
 174 #define WMR_SDRAMINIT           (1 << 7)
 175
 176 /* READ_MODE register fields. */
 177 #define RMR_SDRAMWRITEEN        (1 << 0)
 178 #define RMR_SDRAMREADEN         (1 << 1)
 179 /* not used: bit position 2 */
 180 #define RMR_TRGEN               (1 << 3)
 181 #define RMR_ROUND               (1 << 4)
 182 #define RMR_TRIGGERED           (1 << 5)
 183 #define RMR_POSTTRIGGERED       (1 << 6)
 184 /* not used: bit position 7 */
 185
 186 /*
 187  * Trigger options. First and second write are similar, but _some_
 188  * positions change their meaning.
 189  */
 190 #define TRGOPT_TRGIEN           (1 << 7)
 191 #define TRGOPT_TRGOEN           (1 << 6)
 192 #define TRGOPT_TRGOINEN         (1 << 5) /* 1st write */
 193 #define TRGOPT_TRGINEG          TRGOPT1_TRGOINEN /* 2nd write */
 194 #define TRGOPT_TRGOEVNTEN       (1 << 4) /* 1st write */
 195 #define TRGOPT_TRGOPIN          TRGOPT1_TRGOEVNTEN /* 2nd write */
 196 #define TRGOPT_TRGOOUTEN        (1 << 3) /* 1st write */
 197 #define TRGOPT_TRGOLONG         TRGOPT1_TRGOOUTEN /* 2nd write */
 198 #define TRGOPT_TRGOUTR_OUT      (1 << 1)
 199 #define TRGOPT_TRGOUTR_EN       (1 << 0)
 200 #define TRGOPT_CLEAR_MASK       (TRGOPT_TRGOINEN | TRGOPT_TRGOEVNTEN | TRGOPT_TRGOOUTEN)
 201
 202 /*
 203  * Layout of the sample data DRAM, which will be downloaded to the PC:
 204  *
 205  * Sigma memory is organized in 32K rows. Each row contains 64 clusters.
 206  * Each cluster contains a timestamp (16bit) and 7 events (16bits each).
 207  * Events contain 16 bits of sample data (potentially taken at multiple
 208  * sample points, see below).
 209  *
 210  * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MiB (256 Mbit). The
 211  * size of a memory row is 1024 bytes. Assuming x16 organization of the
 212  * memory array, address specs (sample count, trigger position) are kept
 213  * in 24bit entities. The upper 15 bit address the "row", the lower 9 bit
 214  * refer to the "event" within the row. Because there is one timestamp for
 215  * seven events each, one memory row can hold up to 64x7 == 448 events.
 216  *
 217  * Sample data is represented in 16bit quantities. The first sample in
 218  * the cluster corresponds to the cluster's timestamp. Each next sample
 219  * corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
 220  * one sample period, according to the samplerate). In the absence of
 221  * pin level changes, no data is provided (RLE compression). A cluster
 222  * is enforced for each 64K ticks of the timestamp, to reliably handle
 223  * rollover and determine the next timestamp of the next cluster.
 224  *
 225  * For samplerates up to 50MHz, an event directly translates to one set
 226  * of sample data at a single sample point, spanning up to 16 channels.
 227  * For samplerates of 100MHz, there is one 16 bit entity for each 20ns
 228  * period (50MHz rate). The 16 bit memory contains 2 samples of up to
 229  * 8 channels. Bits of multiple samples are interleaved. For samplerates
 230  * of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
 231  * each 5ns apart.
 232  */
 233
 234 #define ROW_COUNT               32768
 235 #define ROW_LENGTH_BYTES        1024
 236 #define ROW_LENGTH_U16          (ROW_LENGTH_BYTES / sizeof(uint16_t))
 237 #define ROW_SHIFT               9 /* log2 of u16 count */
 238 #define ROW_MASK                ((1UL << ROW_SHIFT) - 1)
 239 #define EVENTS_PER_CLUSTER      7
 240 #define CLUSTERS_PER_ROW        (ROW_LENGTH_U16 / (1 + EVENTS_PER_CLUSTER))
 241 #define EVENTS_PER_ROW          (CLUSTERS_PER_ROW * EVENTS_PER_CLUSTER)
 242
 243 struct sigma_dram_line {
 244         struct sigma_dram_cluster {
 245                 uint16_t timestamp;
 246                 uint16_t samples[EVENTS_PER_CLUSTER];
 247         } cluster[CLUSTERS_PER_ROW];
 248 };
 249
 250 /* The effect of all these are still a bit unclear. */
 251 struct triggerinout {
 252         gboolean trgout_resistor_enable, trgout_resistor_pullup;
 253         gboolean trgout_resistor_enable2, trgout_resistor_pullup2;
 254         gboolean trgout_bytrigger, trgout_byevent, trgout_bytriggerin;
 255         gboolean trgout_long, trgout_pin; /* 1ms pulse, 1k resistor */
 256         gboolean trgin_negate, trgout_enable, trgin_enable;
 257 };
 258
 259 struct triggerlut {
 260         uint16_t m0d[4], m1d[4], m2d[4];
 261         uint16_t m3q, m3s, m4;
 262         struct {
 263                 uint8_t selpresc;
 264                 uint8_t sela, selb, selc;
 265                 uint8_t selinc, selres;
 266                 uint16_t cmpa, cmpb;
 267         } params;
 268 };
 269
 270 /* Trigger configuration */
 271 struct sigma_trigger {
 272         /* Only two channels can be used in mask. */
 273         uint16_t risingmask;
 274         uint16_t fallingmask;
 275
 276         /* Simple trigger support (<= 50 MHz). */
 277         uint16_t simplemask;
 278         uint16_t simplevalue;
 279
 280         /* TODO: Advanced trigger support (boolean expressions). */
 281 };
 282
 283 /* Events for trigger operation. */
 284 enum triggerop {
 285         OP_LEVEL = 1,
 286         OP_NOT,
 287         OP_RISE,
 288         OP_FALL,
 289         OP_RISEFALL,
 290         OP_NOTRISE,
 291         OP_NOTFALL,
 292         OP_NOTRISEFALL,
 293 };
 294
 295 /* Logical functions for trigger operation. */
 296 enum triggerfunc {
 297         FUNC_AND = 1,
 298         FUNC_NAND,
 299         FUNC_OR,
 300         FUNC_NOR,
 301         FUNC_XOR,
 302         FUNC_NXOR,
 303 };
 304
 305 struct sigma_state {
 306         enum {
 307                 SIGMA_UNINITIALIZED = 0,
 308                 SIGMA_CONFIG,
 309                 SIGMA_IDLE,
 310                 SIGMA_CAPTURE,
 311                 SIGMA_STOPPING,
 312                 SIGMA_DOWNLOAD,
 313         } state;
 314         uint16_t lastts;
 315         uint16_t lastsample;
 316 };
 317
 318 enum sigma_firmware_idx {
 319         SIGMA_FW_NONE,
 320         SIGMA_FW_50MHZ,
 321         SIGMA_FW_100MHZ,
 322         SIGMA_FW_200MHZ,
 323         SIGMA_FW_SYNC,
 324         SIGMA_FW_FREQ,
 325 };
 326
 327 enum ext_clock_edge_t {
 328         SIGMA_CLOCK_EDGE_RISING,
 329         SIGMA_CLOCK_EDGE_FALLING,
 330         SIGMA_CLOCK_EDGE_EITHER,
 331 };
 332
 333 struct submit_buffer;
 334
 335 struct dev_context {
 336         struct {
 337                 uint16_t vid, pid;
 338                 uint32_t serno;
 339                 uint16_t prefix;
 340                 enum asix_device_type type;
 341         } id;
 342         struct {
 343                 struct ftdi_context ctx;
 344                 gboolean is_open, must_close;
 345         } ftdi;
 346         struct {
 347                 uint64_t samplerate;
 348                 gboolean use_ext_clock;
 349                 size_t clock_pin;
 350                 enum ext_clock_edge_t clock_edge;
 351         } clock;
 352         struct sr_sw_limits cfg_limits; /* Configured limits (user specified). */
 353         struct sr_sw_limits acq_limits; /* Acquisition limits (internal use). */
 354         struct sr_sw_limits feed_limits; /* Datafeed limits (internal use). */
 355         enum sigma_firmware_idx firmware_idx;
 356         int num_channels;
 357         int samples_per_event;
 358         uint64_t capture_ratio;
 359         struct sigma_trigger trigger;
 360         int use_triggers;
 361         struct sigma_state state;
 362         struct submit_buffer *buffer;
 363 };
 364
 365 /* "Automatic" and forced USB connection open/close support. */
 366 SR_PRIV int sigma_check_open(const struct sr_dev_inst *sdi);
 367 SR_PRIV int sigma_check_close(struct dev_context *devc);
 368 SR_PRIV int sigma_force_open(const struct sr_dev_inst *sdi);
 369 SR_PRIV int sigma_force_close(struct dev_context *devc);
 370
 371 /* Send register content (simple and complex) to the hardware. */
 372 SR_PRIV int sigma_write_register(struct dev_context *devc,
 373         uint8_t reg, uint8_t *data, size_t len);
 374 SR_PRIV int sigma_set_register(struct dev_context *devc,
 375         uint8_t reg, uint8_t value);
 376 SR_PRIV int sigma_write_trigger_lut(struct dev_context *devc,
 377         struct triggerlut *lut);
 378
 379 /* Samplerate constraints check, get/set/list helpers. */
 380 SR_PRIV int sigma_normalize_samplerate(uint64_t want_rate, uint64_t *have_rate);
 381 SR_PRIV uint64_t sigma_get_samplerate(const struct sr_dev_inst *sdi);
 382 SR_PRIV GVariant *sigma_get_samplerates_list(void);
 383
 384 /* Preparation of data acquisition, spec conversion, hardware configuration. */
 385 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi);
 386 SR_PRIV int sigma_set_acquire_timeout(struct dev_context *devc);
 387 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
 388 SR_PRIV int sigma_build_basic_trigger(struct dev_context *devc,
 389         struct triggerlut *lut);
 390
 391 /* Callback to periodically drive acuisition progress. */
 392 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
 393
 394 #endif