]> sigrok.org Git - libsigrok.git/blame - src/hardware/asix-sigma/protocol.h
asix-sigma: move FPGA commands before register layout declaration
[libsigrok.git] / src / hardware / asix-sigma / protocol.h
CommitLineData
204b1629 1/*
50985c20 2 * This file is part of the libsigrok project.
204b1629 3 *
3ba56876 4 * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
204b1629
UH
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
3ba56876 22#ifndef LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H
23#define LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H
24
25#include <stdint.h>
4154a516 26#include <stdlib.h>
3ba56876 27#include <glib.h>
28#include <ftdi.h>
29#include <string.h>
30#include <libsigrok/libsigrok.h>
31#include "libsigrok-internal.h"
28a35d8a 32
f272d7dd
UH
33#define LOG_PREFIX "asix-sigma"
34
de3f7acb
GS
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
53a939ab
GS
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
50enum asix_device_type {
51 ASIX_TYPE_NONE,
52 ASIX_TYPE_SIGMA,
53 ASIX_TYPE_OMEGA,
54};
3ba56876 55
7c41c420
GS
56/*
57 * FPGA commands are 8bits wide. The upper nibble is a command opcode,
58 * the lower nibble can carry operand values. 8bit register addresses
59 * and 8bit data values get communicated in two steps.
60 */
61
62/* Register access. */
63#define REG_ADDR_LOW (0x0 << 4)
64#define REG_ADDR_HIGH (0x1 << 4)
65#define REG_DATA_LOW (0x2 << 4)
66#define REG_DATA_HIGH_WRITE (0x3 << 4)
67#define REG_READ_ADDR (0x4 << 4)
68#define REG_ADDR_ADJUST (1 << 0) /* Auto adjust register address. */
69#define REG_ADDR_DOWN (1 << 1) /* 1 decrement, 0 increment. */
70#define REG_ADDR_INC (REG_ADDR_ADJUST)
71#define REG_ADDR_DEC (REG_ADDR_ADJUST | REG_ADDR_DOWN)
72
73/* Sample memory access. */
74#define REG_DRAM_WAIT_ACK (0x5 << 4) /* Wait for completion. */
75#define REG_DRAM_BLOCK (0x6 << 4) /* DRAM to BRAM, plus bank select. */
76#define REG_DRAM_BLOCK_BEGIN (0x8 << 4) /* Read first BRAM bytes. */
77#define REG_DRAM_BLOCK_DATA (0xa << 4) /* Read full BRAM block. */
78#define REG_DRAM_SEL_N (0x1 << 4) /* Bank select, added to 6/8/a. */
79#define REG_DRAM_SEL_BOOL(b) ((b) ? REG_DRAM_SEL_N : 0)
80
81/*
82 * Registers at a specific address can have different meanings depending
83 * on whether data is read or written. This is why direction is part of
84 * the programming language identifiers.
85 *
86 * The vendor documentation suggests that in addition to the first 16
87 * register addresses which implement the logic analyzer's feature set,
88 * there are 240 more registers in the 16 to 255 address range which
89 * are available to applications and plugin features. Can libsigrok's
90 * asix-sigma driver store configuration data there, to avoid expensive
91 * operations (think: firmware re-load).
92 */
93
fefa1800 94enum sigma_write_register {
28a35d8a 95 WRITE_CLOCK_SELECT = 0,
9fb4c632
GS
96 WRITE_TRIGGER_SELECT = 1,
97 WRITE_TRIGGER_SELECT2 = 2,
28a35d8a
HE
98 WRITE_MODE = 3,
99 WRITE_MEMROW = 4,
100 WRITE_POST_TRIGGER = 5,
101 WRITE_TRIGGER_OPTION = 6,
102 WRITE_PIN_VIEW = 7,
9fb4c632 103 /* Unassigned register locations. */
fefa1800 104 WRITE_TEST = 15,
28a35d8a
HE
105};
106
fefa1800 107enum sigma_read_register {
28a35d8a
HE
108 READ_ID = 0,
109 READ_TRIGGER_POS_LOW = 1,
110 READ_TRIGGER_POS_HIGH = 2,
111 READ_TRIGGER_POS_UP = 3,
112 READ_STOP_POS_LOW = 4,
113 READ_STOP_POS_HIGH = 5,
114 READ_STOP_POS_UP = 6,
115 READ_MODE = 7,
116 READ_PIN_CHANGE_LOW = 8,
117 READ_PIN_CHANGE_HIGH = 9,
118 READ_BLOCK_LAST_TS_LOW = 10,
119 READ_BLOCK_LAST_TS_HIGH = 11,
9fb4c632
GS
120 READ_BLOCK_TS_OVERRUN = 12,
121 READ_PIN_VIEW = 13,
122 /* Unassigned register location. */
fefa1800 123 READ_TEST = 15,
28a35d8a
HE
124};
125
57bbf56b
HE
126#define LEDSEL0 6
127#define LEDSEL1 7
128
28a35d8a
HE
129
130#define EVENTS_PER_CLUSTER 7
131
132#define CHUNK_SIZE 1024
133
22f64ed8
GS
134/* WRITE_MODE register fields. */
135#define WMR_SDRAMWRITEEN (1 << 0)
136#define WMR_SDRAMREADEN (1 << 1)
137#define WMR_TRGRES (1 << 2)
138#define WMR_TRGEN (1 << 3)
139#define WMR_FORCESTOP (1 << 4)
140#define WMR_TRGSW (1 << 5)
141/* not used: bit position 6 */
142#define WMR_SDRAMINIT (1 << 7)
143
144/* READ_MODE register fields. */
145#define RMR_SDRAMWRITEEN (1 << 0)
146#define RMR_SDRAMREADEN (1 << 1)
147/* not used: bit position 2 */
148#define RMR_TRGEN (1 << 3)
149#define RMR_ROUND (1 << 4)
150#define RMR_TRIGGERED (1 << 5)
151#define RMR_POSTTRIGGERED (1 << 6)
152/* not used: bit position 7 */
153
fd830beb 154/*
5b1d15ef
GS
155 * Layout of the sample data DRAM, which will be downloaded to the PC:
156 *
157 * Sigma memory is organized in 32K rows. Each row contains 64 clusters.
158 * Each cluster contains a timestamp (16bit) and 7 samples (16bits each).
159 * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MB (256 Mbit).
160 *
161 * Sample data is represented in 16bit quantities. The first sample in
162 * the cluster corresponds to the cluster's timestamp. Each next sample
163 * corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
164 * one sample period, according to the samplerate). In the absence of
165 * pin level changes, no data is provided (RLE compression). A cluster
166 * is enforced for each 64K ticks of the timestamp, to reliably handle
167 * rollover and determination of the next timestamp of the next cluster.
168 *
169 * For samplerates of 100MHz, there is one 16 bit entity for each 20ns
170 * period (50MHz rate). The 16 bit memory contains 2 samples of up to
171 * 8 channels. Bits of multiple samples are interleaved. For samplerates
172 * of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
173 * each 5ns apart.
174 *
175 * Memory addresses (sample count, trigger position) are kept in 24bit
176 * entities. The upper 15 bit refer to the "row", the lower 9 bit refer
177 * to the "event" within the row. Because there is one timestamp for
178 * seven samples each, one memory row can hold up to 64x7 == 448 samples.
fd830beb
MV
179 */
180
181/* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
182struct sigma_dram_cluster {
183 uint8_t timestamp_lo;
184 uint8_t timestamp_hi;
185 struct {
186 uint8_t sample_hi;
187 uint8_t sample_lo;
188 } samples[7];
189};
190
191/* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
192struct sigma_dram_line {
193 struct sigma_dram_cluster cluster[64];
194};
195
edca2c5c
HE
196struct clockselect_50 {
197 uint8_t async;
198 uint8_t fraction;
ba7dd8bb 199 uint16_t disabled_channels;
edca2c5c
HE
200};
201
57bbf56b
HE
202/* The effect of all these are still a bit unclear. */
203struct triggerinout {
204 uint8_t trgout_resistor_enable : 1;
205 uint8_t trgout_resistor_pullup : 1;
206 uint8_t reserved1 : 1;
207 uint8_t trgout_bytrigger : 1;
208 uint8_t trgout_byevent : 1;
209 uint8_t trgout_bytriggerin : 1;
210 uint8_t reserved2 : 2;
211
212 /* Should be set same as the first two */
213 uint8_t trgout_resistor_enable2 : 1;
214 uint8_t trgout_resistor_pullup2 : 1;
215
216 uint8_t reserved3 : 1;
217 uint8_t trgout_long : 1;
218 uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
219 uint8_t trgin_negate : 1;
220 uint8_t trgout_enable : 1;
221 uint8_t trgin_enable : 1;
222};
223
ee492173
HE
224struct triggerlut {
225 /* The actual LUTs. */
226 uint16_t m0d[4], m1d[4], m2d[4];
227 uint16_t m3, m3s, m4;
228
f3f19d11 229 /* Parameters should be sent as a single register write. */
ee492173
HE
230 struct {
231 uint8_t selc : 2;
232 uint8_t selpresc : 6;
233
234 uint8_t selinc : 2;
235 uint8_t selres : 2;
236 uint8_t sela : 2;
237 uint8_t selb : 2;
238
239 uint16_t cmpb;
240 uint16_t cmpa;
241 } params;
242};
243
c53d793f
HE
244/* Trigger configuration */
245struct sigma_trigger {
ba7dd8bb 246 /* Only two channels can be used in mask. */
a42aec7f
HE
247 uint16_t risingmask;
248 uint16_t fallingmask;
c53d793f
HE
249
250 /* Simple trigger support (<= 50 MHz). */
251 uint16_t simplemask;
252 uint16_t simplevalue;
253
c53d793f
HE
254 /* TODO: Advanced trigger support (boolean expressions). */
255};
256
257/* Events for trigger operation. */
258enum triggerop {
259 OP_LEVEL = 1,
260 OP_NOT,
261 OP_RISE,
262 OP_FALL,
263 OP_RISEFALL,
264 OP_NOTRISE,
265 OP_NOTFALL,
266 OP_NOTRISEFALL,
267};
268
269/* Logical functions for trigger operation. */
270enum triggerfunc {
271 FUNC_AND = 1,
272 FUNC_NAND,
273 FUNC_OR,
274 FUNC_NOR,
275 FUNC_XOR,
276 FUNC_NXOR,
277};
278
6aac7737
HE
279struct sigma_state {
280 enum {
281 SIGMA_UNINITIALIZED = 0,
282 SIGMA_IDLE,
283 SIGMA_CAPTURE,
dde0175d 284 SIGMA_STOPPING,
6aac7737
HE
285 SIGMA_DOWNLOAD,
286 } state;
6aac7737
HE
287 uint16_t lastts;
288 uint16_t lastsample;
6aac7737
HE
289};
290
0e1357e8 291struct dev_context {
53a939ab
GS
292 struct {
293 uint16_t vid, pid;
294 uint32_t serno;
295 uint16_t prefix;
296 enum asix_device_type type;
297 } id;
99965709
HE
298 struct ftdi_context ftdic;
299 uint64_t cur_samplerate;
94ba4bd6 300 uint64_t limit_msec;
2f7e529c 301 uint64_t limit_samples;
735ed8a1 302 uint64_t sent_samples;
2f425a56 303 uint64_t start_time;
99965709 304 int cur_firmware;
ba7dd8bb 305 int num_channels;
5fc01191 306 int cur_channels;
99965709 307 int samples_per_event;
efad7ccc 308 uint64_t capture_ratio;
99965709 309 struct sigma_trigger trigger;
5b5ea7c6 310 int use_triggers;
99965709 311 struct sigma_state state;
99965709
HE
312};
313
3ba56876 314extern SR_PRIV const uint64_t samplerates[];
4154a516 315extern SR_PRIV const size_t samplerates_count;
3ba56876 316
176d785d 317SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
3ba56876 318 struct dev_context *devc);
319SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc);
320SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc);
9a0a606a
GS
321SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
322 uint64_t limit_samples);
3ba56876 323SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
324SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
325SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
326SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc);
327
204b1629 328#endif