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