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  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #ifndef LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H
  23 #define LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H
  24
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <glib.h>
  28 #include <ftdi.h>
  29 #include <string.h>
  30 #include <libsigrok/libsigrok.h>
  31 #include "libsigrok-internal.h"
  32
  33 #define LOG_PREFIX "asix-sigma"
  34
  35 /*
  36  * Triggers are not working in this implementation. Stop claiming
  37  * support for the feature which effectively is not available, until
  38  * the implementation got fixed. Yet keep the code in place and allow
  39  * developers to turn on this switch during development.
  40  */
  41 #define ASIX_SIGMA_WITH_TRIGGER 0
  42
  43 /* Experimental support for OMEGA (scan only, operation is ENOIMPL). */
  44 #define ASIX_WITH_OMEGA 0
  45
  46 #define USB_VENDOR_ASIX                 0xa600
  47 #define USB_PRODUCT_SIGMA               0xa000
  48 #define USB_PRODUCT_OMEGA               0xa004
  49
  50 enum asix_device_type {
  51         ASIX_TYPE_NONE,
  52         ASIX_TYPE_SIGMA,
  53         ASIX_TYPE_OMEGA,
  54 };
  55
  56 enum sigma_write_register {
  57         WRITE_CLOCK_SELECT      = 0,
  58         WRITE_TRIGGER_SELECT    = 1,
  59         WRITE_TRIGGER_SELECT2   = 2,
  60         WRITE_MODE              = 3,
  61         WRITE_MEMROW            = 4,
  62         WRITE_POST_TRIGGER      = 5,
  63         WRITE_TRIGGER_OPTION    = 6,
  64         WRITE_PIN_VIEW          = 7,
  65         /* Unassigned register locations. */
  66         WRITE_TEST              = 15,
  67 };
  68
  69 enum sigma_read_register {
  70         READ_ID                 = 0,
  71         READ_TRIGGER_POS_LOW    = 1,
  72         READ_TRIGGER_POS_HIGH   = 2,
  73         READ_TRIGGER_POS_UP     = 3,
  74         READ_STOP_POS_LOW       = 4,
  75         READ_STOP_POS_HIGH      = 5,
  76         READ_STOP_POS_UP        = 6,
  77         READ_MODE               = 7,
  78         READ_PIN_CHANGE_LOW     = 8,
  79         READ_PIN_CHANGE_HIGH    = 9,
  80         READ_BLOCK_LAST_TS_LOW  = 10,
  81         READ_BLOCK_LAST_TS_HIGH = 11,
  82         READ_BLOCK_TS_OVERRUN   = 12,
  83         READ_PIN_VIEW           = 13,
  84         /* Unassigned register location. */
  85         READ_TEST               = 15,
  86 };
  87
  88 #define REG_ADDR_LOW            (0x0 << 4)
  89 #define REG_ADDR_HIGH           (0x1 << 4)
  90 #define REG_DATA_LOW            (0x2 << 4)
  91 #define REG_DATA_HIGH_WRITE     (0x3 << 4)
  92 #define REG_READ_ADDR           (0x4 << 4)
  93 #define REG_DRAM_WAIT_ACK       (0x5 << 4)
  94
  95 /* Bit (1 << 4) can be low or high (double buffer / cache) */
  96 #define REG_DRAM_BLOCK          (0x6 << 4)
  97 #define REG_DRAM_BLOCK_BEGIN    (0x8 << 4)
  98 #define REG_DRAM_BLOCK_DATA     (0xa << 4)
  99
 100 #define LEDSEL0                 6
 101 #define LEDSEL1                 7
 102
 103 #define NEXT_REG                1
 104
 105 #define EVENTS_PER_CLUSTER      7
 106
 107 #define CHUNK_SIZE              1024
 108
 109 /* WRITE_MODE register fields. */
 110 #define WMR_SDRAMWRITEEN        (1 << 0)
 111 #define WMR_SDRAMREADEN         (1 << 1)
 112 #define WMR_TRGRES              (1 << 2)
 113 #define WMR_TRGEN               (1 << 3)
 114 #define WMR_FORCESTOP           (1 << 4)
 115 #define WMR_TRGSW               (1 << 5)
 116 /* not used: bit position 6 */
 117 #define WMR_SDRAMINIT           (1 << 7)
 118
 119 /* READ_MODE register fields. */
 120 #define RMR_SDRAMWRITEEN        (1 << 0)
 121 #define RMR_SDRAMREADEN         (1 << 1)
 122 /* not used: bit position 2 */
 123 #define RMR_TRGEN               (1 << 3)
 124 #define RMR_ROUND               (1 << 4)
 125 #define RMR_TRIGGERED           (1 << 5)
 126 #define RMR_POSTTRIGGERED       (1 << 6)
 127 /* not used: bit position 7 */
 128
 129 /*
 130  * Layout of the sample data DRAM, which will be downloaded to the PC:
 131  *
 132  * Sigma memory is organized in 32K rows. Each row contains 64 clusters.
 133  * Each cluster contains a timestamp (16bit) and 7 samples (16bits each).
 134  * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MB (256 Mbit).
 135  *
 136  * Sample data is represented in 16bit quantities. The first sample in
 137  * the cluster corresponds to the cluster's timestamp. Each next sample
 138  * corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
 139  * one sample period, according to the samplerate). In the absence of
 140  * pin level changes, no data is provided (RLE compression). A cluster
 141  * is enforced for each 64K ticks of the timestamp, to reliably handle
 142  * rollover and determination of the next timestamp of the next cluster.
 143  *
 144  * For samplerates of 100MHz, there is one 16 bit entity for each 20ns
 145  * period (50MHz rate). The 16 bit memory contains 2 samples of up to
 146  * 8 channels. Bits of multiple samples are interleaved. For samplerates
 147  * of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
 148  * each 5ns apart.
 149  *
 150  * Memory addresses (sample count, trigger position) are kept in 24bit
 151  * entities. The upper 15 bit refer to the "row", the lower 9 bit refer
 152  * to the "event" within the row. Because there is one timestamp for
 153  * seven samples each, one memory row can hold up to 64x7 == 448 samples.
 154  */
 155
 156 /* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
 157 struct sigma_dram_cluster {
 158         uint8_t         timestamp_lo;
 159         uint8_t         timestamp_hi;
 160         struct {
 161                 uint8_t sample_hi;
 162                 uint8_t sample_lo;
 163         }               samples[7];
 164 };
 165
 166 /* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
 167 struct sigma_dram_line {
 168         struct sigma_dram_cluster       cluster[64];
 169 };
 170
 171 struct clockselect_50 {
 172         uint8_t async;
 173         uint8_t fraction;
 174         uint16_t disabled_channels;
 175 };
 176
 177 /* The effect of all these are still a bit unclear. */
 178 struct triggerinout {
 179         uint8_t trgout_resistor_enable : 1;
 180         uint8_t trgout_resistor_pullup : 1;
 181         uint8_t reserved1 : 1;
 182         uint8_t trgout_bytrigger : 1;
 183         uint8_t trgout_byevent : 1;
 184         uint8_t trgout_bytriggerin : 1;
 185         uint8_t reserved2 : 2;
 186
 187         /* Should be set same as the first two */
 188         uint8_t trgout_resistor_enable2 : 1;
 189         uint8_t trgout_resistor_pullup2 : 1;
 190
 191         uint8_t reserved3 : 1;
 192         uint8_t trgout_long : 1;
 193         uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
 194         uint8_t trgin_negate : 1;
 195         uint8_t trgout_enable : 1;
 196         uint8_t trgin_enable : 1;
 197 };
 198
 199 struct triggerlut {
 200         /* The actual LUTs. */
 201         uint16_t m0d[4], m1d[4], m2d[4];
 202         uint16_t m3, m3s, m4;
 203
 204         /* Parameters should be sent as a single register write. */
 205         struct {
 206                 uint8_t selc : 2;
 207                 uint8_t selpresc : 6;
 208
 209                 uint8_t selinc : 2;
 210                 uint8_t selres : 2;
 211                 uint8_t sela : 2;
 212                 uint8_t selb : 2;
 213
 214                 uint16_t cmpb;
 215                 uint16_t cmpa;
 216         } params;
 217 };
 218
 219 /* Trigger configuration */
 220 struct sigma_trigger {
 221         /* Only two channels can be used in mask. */
 222         uint16_t risingmask;
 223         uint16_t fallingmask;
 224
 225         /* Simple trigger support (<= 50 MHz). */
 226         uint16_t simplemask;
 227         uint16_t simplevalue;
 228
 229         /* TODO: Advanced trigger support (boolean expressions). */
 230 };
 231
 232 /* Events for trigger operation. */
 233 enum triggerop {
 234         OP_LEVEL = 1,
 235         OP_NOT,
 236         OP_RISE,
 237         OP_FALL,
 238         OP_RISEFALL,
 239         OP_NOTRISE,
 240         OP_NOTFALL,
 241         OP_NOTRISEFALL,
 242 };
 243
 244 /* Logical functions for trigger operation. */
 245 enum triggerfunc {
 246         FUNC_AND = 1,
 247         FUNC_NAND,
 248         FUNC_OR,
 249         FUNC_NOR,
 250         FUNC_XOR,
 251         FUNC_NXOR,
 252 };
 253
 254 struct sigma_state {
 255         enum {
 256                 SIGMA_UNINITIALIZED = 0,
 257                 SIGMA_IDLE,
 258                 SIGMA_CAPTURE,
 259                 SIGMA_STOPPING,
 260                 SIGMA_DOWNLOAD,
 261         } state;
 262         uint16_t lastts;
 263         uint16_t lastsample;
 264 };
 265
 266 struct dev_context {
 267         struct {
 268                 uint16_t vid, pid;
 269                 uint32_t serno;
 270                 uint16_t prefix;
 271                 enum asix_device_type type;
 272         } id;
 273         struct ftdi_context ftdic;
 274         uint64_t cur_samplerate;
 275         uint64_t limit_msec;
 276         uint64_t limit_samples;
 277         uint64_t sent_samples;
 278         uint64_t start_time;
 279         int cur_firmware;
 280         int num_channels;
 281         int cur_channels;
 282         int samples_per_event;
 283         uint64_t capture_ratio;
 284         struct sigma_trigger trigger;
 285         int use_triggers;
 286         struct sigma_state state;
 287 };
 288
 289 extern SR_PRIV const uint64_t samplerates[];
 290 extern SR_PRIV const size_t samplerates_count;
 291
 292 SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
 293                                  struct dev_context *devc);
 294 SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc);
 295 SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc);
 296 SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
 297                                              uint64_t limit_samples);
 298 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
 299 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
 300 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
 301 SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc);
 302
 303 #endif