[libsigrok.git] / src / hardware / asix-sigma / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
 * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
 * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
 * Copyright (C) 2020 Gerhard Sittig <gerhard.sittig@gmx.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H
#define LIBSIGROK_HARDWARE_ASIX_SIGMA_PROTOCOL_H

#include <stdint.h>
#include <stdlib.h>
#include <glib.h>
#include <ftdi.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "asix-sigma"

/*
 * Triggers are not working in this implementation. Stop claiming
 * support for the feature which effectively is not available, until
 * the implementation got fixed. Yet keep the code in place and allow
 * developers to turn on this switch during development.
 */
#define ASIX_SIGMA_WITH_TRIGGER	0

/* Experimental support for OMEGA (scan only, operation is ENOIMPL). */
#define ASIX_WITH_OMEGA 0

#define USB_VENDOR_ASIX			0xa600
#define USB_PRODUCT_SIGMA		0xa000
#define USB_PRODUCT_OMEGA		0xa004

enum asix_device_type {
	ASIX_TYPE_NONE,
	ASIX_TYPE_SIGMA,
	ASIX_TYPE_OMEGA,
};

/*
 * FPGA commands are 8bits wide. The upper nibble is a command opcode,
 * the lower nibble can carry operand values. 8bit register addresses
 * and 8bit data values get communicated in two steps.
 */

/* Register access. */
#define REG_ADDR_LOW		(0x0 << 4)
#define REG_ADDR_HIGH		(0x1 << 4)
#define REG_DATA_LOW		(0x2 << 4)
#define REG_DATA_HIGH_WRITE	(0x3 << 4)
#define REG_READ_ADDR		(0x4 << 4)
#define REG_ADDR_ADJUST		(1 << 0) /* Auto adjust register address. */
#define REG_ADDR_DOWN		(1 << 1) /* 1 decrement, 0 increment. */
#define REG_ADDR_INC		(REG_ADDR_ADJUST)
#define REG_ADDR_DEC		(REG_ADDR_ADJUST | REG_ADDR_DOWN)

/* Sample memory access. */
#define REG_DRAM_WAIT_ACK	(0x5 << 4) /* Wait for completion. */
#define REG_DRAM_BLOCK		(0x6 << 4) /* DRAM to BRAM, plus bank select. */
#define REG_DRAM_BLOCK_BEGIN	(0x8 << 4) /* Read first BRAM bytes. */
#define REG_DRAM_BLOCK_DATA	(0xa << 4) /* Read full BRAM block. */
#define REG_DRAM_SEL_N		(0x1 << 4) /* Bank select, added to 6/8/a. */
#define REG_DRAM_SEL_BOOL(b)	((b) ? REG_DRAM_SEL_N : 0)

/*
 * Registers at a specific address can have different meanings depending
 * on whether data is read or written. This is why direction is part of
 * the programming language identifiers.
 *
 * The vendor documentation suggests that in addition to the first 16
 * register addresses which implement the logic analyzer's feature set,
 * there are 240 more registers in the 16 to 255 address range which
 * are available to applications and plugin features. Can libsigrok's
 * asix-sigma driver store configuration data there, to avoid expensive
 * operations (think: firmware re-load).
 */

enum sigma_write_register {
	WRITE_CLOCK_SELECT	= 0,
	WRITE_TRIGGER_SELECT	= 1,
	WRITE_TRIGGER_SELECT2	= 2,
	WRITE_MODE		= 3,
	WRITE_MEMROW		= 4,
	WRITE_POST_TRIGGER	= 5,
	WRITE_TRIGGER_OPTION	= 6,
	WRITE_PIN_VIEW		= 7,
	/* Unassigned register locations. */
	WRITE_TEST		= 15,
};

