]>
Commit | Line | Data |
---|---|---|
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> | |
9334ed6c | 7 | * Copyright (C) 2020 Gerhard Sittig <gerhard.sittig@gmx.net> |
204b1629 UH |
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 | ||
3ba56876 | 23 | #ifndef LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H |
24 | #define LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H | |
25 | ||
26 | #include <stdint.h> | |
4154a516 | 27 | #include <stdlib.h> |
3ba56876 | 28 | #include <glib.h> |
29 | #include <ftdi.h> | |
30 | #include <string.h> | |
31 | #include <libsigrok/libsigrok.h> | |
32 | #include "libsigrok-internal.h" | |
28a35d8a | 33 | |
f272d7dd UH |
34 | #define LOG_PREFIX "asix-sigma" |
35 | ||
de3f7acb GS |
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 | */ | |
8a57728d | 42 | #define ASIX_SIGMA_WITH_TRIGGER 1 |
de3f7acb | 43 | |
53a939ab GS |
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 | }; | |
3ba56876 | 56 | |
7c41c420 GS |
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). | |
53c8a99c GS |
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? | |
7c41c420 GS |
99 | */ |
100 | ||
fefa1800 | 101 | enum sigma_write_register { |
28a35d8a | 102 | WRITE_CLOCK_SELECT = 0, |
9fb4c632 GS |
103 | WRITE_TRIGGER_SELECT = 1, |
104 | WRITE_TRIGGER_SELECT2 = 2, | |
28a35d8a HE |
105 | WRITE_MODE = 3, |
106 | WRITE_MEMROW = 4, | |
107 | WRITE_POST_TRIGGER = 5, | |
108 | WRITE_TRIGGER_OPTION = 6, | |
109 | WRITE_PIN_VIEW = 7, | |
9fb4c632 | 110 | /* Unassigned register locations. */ |
fefa1800 | 111 | WRITE_TEST = 15, |
53c8a99c GS |
112 | /* Reserved for plugin features. */ |
113 | REG_PLUGIN_START = 16, | |
114 | REG_PLUGIN_STOP = 256, | |
28a35d8a HE |
115 | }; |
116 | ||
fefa1800 | 117 | enum sigma_read_register { |
28a35d8a HE |
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, | |
9fb4c632 GS |
130 | READ_BLOCK_TS_OVERRUN = 12, |
131 | READ_PIN_VIEW = 13, | |
132 | /* Unassigned register location. */ | |
fefa1800 | 133 | READ_TEST = 15, |
53c8a99c | 134 | /* Reserved for plugin features. See above. */ |
28a35d8a HE |
135 | }; |
136 | ||
0f017b7d GS |
137 | #define HI4(b) (((b) >> 4) & 0x0f) |
138 | #define LO4(b) (((b) >> 0) & 0x0f) | |
139 | ||
140 | #define BIT_MASK(l) ((1UL << (l)) - 1) | |
141 | ||
2d8a5089 GS |
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 | ||
0f017b7d GS |
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 | |
16791da9 GS |
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 | }; | |
0f017b7d | 167 | |
8bd4dc87 | 168 | #define TRGSEL2_PINS_MASK BIT_MASK(3) |
419f1095 | 169 | #define TRGSEL2_PINPOL_RISE (1 << 3) |
8bd4dc87 | 170 | #define TRGSEL2_LUT_ADDR_MASK BIT_MASK(4) |
419f1095 GS |
171 | #define TRGSEL2_LUT_WRITE (1 << 4) |
172 | #define TRGSEL2_RESET (1 << 5) | |
a53b8e4d GS |
173 | #define TRGSEL2_LEDSEL0 (1 << 6) |
174 | #define TRGSEL2_LEDSEL1 (1 << 7) | |
57bbf56b | 175 | |
22f64ed8 GS |
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 | ||
a53b8e4d GS |
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 | ||
fd830beb | 212 | /* |
5b1d15ef GS |
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. | |
2c33b092 GS |
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. | |
5b1d15ef GS |
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 | |
2c33b092 | 233 | * rollover and determine the next timestamp of the next cluster. |
5b1d15ef | 234 | * |
2c33b092 GS |
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. | |
5b1d15ef GS |
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. | |
fd830beb MV |
242 | */ |
243 | ||
2c33b092 GS |
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) | |
fd830beb | 252 | |
fd830beb | 253 | struct sigma_dram_line { |
2c33b092 | 254 | struct sigma_dram_cluster { |
2a62a9c4 GS |
255 | uint16_t timestamp; |
256 | uint16_t samples[EVENTS_PER_CLUSTER]; | |
2c33b092 | 257 | } cluster[CLUSTERS_PER_ROW]; |
fd830beb MV |
258 | }; |
259 | ||
57bbf56b HE |
260 | /* The effect of all these are still a bit unclear. */ |
261 | struct triggerinout { | |
8bd4dc87 GS |
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; | |
57bbf56b HE |
267 | }; |
268 | ||
ee492173 | 269 | struct triggerlut { |
ee492173 | 270 | uint16_t m0d[4], m1d[4], m2d[4]; |
16791da9 | 271 | uint16_t m3q, m3s, m4; |
ee492173 | 272 | struct { |
8bd4dc87 GS |
273 | uint8_t selpresc; |
274 | uint8_t sela, selb, selc; | |
275 | uint8_t selinc, selres; | |
276 | uint16_t cmpa, cmpb; | |
ee492173 HE |
277 | } params; |
278 | }; | |
279 | ||
c53d793f HE |
280 | /* Trigger configuration */ |
281 | struct sigma_trigger { | |
ba7dd8bb | 282 | /* Only two channels can be used in mask. */ |
a42aec7f HE |
283 | uint16_t risingmask; |
284 | uint16_t fallingmask; | |
c53d793f HE |
285 | |
286 | /* Simple trigger support (<= 50 MHz). */ | |
287 | uint16_t simplemask; | |
288 | uint16_t simplevalue; | |
289 | ||
c53d793f HE |
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 | ||
6aac7737 HE |
315 | struct sigma_state { |
316 | enum { | |
317 | SIGMA_UNINITIALIZED = 0, | |
1bb9dc82 | 318 | SIGMA_CONFIG, |
6aac7737 HE |
319 | SIGMA_IDLE, |
320 | SIGMA_CAPTURE, | |
dde0175d | 321 | SIGMA_STOPPING, |
6aac7737 HE |
322 | SIGMA_DOWNLOAD, |
323 | } state; | |
6aac7737 HE |
324 | uint16_t lastts; |
325 | uint16_t lastsample; | |
6aac7737 HE |
326 | }; |
327 | ||
80e717b3 GS |
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 | ||
2d8a5089 GS |
337 | enum ext_clock_edge_t { |
338 | SIGMA_CLOCK_EDGE_RISING, | |
339 | SIGMA_CLOCK_EDGE_FALLING, | |
340 | SIGMA_CLOCK_EDGE_EITHER, | |
341 | }; | |
342 | ||
98b43eb3 GS |
343 | struct submit_buffer; |
344 | ||
0e1357e8 | 345 | struct dev_context { |
53a939ab GS |
346 | struct { |
347 | uint16_t vid, pid; | |
348 | uint32_t serno; | |
349 | uint16_t prefix; | |
350 | enum asix_device_type type; | |
351 | } id; | |
7fe1f91f GS |
352 | struct { |
353 | struct ftdi_context ctx; | |
354 | gboolean is_open, must_close; | |
355 | } ftdi; | |
2d8a5089 GS |
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; | |
5e78a564 GS |
362 | struct sr_sw_limits cfg_limits; /* Configured limits (user specified). */ |
363 | struct sr_sw_limits acq_limits; /* Acquisition limits (internal use). */ | |
364 | struct sr_sw_limits feed_limits; /* Datafeed limits (internal use). */ | |
80e717b3 | 365 | enum sigma_firmware_idx firmware_idx; |
3d9373af GS |
366 | size_t num_channels; |
367 | size_t samples_per_event; | |
efad7ccc | 368 | uint64_t capture_ratio; |
99965709 | 369 | struct sigma_trigger trigger; |
3d9373af | 370 | gboolean use_triggers; |
99965709 | 371 | struct sigma_state state; |
98b43eb3 | 372 | struct submit_buffer *buffer; |
99965709 HE |
373 | }; |
374 | ||
7fe1f91f GS |
375 | /* "Automatic" and forced USB connection open/close support. */ |
376 | SR_PRIV int sigma_check_open(const struct sr_dev_inst *sdi); | |
377 | SR_PRIV int sigma_check_close(struct dev_context *devc); | |
378 | SR_PRIV int sigma_force_open(const struct sr_dev_inst *sdi); | |
379 | SR_PRIV int sigma_force_close(struct dev_context *devc); | |
380 | ||
53c8a99c GS |
381 | /* Save configuration across sessions, to reduce cost of continuation. */ |
382 | SR_PRIV int sigma_store_hw_config(const struct sr_dev_inst *sdi); | |
383 | SR_PRIV int sigma_fetch_hw_config(const struct sr_dev_inst *sdi); | |
384 | ||
a426f74a | 385 | /* Send register content (simple and complex) to the hardware. */ |
9b4d261f GS |
386 | SR_PRIV int sigma_write_register(struct dev_context *devc, |
387 | uint8_t reg, uint8_t *data, size_t len); | |
388 | SR_PRIV int sigma_set_register(struct dev_context *devc, | |
389 | uint8_t reg, uint8_t value); | |
390 | SR_PRIV int sigma_write_trigger_lut(struct dev_context *devc, | |
391 | struct triggerlut *lut); | |
a426f74a GS |
392 | |
393 | /* Samplerate constraints check, get/set/list helpers. */ | |
5e78a564 | 394 | SR_PRIV int sigma_normalize_samplerate(uint64_t want_rate, uint64_t *have_rate); |
abcd4771 | 395 | SR_PRIV GVariant *sigma_get_samplerates_list(void); |
a426f74a GS |
396 | |
397 | /* Preparation of data acquisition, spec conversion, hardware configuration. */ | |
5e78a564 GS |
398 | SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi); |
399 | SR_PRIV int sigma_set_acquire_timeout(struct dev_context *devc); | |
3ba56876 | 400 | SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi); |
9b4d261f GS |
401 | SR_PRIV int sigma_build_basic_trigger(struct dev_context *devc, |
402 | struct triggerlut *lut); | |
3ba56876 | 403 | |
a426f74a GS |
404 | /* Callback to periodically drive acuisition progress. */ |
405 | SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data); | |
406 | ||
204b1629 | 407 | #endif |