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_SELECT0   = 1,
  59         WRITE_TRIGGER_SELECT1   = 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
  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_PIN_VIEW           = 12,
  83
  84         READ_TEST               = 15,
  85 };
  86
  87 #define REG_ADDR_LOW            (0x0 << 4)
  88 #define REG_ADDR_HIGH           (0x1 << 4)
  89 #define REG_DATA_LOW            (0x2 << 4)
  90 #define REG_DATA_HIGH_WRITE     (0x3 << 4)
  91 #define REG_READ_ADDR           (0x4 << 4)
  92 #define REG_DRAM_WAIT_ACK       (0x5 << 4)
  93
  94 /* Bit (1 << 4) can be low or high (double buffer / cache) */
  95 #define REG_DRAM_BLOCK          (0x6 << 4)
  96 #define REG_DRAM_BLOCK_BEGIN    (0x8 << 4)
  97 #define REG_DRAM_BLOCK_DATA     (0xa << 4)
  98
  99 #define LEDSEL0                 6
 100 #define LEDSEL1                 7
 101
 102 #define NEXT_REG                1
 103
 104 #define EVENTS_PER_CLUSTER      7
 105
 106 #define CHUNK_SIZE              1024
 107
 108 /* WRITE_MODE register fields. */
 109 #define WMR_SDRAMWRITEEN        (1 << 0)
 110 #define WMR_SDRAMREADEN         (1 << 1)
 111 #define WMR_TRGRES              (1 << 2)
 112 #define WMR_TRGEN               (1 << 3)
 113 #define WMR_FORCESTOP           (1 << 4)
 114 #define WMR_TRGSW               (1 << 5)
 115 /* not used: bit position 6 */
 116 #define WMR_SDRAMINIT           (1 << 7)
 117
 118 /* READ_MODE register fields. */
 119 #define RMR_SDRAMWRITEEN        (1 << 0)
 120 #define RMR_SDRAMREADEN         (1 << 1)
 121 /* not used: bit position 2 */
 122 #define RMR_TRGEN               (1 << 3)
 123 #define RMR_ROUND               (1 << 4)
 124 #define RMR_TRIGGERED           (1 << 5)
 125 #define RMR_POSTTRIGGERED       (1 << 6)
 126 /* not used: bit position 7 */
 127
 128 /*
 129  * Layout of the sample data DRAM, which will be downloaded to the PC:
 130  *
 131  * Sigma memory is organized in 32K rows. Each row contains 64 clusters.
 132  * Each cluster contains a timestamp (16bit) and 7 samples (16bits each).
 133  * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MB (256 Mbit).
 134  *
 135  * Sample data is represented in 16bit quantities. The first sample in
 136  * the cluster corresponds to the cluster's timestamp. Each next sample
 137  * corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
 138  * one sample period, according to the samplerate). In the absence of
 139  * pin level changes, no data is provided (RLE compression). A cluster
 140  * is enforced for each 64K ticks of the timestamp, to reliably handle
 141  * rollover and determination of the next timestamp of the next cluster.
 142  *
 143  * For samplerates of 100MHz, there is one 16 bit entity for each 20ns
 144  * period (50MHz rate). The 16 bit memory contains 2 samples of up to
 145  * 8 channels. Bits of multiple samples are interleaved. For samplerates
 146  * of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
 147  * each 5ns apart.
 148  *
 149  * Memory addresses (sample count, trigger position) are kept in 24bit
 150  * entities. The upper 15 bit refer to the "row", the lower 9 bit refer
 151  * to the "event" within the row. Because there is one timestamp for
 152  * seven samples each, one memory row can hold up to 64x7 == 448 samples.
 153  */
 154
 155 /* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
 156 struct sigma_dram_cluster {
 157         uint8_t         timestamp_lo;
 158         uint8_t         timestamp_hi;
 159         struct {
 160                 uint8_t sample_hi;
 161                 uint8_t sample_lo;
 162         }               samples[7];
 163 };
 164
 165 /* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
 166 struct sigma_dram_line {
 167         struct sigma_dram_cluster       cluster[64];
 168 };
 169
 170 struct clockselect_50 {
 171         uint8_t async;
 172         uint8_t fraction;
 173         uint16_t disabled_channels;
 174 };
 175
 176 /* The effect of all these are still a bit unclear. */
 177 struct triggerinout {
 178         uint8_t trgout_resistor_enable : 1;
 179         uint8_t trgout_resistor_pullup : 1;
 180         uint8_t reserved1 : 1;
 181         uint8_t trgout_bytrigger : 1;
 182         uint8_t trgout_byevent : 1;
 183         uint8_t trgout_bytriggerin : 1;
 184         uint8_t reserved2 : 2;
 185
 186         /* Should be set same as the first two */
 187         uint8_t trgout_resistor_enable2 : 1;
 188         uint8_t trgout_resistor_pullup2 : 1;
 189
 190         uint8_t reserved3 : 1;
 191         uint8_t trgout_long : 1;
 192         uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
 193         uint8_t trgin_negate : 1;
 194         uint8_t trgout_enable : 1;
 195         uint8_t trgin_enable : 1;
 196 };
 197
 198 struct triggerlut {
 199         /* The actual LUTs. */
 200         uint16_t m0d[4], m1d[4], m2d[4];
 201         uint16_t m3, m3s, m4;
 202
 203         /* Parameters should be sent as a single register write. */
 204         struct {
 205                 uint8_t selc : 2;
 206                 uint8_t selpresc : 6;
 207
 208                 uint8_t selinc : 2;
 209                 uint8_t selres : 2;
 210                 uint8_t sela : 2;
 211                 uint8_t selb : 2;
 212
 213                 uint16_t cmpb;
 214                 uint16_t cmpa;
 215         } params;
 216 };
 217
 218 /* Trigger configuration */
 219 struct sigma_trigger {
 220         /* Only two channels can be used in mask. */
 221         uint16_t risingmask;
 222         uint16_t fallingmask;
 223
 224         /* Simple trigger support (<= 50 MHz). */
 225         uint16_t simplemask;
 226         uint16_t simplevalue;
 227
 228         /* TODO: Advanced trigger support (boolean expressions). */
 229 };
 230
 231 /* Events for trigger operation. */
 232 enum triggerop {
 233         OP_LEVEL = 1,
 234         OP_NOT,
 235         OP_RISE,
 236         OP_FALL,
 237         OP_RISEFALL,
 238         OP_NOTRISE,
 239         OP_NOTFALL,
 240         OP_NOTRISEFALL,
 241 };
 242
 243 /* Logical functions for trigger operation. */
 244 enum triggerfunc {
 245         FUNC_AND = 1,
 246         FUNC_NAND,
 247         FUNC_OR,
 248         FUNC_NOR,
 249         FUNC_XOR,
 250         FUNC_NXOR,
 251 };
 252
 253 struct sigma_state {
 254         enum {
 255                 SIGMA_UNINITIALIZED = 0,
 256                 SIGMA_IDLE,
 257                 SIGMA_CAPTURE,
 258                 SIGMA_STOPPING,
 259                 SIGMA_DOWNLOAD,
 260         } state;
 261         uint16_t lastts;
 262         uint16_t lastsample;
 263 };
 264
 265 struct dev_context {
 266         struct {
 267                 uint16_t vid, pid;
 268                 uint32_t serno;
 269                 uint16_t prefix;
 270                 enum asix_device_type type;
 271         } id;
 272         struct ftdi_context ftdic;
 273         uint64_t cur_samplerate;
 274         uint64_t limit_msec;
 275         uint64_t limit_samples;
 276         uint64_t sent_samples;
 277         uint64_t start_time;
 278         int cur_firmware;
 279         int num_channels;
 280         int cur_channels;
 281         int samples_per_event;
 282         uint64_t capture_ratio;
 283         struct sigma_trigger trigger;
 284         int use_triggers;
 285         struct sigma_state state;
 286 };
 287
 288 extern SR_PRIV const uint64_t samplerates[];
 289 extern SR_PRIV const size_t samplerates_count;
 290
 291 SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
 292                                  struct dev_context *devc);
 293 SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc);
 294 SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc);
 295 SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
 296                                              uint64_t limit_samples);
 297 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
 298 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
 299 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
 300 SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc);
 301
 302 #endif