enum sigma_read_register {
	READ_ID			= 0,
	READ_TRIGGER_POS_LOW	= 1,
	READ_TRIGGER_POS_HIGH	= 2,
	READ_TRIGGER_POS_UP	= 3,
	READ_STOP_POS_LOW	= 4,
	READ_STOP_POS_HIGH	= 5,
	READ_STOP_POS_UP	= 6,
	READ_MODE		= 7,
	READ_PIN_CHANGE_LOW	= 8,
	READ_PIN_CHANGE_HIGH	= 9,
	READ_BLOCK_LAST_TS_LOW	= 10,
	READ_BLOCK_LAST_TS_HIGH	= 11,
	READ_BLOCK_TS_OVERRUN	= 12,
	READ_PIN_VIEW		= 13,
	/* Unassigned register location. */
	READ_TEST		= 15,
};

#define HI4(b)			(((b) >> 4) & 0x0f)
#define LO4(b)			(((b) >> 0) & 0x0f)

#define BIT_MASK(l)	((1UL << (l)) - 1)

#define CLKSEL_CLKSEL8		(1 << 0)
#define CLKSEL_PINMASK		BIT_MASK(4)
#define CLKSEL_RISING		(1 << 4)
#define CLKSEL_FALLING		(1 << 5)

#define TRGSEL_SELINC_MASK	BIT_MASK(2)
#define TRGSEL_SELINC_SHIFT	0
#define TRGSEL_SELRES_MASK	BIT_MASK(2)
#define TRGSEL_SELRES_SHIFT	2
#define TRGSEL_SELA_MASK	BIT_MASK(2)
#define TRGSEL_SELA_SHIFT	4
#define TRGSEL_SELB_MASK	BIT_MASK(2)
#define TRGSEL_SELB_SHIFT	6
#define TRGSEL_SELC_MASK	BIT_MASK(2)
#define TRGSEL_SELC_SHIFT	8
#define TRGSEL_SELPRESC_MASK	BIT_MASK(4)
#define TRGSEL_SELPRESC_SHIFT	12

enum trgsel_selcode_t {
	TRGSEL_SELCODE_LEVEL = 0,
	TRGSEL_SELCODE_FALL = 1,
	TRGSEL_SELCODE_RISE = 2,
	TRGSEL_SELCODE_EVENT = 3,
	TRGSEL_SELCODE_NEVER = 3,
};

#define TRGSEL2_PINS_MASK	(0x07 << 0)
#define TRGSEL2_PINPOL_RISE	(1 << 3)
#define TRGSEL2_LUT_ADDR_MASK	(0x0f << 0)
#define TRGSEL2_LUT_WRITE	(1 << 4)
#define TRGSEL2_RESET		(1 << 5)
#define TRGSEL2_LEDSEL0		(1 << 6)
#define TRGSEL2_LEDSEL1		(1 << 7)

/* WRITE_MODE register fields. */
#define WMR_SDRAMWRITEEN	(1 << 0)
#define WMR_SDRAMREADEN		(1 << 1)
#define WMR_TRGRES		(1 << 2)
#define WMR_TRGEN		(1 << 3)
#define WMR_FORCESTOP		(1 << 4)
#define WMR_TRGSW		(1 << 5)
/* not used: bit position 6 */
#define WMR_SDRAMINIT		(1 << 7)

/* READ_MODE register fields. */
#define RMR_SDRAMWRITEEN	(1 << 0)
#define RMR_SDRAMREADEN		(1 << 1)
/* not used: bit position 2 */
#define RMR_TRGEN		(1 << 3)
#define RMR_ROUND		(1 << 4)
#define RMR_TRIGGERED		(1 << 5)
#define RMR_POSTTRIGGERED	(1 << 6)
/* not used: bit position 7 */

/*
 * Trigger options. First and second write are similar, but _some_
 * positions change their meaning.
 */
#define TRGOPT_TRGIEN		(1 << 7)
#define TRGOPT_TRGOEN		(1 << 6)
#define TRGOPT_TRGOINEN		(1 << 5) /* 1st write */
#define TRGOPT_TRGINEG		TRGOPT1_TRGOINEN /* 2nd write */
#define TRGOPT_TRGOEVNTEN	(1 << 4) /* 1st write */
#define TRGOPT_TRGOPIN		TRGOPT1_TRGOEVNTEN /* 2nd write */
#define TRGOPT_TRGOOUTEN	(1 << 3) /* 1st write */
#define TRGOPT_TRGOLONG		TRGOPT1_TRGOOUTEN /* 2nd write */
#define TRGOPT_TRGOUTR_OUT	(1 << 1)
#define TRGOPT_TRGOUTR_EN	(1 << 0)
#define TRGOPT_CLEAR_MASK	(TRGOPT_TRGOINEN | TRGOPT_TRGOEVNTEN | TRGOPT_TRGOOUTEN)

