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 /*
  34  * Triggers are not working in this implementation. Stop claiming
  35  * support for the feature which effectively is not available, until
  36  * the implementation got fixed. Yet keep the code in place and allow
  37  * developers to turn on this switch during development.
  38  */
  39 #define ASIX_SIGMA_WITH_TRIGGER 0
  40
  41 #define LOG_PREFIX "asix-sigma"
  42
  43 #define USB_VENDOR                      0xa600
  44 #define USB_PRODUCT                     0xa000
  45 #define USB_DESCRIPTION                 "ASIX SIGMA"
  46 #define USB_VENDOR_NAME                 "ASIX"
  47 #define USB_MODEL_NAME                  "SIGMA"
  48
  49 enum sigma_write_register {
  50         WRITE_CLOCK_SELECT      = 0,
  51         WRITE_TRIGGER_SELECT0   = 1,
  52         WRITE_TRIGGER_SELECT1   = 2,
  53         WRITE_MODE              = 3,
  54         WRITE_MEMROW            = 4,
  55         WRITE_POST_TRIGGER      = 5,
  56         WRITE_TRIGGER_OPTION    = 6,
  57         WRITE_PIN_VIEW          = 7,
  58
  59         WRITE_TEST              = 15,
  60 };
  61
  62 enum sigma_read_register {
  63         READ_ID                 = 0,
  64         READ_TRIGGER_POS_LOW    = 1,
  65         READ_TRIGGER_POS_HIGH   = 2,
  66         READ_TRIGGER_POS_UP     = 3,
  67         READ_STOP_POS_LOW       = 4,
  68         READ_STOP_POS_HIGH      = 5,
  69         READ_STOP_POS_UP        = 6,
  70         READ_MODE               = 7,
  71         READ_PIN_CHANGE_LOW     = 8,
  72         READ_PIN_CHANGE_HIGH    = 9,
  73         READ_BLOCK_LAST_TS_LOW  = 10,
  74         READ_BLOCK_LAST_TS_HIGH = 11,
  75         READ_PIN_VIEW           = 12,
  76
  77         READ_TEST               = 15,
  78 };
  79
  80 #define REG_ADDR_LOW            (0x0 << 4)
  81 #define REG_ADDR_HIGH           (0x1 << 4)
  82 #define REG_DATA_LOW            (0x2 << 4)
  83 #define REG_DATA_HIGH_WRITE     (0x3 << 4)
  84 #define REG_READ_ADDR           (0x4 << 4)
  85 #define REG_DRAM_WAIT_ACK       (0x5 << 4)
  86
  87 /* Bit (1 << 4) can be low or high (double buffer / cache) */
  88 #define REG_DRAM_BLOCK          (0x6 << 4)
  89 #define REG_DRAM_BLOCK_BEGIN    (0x8 << 4)
  90 #define REG_DRAM_BLOCK_DATA     (0xa << 4)
  91
  92 #define LEDSEL0                 6
  93 #define LEDSEL1                 7
  94
  95 #define NEXT_REG                1
  96
  97 #define EVENTS_PER_CLUSTER      7
  98
  99 #define CHUNK_SIZE              1024
 100
 101 /*
 102  * The entire ASIX Sigma DRAM is an array of struct sigma_dram_line[1024];
 103  */
 104
 105 /* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
 106 struct sigma_dram_cluster {
 107         uint8_t         timestamp_lo;
 108         uint8_t         timestamp_hi;
 109         struct {
 110                 uint8_t sample_hi;
 111                 uint8_t sample_lo;
 112         }               samples[7];
 113 };
 114
 115 /* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
 116 struct sigma_dram_line {
 117         struct sigma_dram_cluster       cluster[64];
 118 };
 119
 120 struct clockselect_50 {
 121         uint8_t async;
 122         uint8_t fraction;
 123         uint16_t disabled_channels;
 124 };
 125
 126 /* The effect of all these are still a bit unclear. */
 127 struct triggerinout {
 128         uint8_t trgout_resistor_enable : 1;
 129         uint8_t trgout_resistor_pullup : 1;
 130         uint8_t reserved1 : 1;
 131         uint8_t trgout_bytrigger : 1;
 132         uint8_t trgout_byevent : 1;
 133         uint8_t trgout_bytriggerin : 1;
 134         uint8_t reserved2 : 2;
 135
 136         /* Should be set same as the first two */
 137         uint8_t trgout_resistor_enable2 : 1;
 138         uint8_t trgout_resistor_pullup2 : 1;
 139
 140         uint8_t reserved3 : 1;
 141         uint8_t trgout_long : 1;
 142         uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
 143         uint8_t trgin_negate : 1;
 144         uint8_t trgout_enable : 1;
 145         uint8_t trgin_enable : 1;
 146 };
 147
 148 struct triggerlut {
 149         /* The actual LUTs. */
 150         uint16_t m0d[4], m1d[4], m2d[4];
 151         uint16_t m3, m3s, m4;
 152
 153         /* Parameters should be sent as a single register write. */
 154         struct {
 155                 uint8_t selc : 2;
 156                 uint8_t selpresc : 6;
 157
 158                 uint8_t selinc : 2;
 159                 uint8_t selres : 2;
 160                 uint8_t sela : 2;
 161                 uint8_t selb : 2;
 162
 163                 uint16_t cmpb;
 164                 uint16_t cmpa;
 165         } params;
 166 };
 167
 168 /* Trigger configuration */
 169 struct sigma_trigger {
 170         /* Only two channels can be used in mask. */
 171         uint16_t risingmask;
 172         uint16_t fallingmask;
 173
 174         /* Simple trigger support (<= 50 MHz). */
 175         uint16_t simplemask;
 176         uint16_t simplevalue;
 177
 178         /* TODO: Advanced trigger support (boolean expressions). */
 179 };
 180
 181 /* Events for trigger operation. */
 182 enum triggerop {
 183         OP_LEVEL = 1,
 184         OP_NOT,
 185         OP_RISE,
 186         OP_FALL,
 187         OP_RISEFALL,
 188         OP_NOTRISE,
 189         OP_NOTFALL,
 190         OP_NOTRISEFALL,
 191 };
 192
 193 /* Logical functions for trigger operation. */
 194 enum triggerfunc {
 195         FUNC_AND = 1,
 196         FUNC_NAND,
 197         FUNC_OR,
 198         FUNC_NOR,
 199         FUNC_XOR,
 200         FUNC_NXOR,
 201 };
 202
 203 struct sigma_state {
 204         enum {
 205                 SIGMA_UNINITIALIZED = 0,
 206                 SIGMA_IDLE,
 207                 SIGMA_CAPTURE,
 208                 SIGMA_DOWNLOAD,
 209         } state;
 210
 211         uint16_t lastts;
 212         uint16_t lastsample;
 213 };
 214
 215 /* Private, per-device-instance driver context. */
 216 struct dev_context {
 217         struct ftdi_context ftdic;
 218         uint64_t cur_samplerate;
 219         uint64_t period_ps;
 220         uint64_t limit_msec;
 221         uint64_t limit_samples;
 222         struct timeval start_tv;
 223         int cur_firmware;
 224         int num_channels;
 225         int cur_channels;
 226         int samples_per_event;
 227         int capture_ratio;
 228         struct sigma_trigger trigger;
 229         int use_triggers;
 230         struct sigma_state state;
 231 };
 232
 233 extern SR_PRIV const uint64_t samplerates[];
 234 extern SR_PRIV const size_t samplerates_count;
 235
 236 SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
 237                                  struct dev_context *devc);
 238 SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc);
 239 SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc);
 240 SR_PRIV void sigma_clear_helper(void *priv);
 241 SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
 242                                              uint64_t limit_samples);
 243 SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
 244 SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
 245 SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
 246 SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc);
 247
 248 #endif