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