/*
 * Layout of the sample data DRAM, which will be downloaded to the PC:
 *
 * Sigma memory is organized in 32K rows. Each row contains 64 clusters.
 * Each cluster contains a timestamp (16bit) and 7 events (16bits each).
 * Events contain 16 bits of sample data (potentially taken at multiple
 * sample points, see below).
 *
 * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MiB (256 Mbit). The
 * size of a memory row is 1024 bytes. Assuming x16 organization of the
 * memory array, address specs (sample count, trigger position) are kept
 * in 24bit entities. The upper 15 bit address the "row", the lower 9 bit
 * refer to the "event" within the row. Because there is one timestamp for
 * seven events each, one memory row can hold up to 64x7 == 448 events.
 *
 * Sample data is represented in 16bit quantities. The first sample in
 * the cluster corresponds to the cluster's timestamp. Each next sample
 * corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
 * one sample period, according to the samplerate). In the absence of
 * pin level changes, no data is provided (RLE compression). A cluster
 * is enforced for each 64K ticks of the timestamp, to reliably handle
 * rollover and determine the next timestamp of the next cluster.
 *
 * For samplerates up to 50MHz, an event directly translates to one set
 * of sample data at a single sample point, spanning up to 16 channels.
 * For samplerates of 100MHz, there is one 16 bit entity for each 20ns
 * period (50MHz rate). The 16 bit memory contains 2 samples of up to
 * 8 channels. Bits of multiple samples are interleaved. For samplerates
 * of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
 * each 5ns apart.
 */

#define ROW_COUNT		32768
#define ROW_LENGTH_BYTES	1024
#define ROW_LENGTH_U16		(ROW_LENGTH_BYTES / sizeof(uint16_t))
#define ROW_SHIFT		9 /* log2 of u16 count */
#define ROW_MASK		((1UL << ROW_SHIFT) - 1)
#define EVENTS_PER_CLUSTER	7
#define CLUSTERS_PER_ROW	(ROW_LENGTH_U16 / (1 + EVENTS_PER_CLUSTER))
#define EVENTS_PER_ROW		(CLUSTERS_PER_ROW * EVENTS_PER_CLUSTER)

struct sigma_dram_line {
	struct sigma_dram_cluster {
		uint16_t timestamp;
		uint16_t samples[EVENTS_PER_CLUSTER];
	} cluster[CLUSTERS_PER_ROW];
};

/* The effect of all these are still a bit unclear. */
struct triggerinout {
	uint8_t trgout_resistor_enable : 1;
	uint8_t trgout_resistor_pullup : 1;
	uint8_t reserved1 : 1;
	uint8_t trgout_bytrigger : 1;
	uint8_t trgout_byevent : 1;
	uint8_t trgout_bytriggerin : 1;
	uint8_t reserved2 : 2;

	/* Should be set same as the first two */
	uint8_t trgout_resistor_enable2 : 1;
	uint8_t trgout_resistor_pullup2 : 1;

	uint8_t reserved3 : 1;
	uint8_t trgout_long : 1;
	uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
	uint8_t trgin_negate : 1;
	uint8_t trgout_enable : 1;
	uint8_t trgin_enable : 1;
};

struct triggerlut {
	/* The actual LUTs. */
	uint16_t m0d[4], m1d[4], m2d[4];
	uint16_t m3q, m3s, m4;

	/* Parameters should be sent as a single register write. */
	struct {
		uint8_t selc : 2;
		uint8_t selpresc : 6;

		uint8_t selinc : 2;
		uint8_t selres : 2;
		uint8_t sela : 2;
		uint8_t selb : 2;

		uint16_t cmpb;
		uint16_t cmpa;
	} params;
};

