[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>
 *
 * 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

#define USB_VENDOR			0xa600
#define USB_PRODUCT			0xa000
#define USB_DESCRIPTION			"ASIX SIGMA"

enum sigma_write_register {
	WRITE_CLOCK_SELECT	= 0,
	WRITE_TRIGGER_SELECT0	= 1,
	WRITE_TRIGGER_SELECT1	= 2,
	WRITE_MODE		= 3,
	WRITE_MEMROW		= 4,
	WRITE_POST_TRIGGER	= 5,
	WRITE_TRIGGER_OPTION	= 6,
	WRITE_PIN_VIEW		= 7,

	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_PIN_VIEW		= 12,

	READ_TEST		= 15,
};

#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_DRAM_WAIT_ACK	(0x5 << 4)

/* Bit (1 << 4) can be low or high (double buffer / cache) */
#define REG_DRAM_BLOCK		(0x6 << 4)
#define REG_DRAM_BLOCK_BEGIN	(0x8 << 4)
#define REG_DRAM_BLOCK_DATA	(0xa << 4)

#define LEDSEL0			6
#define LEDSEL1			7

#define NEXT_REG		1

#define EVENTS_PER_CLUSTER	7

#define CHUNK_SIZE		1024

/* 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 */

/*
 * 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 samples (16bits each).
 * Total memory size is 32K x 64 x 8 x 2 bytes == 32 MB (256 Mbit).
 *
 * 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 determination of the next timestamp of the next cluster.
 *
 * 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.
 *
 * Memory addresses (sample count, trigger position) are kept in 24bit
 * entities. The upper 15 bit refer to the "row", the lower 9 bit refer
 * to the "event" within the row. Because there is one timestamp for
 * seven samples each, one memory row can hold up to 64x7 == 448 samples.
 */

/* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
struct sigma_dram_cluster {
	uint8_t		timestamp_lo;
	uint8_t		timestamp_hi;
	struct {
		uint8_t	sample_hi;
		uint8_t	sample_lo;
	}		samples[7];
};

/* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
struct sigma_dram_line {
	struct sigma_dram_cluster	cluster[64];
};

struct clockselect_50 {
	uint8_t async;
	uint8_t fraction;
	uint16_t disabled_channels;
};

/* 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 m3, 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_IDLE,
		SIGMA_CAPTURE,
		SIGMA_STOPPING,
		SIGMA_DOWNLOAD,
	} state;
	uint16_t lastts;
	uint16_t lastsample;
};

struct dev_context {
	struct ftdi_context ftdic;
	uint64_t cur_samplerate;
	uint64_t limit_msec;
	uint64_t limit_samples;
	uint64_t sent_samples;
	uint64_t start_time;
	int cur_firmware;
	int num_channels;
	int cur_channels;
	int samples_per_event;
	uint64_t capture_ratio;
	struct sigma_trigger trigger;
	int use_triggers;
	struct sigma_state state;
};

extern SR_PRIV const uint64_t samplerates[];
extern SR_PRIV const size_t samplerates_count;

SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
				 struct dev_context *devc);
SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc);
SR_PRIV int sigma_write_trigger_lut(struct triggerlut *lut, struct dev_context *devc);
SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
					     uint64_t limit_samples);
SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
SR_PRIV int sigma_build_basic_trigger(struct triggerlut *lut, struct dev_context *devc);

#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>
	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"
f272d7dd UH	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
3ba56876	43	#define USB_VENDOR 0xa600
	44	#define USB_PRODUCT 0xa000
	45	#define USB_DESCRIPTION "ASIX SIGMA"
3ba56876	46
fefa1800	47	enum sigma_write_register {
28a35d8a HE	48	WRITE_CLOCK_SELECT = 0,
	49	WRITE_TRIGGER_SELECT0 = 1,
	50	WRITE_TRIGGER_SELECT1 = 2,
	51	WRITE_MODE = 3,
	52	WRITE_MEMROW = 4,
	53	WRITE_POST_TRIGGER = 5,
	54	WRITE_TRIGGER_OPTION = 6,
	55	WRITE_PIN_VIEW = 7,
	56
fefa1800	57	WRITE_TEST = 15,
28a35d8a HE	58	};
28a35d8a HE	59
fefa1800	60	enum sigma_read_register {
28a35d8a HE	61	READ_ID = 0,
	62	READ_TRIGGER_POS_LOW = 1,
	63	READ_TRIGGER_POS_HIGH = 2,
	64	READ_TRIGGER_POS_UP = 3,
	65	READ_STOP_POS_LOW = 4,
	66	READ_STOP_POS_HIGH = 5,
	67	READ_STOP_POS_UP = 6,
	68	READ_MODE = 7,
	69	READ_PIN_CHANGE_LOW = 8,
	70	READ_PIN_CHANGE_HIGH = 9,
	71	READ_BLOCK_LAST_TS_LOW = 10,
	72	READ_BLOCK_LAST_TS_HIGH = 11,
	73	READ_PIN_VIEW = 12,
	74
fefa1800	75	READ_TEST = 15,
28a35d8a HE	76	};
28a35d8a HE	77
1c2736f9 MV	78	#define REG_ADDR_LOW (0x0 << 4)
	79	#define REG_ADDR_HIGH (0x1 << 4)
	80	#define REG_DATA_LOW (0x2 << 4)
	81	#define REG_DATA_HIGH_WRITE (0x3 << 4)
	82	#define REG_READ_ADDR (0x4 << 4)
	83	#define REG_DRAM_WAIT_ACK (0x5 << 4)
28a35d8a HE	84
28a35d8a HE	85	/* Bit (1 << 4) can be low or high (double buffer / cache) */
1c2736f9 MV	86	#define REG_DRAM_BLOCK (0x6 << 4)
	87	#define REG_DRAM_BLOCK_BEGIN (0x8 << 4)
	88	#define REG_DRAM_BLOCK_DATA (0xa << 4)
28a35d8a	89
57bbf56b HE	90	#define LEDSEL0 6
	91	#define LEDSEL1 7
	92
28a35d8a HE	93	#define NEXT_REG 1
	94
	95	#define EVENTS_PER_CLUSTER 7
	96
	97	#define CHUNK_SIZE 1024
	98
22f64ed8 GS	99	/* WRITE_MODE register fields. */
	100	#define WMR_SDRAMWRITEEN (1 << 0)
	101	#define WMR_SDRAMREADEN (1 << 1)
	102	#define WMR_TRGRES (1 << 2)
	103	#define WMR_TRGEN (1 << 3)
	104	#define WMR_FORCESTOP (1 << 4)
	105	#define WMR_TRGSW (1 << 5)
	106	/* not used: bit position 6 */
	107	#define WMR_SDRAMINIT (1 << 7)
	108
	109	/* READ_MODE register fields. */
	110	#define RMR_SDRAMWRITEEN (1 << 0)
	111	#define RMR_SDRAMREADEN (1 << 1)
	112	/* not used: bit position 2 */
	113	#define RMR_TRGEN (1 << 3)
	114	#define RMR_ROUND (1 << 4)
	115	#define RMR_TRIGGERED (1 << 5)
	116	#define RMR_POSTTRIGGERED (1 << 6)
	117	/* not used: bit position 7 */
	118
fd830beb	119	/*
5b1d15ef GS	120	* Layout of the sample data DRAM, which will be downloaded to the PC:
	121	*
	122	* Sigma memory is organized in 32K rows. Each row contains 64 clusters.
	123	* Each cluster contains a timestamp (16bit) and 7 samples (16bits each).
	124	* Total memory size is 32K x 64 x 8 x 2 bytes == 32 MB (256 Mbit).
	125	*
	126	* Sample data is represented in 16bit quantities. The first sample in
	127	* the cluster corresponds to the cluster's timestamp. Each next sample
	128	* corresponds to the timestamp + 1, timestamp + 2, etc (the distance is
	129	* one sample period, according to the samplerate). In the absence of
	130	* pin level changes, no data is provided (RLE compression). A cluster
	131	* is enforced for each 64K ticks of the timestamp, to reliably handle
	132	* rollover and determination of the next timestamp of the next cluster.
	133	*
	134	* For samplerates of 100MHz, there is one 16 bit entity for each 20ns
	135	* period (50MHz rate). The 16 bit memory contains 2 samples of up to
	136	* 8 channels. Bits of multiple samples are interleaved. For samplerates
	137	* of 200MHz one 16bit entity contains 4 samples of up to 4 channels,
	138	* each 5ns apart.
	139	*
	140	* Memory addresses (sample count, trigger position) are kept in 24bit
	141	* entities. The upper 15 bit refer to the "row", the lower 9 bit refer
	142	* to the "event" within the row. Because there is one timestamp for
	143	* seven samples each, one memory row can hold up to 64x7 == 448 samples.
fd830beb MV	144	*/
	145
	146	/* One "DRAM cluster" contains a timestamp and 7 samples, 16b total. */
	147	struct sigma_dram_cluster {
	148	uint8_t timestamp_lo;
	149	uint8_t timestamp_hi;
	150	struct {
	151	uint8_t sample_hi;
	152	uint8_t sample_lo;
	153	} samples[7];
	154	};
	155
	156	/* One "DRAM line" contains 64 "DRAM clusters", 1024b total. */
	157	struct sigma_dram_line {
	158	struct sigma_dram_cluster cluster[64];
	159	};
	160
edca2c5c HE	161	struct clockselect_50 {
	162	uint8_t async;
	163	uint8_t fraction;
ba7dd8bb	164	uint16_t disabled_channels;
edca2c5c HE	165	};
edca2c5c HE	166
57bbf56b HE	167	/* The effect of all these are still a bit unclear. */
	168	struct triggerinout {
	169	uint8_t trgout_resistor_enable : 1;
	170	uint8_t trgout_resistor_pullup : 1;
	171	uint8_t reserved1 : 1;
	172	uint8_t trgout_bytrigger : 1;
	173	uint8_t trgout_byevent : 1;
	174	uint8_t trgout_bytriggerin : 1;
	175	uint8_t reserved2 : 2;
	176
	177	/* Should be set same as the first two */
	178	uint8_t trgout_resistor_enable2 : 1;
	179	uint8_t trgout_resistor_pullup2 : 1;
	180
	181	uint8_t reserved3 : 1;
	182	uint8_t trgout_long : 1;
	183	uint8_t trgout_pin : 1; /* Use 1k resistor. Pullup? */
	184	uint8_t trgin_negate : 1;
	185	uint8_t trgout_enable : 1;
	186	uint8_t trgin_enable : 1;
	187	};
	188
ee492173 HE	189	struct triggerlut {
	190	/* The actual LUTs. */
	191	uint16_t m0d[4], m1d[4], m2d[4];
	192	uint16_t m3, m3s, m4;
	193
f3f19d11	194	/* Parameters should be sent as a single register write. */
ee492173 HE	195	struct {
	196	uint8_t selc : 2;
	197	uint8_t selpresc : 6;
	198
	199	uint8_t selinc : 2;
	200	uint8_t selres : 2;
	201	uint8_t sela : 2;
	202	uint8_t selb : 2;
	203
	204	uint16_t cmpb;
	205	uint16_t cmpa;
	206	} params;
	207	};
	208
c53d793f HE	209	/* Trigger configuration */
c53d793f HE	210	struct sigma_trigger {
ba7dd8bb	211	/* Only two channels can be used in mask. */
a42aec7f HE	212	uint16_t risingmask;
a42aec7f HE	213	uint16_t fallingmask;
c53d793f HE	214
	215	/* Simple trigger support (<= 50 MHz). */
	216	uint16_t simplemask;
	217	uint16_t simplevalue;
	218
c53d793f HE	219	/* TODO: Advanced trigger support (boolean expressions). */
	220	};
	221
	222	/* Events for trigger operation. */
	223	enum triggerop {
	224	OP_LEVEL = 1,
	225	OP_NOT,
	226	OP_RISE,
	227	OP_FALL,
	228	OP_RISEFALL,
	229	OP_NOTRISE,
	230	OP_NOTFALL,
	231	OP_NOTRISEFALL,
	232	};
	233
	234	/* Logical functions for trigger operation. */
	235	enum triggerfunc {
	236	FUNC_AND = 1,
	237	FUNC_NAND,
	238	FUNC_OR,
	239	FUNC_NOR,
	240	FUNC_XOR,
	241	FUNC_NXOR,
	242	};
	243
6aac7737 HE	244	struct sigma_state {
	245	enum {
	246	SIGMA_UNINITIALIZED = 0,
	247	SIGMA_IDLE,
	248	SIGMA_CAPTURE,
dde0175d	249	SIGMA_STOPPING,
6aac7737 HE	250	SIGMA_DOWNLOAD,
6aac7737 HE	251	} state;
6aac7737 HE	252	uint16_t lastts;
6aac7737 HE	253	uint16_t lastsample;
6aac7737 HE	254	};
6aac7737 HE	255
0e1357e8	256	struct dev_context {
99965709 HE	257	struct ftdi_context ftdic;
99965709 HE	258	uint64_t cur_samplerate;
94ba4bd6	259	uint64_t limit_msec;
2f7e529c	260	uint64_t limit_samples;
735ed8a1	261	uint64_t sent_samples;
2f425a56	262	uint64_t start_time;
99965709	263	int cur_firmware;
ba7dd8bb	264	int num_channels;
5fc01191	265	int cur_channels;
99965709	266	int samples_per_event;
efad7ccc	267	uint64_t capture_ratio;
99965709	268	struct sigma_trigger trigger;
5b5ea7c6	269	int use_triggers;
99965709	270	struct sigma_state state;
99965709 HE	271	};
99965709 HE	272
3ba56876	273	extern SR_PRIV const uint64_t samplerates[];
4154a516	274	extern SR_PRIV const size_t samplerates_count;
3ba56876	275
176d785d	276	SR_PRIV int sigma_write_register(uint8_t reg, uint8_t *data, size_t len,
3ba56876	277	struct dev_context *devc);
	278	SR_PRIV int sigma_set_register(uint8_t reg, uint8_t value, struct dev_context *devc);
	279	SR_PRIV int sigma_write_trigger_lut(struct triggerlut lut, struct dev_context devc);
9a0a606a GS	280	SR_PRIV uint64_t sigma_limit_samples_to_msec(const struct dev_context *devc,
9a0a606a GS	281	uint64_t limit_samples);
3ba56876	282	SR_PRIV int sigma_set_samplerate(const struct sr_dev_inst *sdi, uint64_t samplerate);
	283	SR_PRIV int sigma_convert_trigger(const struct sr_dev_inst *sdi);
	284	SR_PRIV int sigma_receive_data(int fd, int revents, void *cb_data);
	285	SR_PRIV int sigma_build_basic_trigger(struct triggerlut lut, struct dev_context devc);
	286
204b1629	287	#endif