/* Trigger configuration */
struct sigma_trigger {
	/* Only two channels can be used in mask. */
	uint16_t risingmask;
	uint16_t fallingmask;

	/* Simple trigger support (<= 50 MHz). */
	uint16_t simplemask;
	uint16_t simplevalue;

	/* TODO: Advanced trigger support (boolean expressions). */
};

/* Events for trigger operation. */
enum triggerop {
	OP_LEVEL = 1,
	OP_NOT,
	OP_RISE,
	OP_FALL,
	OP_RISEFALL,
	OP_NOTRISE,
	OP_NOTFALL,
	OP_NOTRISEFALL,
};

/* Logical functions for trigger operation. */
enum triggerfunc {
	FUNC_AND = 1,
	FUNC_NAND,
	FUNC_OR,
	FUNC_NOR,
	FUNC_XOR,
	FUNC_NXOR,
};

struct sigma_state {
	enum {
		SIGMA_UNINITIALIZED = 0,
		SIGMA_CONFIG,
		SIGMA_IDLE,
		SIGMA_CAPTURE,
		SIGMA_STOPPING,
		SIGMA_DOWNLOAD,
	} state;
	uint16_t lastts;
	uint16_t lastsample;
};

enum sigma_firmware_idx {
	SIGMA_FW_NONE,
	SIGMA_FW_50MHZ,
	SIGMA_FW_100MHZ,
	SIGMA_FW_200MHZ,
	SIGMA_FW_SYNC,
	SIGMA_FW_FREQ,
};

enum ext_clock_edge_t {
	SIGMA_CLOCK_EDGE_RISING,
	SIGMA_CLOCK_EDGE_FALLING,
	SIGMA_CLOCK_EDGE_EITHER,
};

struct submit_buffer;

struct dev_context {
	struct {
		uint16_t vid, pid;
		uint32_t serno;
		uint16_t prefix;
		enum asix_device_type type;
	} id;
	struct {
		struct ftdi_context ctx;
		gboolean is_open, must_close;
	} ftdi;
	struct {
		uint64_t samplerate;
		gboolean use_ext_clock;
		size_t clock_pin;
		enum ext_clock_edge_t clock_edge;
	} clock;
	struct sr_sw_limits cfg_limits; /* Configured limits (user specified). */
	struct sr_sw_limits acq_limits; /* Acquisition limits (internal use). */
	struct sr_sw_limits feed_limits; /* Datafeed limits (internal use). */
	enum sigma_firmware_idx firmware_idx;
	int num_channels;
	int samples_per_event;
	uint64_t capture_ratio;
	struct sigma_trigger trigger;
	int use_triggers;
	struct sigma_state state;
	struct submit_buffer *buffer;
};

/* "Automatic" and forced USB connection open/close support. */
SR_PRIV int sigma_check_open(const struct sr_dev_inst *sdi);
SR_PRIV int sigma_check_close(struct dev_context *devc);
SR_PRIV int sigma_force_open(const struct sr_dev_inst *sdi);
SR_PRIV int sigma_force_close(struct dev_context *devc);

/* Send register content (simple and complex) to the hardware. */
SR_PRIV int sigma_write_register(struct dev_context *devc,
	uint8_t reg, uint8_t *data, size_t len);
SR_PRIV int sigma_set_register(struct dev_context *devc,
	uint8_t reg, uint8_t value);
SR_PRIV int sigma_write_trigger_lut(struct dev_context *devc,
	struct triggerlut *lut);

/* Samplerate constraints check, get/set/list helpers. */
SR_PRIV int sigma_normalize_samplerate(uint64_t want_rate, uint64_t *have_rate);
SR_PRIV uint64_t sigma_get_samplerate(const struct sr_dev_inst *sdi);
SR_PRIV GVariant *sigma_get_samplerates_list(void);

/* Preparation of data acquisition, spec conversion, hardware configuration. */
SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi);
SR_PRIV int sigma_set_acquire_timeout(struct dev_context *devc);
SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
SR_PRIV int sigma_build_basic_trigger(struct dev_context *devc,
	struct triggerlut *lut);

/* Callback to periodically drive acuisition progress. */
SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);

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