[libsigrok.git] / hardware / link-mso19 / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
 * Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
 * Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
 *
 * 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_LINK_MSO19_PROTOCOL_H
#define LIBSIGROK_HARDWARE_LINK_MSO19_PROTOCOL_H

#include <stdint.h>
#include <string.h>
#include <glib.h>
#include <libudev.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

/* Message logging helpers with driver-specific prefix string. */
#define DRIVER_LOG_DOMAIN "mso19: "
#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)

#define USB_VENDOR		"3195"
#define USB_PRODUCT		"f190"

#define NUM_PROBES		(1 + 8)
#define NUM_TRIGGER_STAGES	4
#define TRIGGER_TYPE 		"01"	//the first r/f is used for the whole group
#define SERIALCOMM		"460800/8n1/flow=2"
#define SERIALCONN		"/dev/ttyUSB0"
#define CLOCK_RATE		SR_MHZ(100)
#define MIN_NUM_SAMPLES		4

#define MSO_TRIGGER_UNKNOWN	'!'
#define MSO_TRIGGER_UNKNOWN1	'1'
#define MSO_TRIGGER_UNKNOWN2	'2'
#define MSO_TRIGGER_UNKNOWN3	'3'
#define MSO_TRIGGER_WAIT	'4'
#define MSO_TRIGGER_FIRED	'5'
#define MSO_TRIGGER_DATAREADY	'6'

enum trigger_slopes {
	SLOPE_POSITIVE = 0,
	SLOPE_NEGATIVE,
};

/* Structure for the pattern generator state */
struct mso_patgen {
	/* Pattern generator clock config */
	uint16_t clock;
	/* Buffer start address */
	uint16_t start;
	/* Buffer end address */
	uint16_t end;
	/* Pattern generator config */
	uint8_t config;
	/* Samples buffer */
	uint8_t buffer[1024];
	/* Input/output configuration for the samples buffer (?) */
	uint8_t io[1024];
	/* Number of loops for the pattern generator */
	uint8_t loops;
	/* Bit enable mask for the I/O lines */
	uint8_t mask;
};

/* Data structure for the protocol trigger state */
struct mso_prototrig {
	/* Word match buffer */
	uint8_t word[4];
	/* Masks for the wordmatch buffer */
	uint8_t mask[4];
	/* SPI mode 0, 1, 2, 3. Set to 0 for I2C */
	uint8_t spimode;
};

/* Private, per-device-instance driver context. */
struct dev_context {
	/* info */
	uint8_t hwmodel;
	uint8_t hwrev;
	struct sr_serial_dev_inst *serial;
//      uint8_t num_sample_rates;
	/* calibration */
	double vbit;
	uint16_t dac_offset;
	uint16_t offset_range;
	uint64_t limit_samples;
	uint64_t num_samples;
	/* register cache */
	uint8_t ctlbase1;
	uint8_t ctlbase2;
	/* state */
	uint8_t la_threshold;
	uint64_t cur_rate;
	uint8_t dso_probe_attn;
	int8_t use_trigger;
	uint8_t trigger_chan;
	uint8_t trigger_slope;
	uint8_t trigger_outsrc;
	uint8_t trigger_state;
	uint8_t trigger_holdoff[2];
	uint8_t la_trigger;
	uint8_t la_trigger_mask;
	double dso_trigger_voltage;
	uint16_t dso_trigger_width;
	struct mso_prototrig protocol_trigger;
	void *cb_data;
	uint16_t buffer_n;
	char buffer[4096];
};

SR_PRIV int mso_parse_serial(const char *iSerial, const char *iProduct,
			     struct dev_context *ctx);
SR_PRIV int mso_check_trigger(struct sr_serial_dev_inst *serial,
			      uint8_t * info);
SR_PRIV int mso_reset_adc(struct sr_dev_inst *sdi);
SR_PRIV int mso_clkrate_out(struct sr_serial_dev_inst *serial, uint16_t val);
SR_PRIV int mso_configure_rate(const struct sr_dev_inst *sdi, uint32_t rate);
SR_PRIV int mso_receive_data(int fd, int revents, void *cb_data);
SR_PRIV int mso_configure_trigger(const struct sr_dev_inst *sdi);
SR_PRIV int mso_configure_threshold_level(const struct sr_dev_inst *sdi);
SR_PRIV int mso_read_buffer(struct sr_dev_inst *sdi);
SR_PRIV int mso_arm(const struct sr_dev_inst *sdi);
SR_PRIV int mso_force_capture(struct sr_dev_inst *sdi);
SR_PRIV int mso_dac_out(const struct sr_dev_inst *sdi, uint16_t val);
SR_PRIV inline uint16_t mso_calc_raw_from_mv(struct dev_context *devc);
SR_PRIV int mso_reset_fsm(struct sr_dev_inst *sdi);
SR_PRIV int mso_toggle_led(struct sr_dev_inst *sdi, int state);

SR_PRIV int mso_configure_probes(const struct sr_dev_inst *sdi);
SR_PRIV void stop_acquisition(const struct sr_dev_inst *sdi);

/* bank agnostic registers */
#define REG_CTL2		15

/* bank 0 registers */
#define REG_BUFFER		1
#define REG_TRIGGER		2
#define REG_CLKRATE1		9
#define REG_CLKRATE2		10
#define REG_DAC1		12
#define REG_DAC2		13
/* possibly bank agnostic: */
#define REG_CTL1		14

/* bank 2 registers (SPI/I2C protocol trigger) */
#define REG_PT_WORD(x)		(x)
#define REG_PT_MASK(x)		(x + 4)
#define REG_PT_SPIMODE		8

/* bits - REG_CTL1 */
#define BIT_CTL1_RESETFSM	(1 << 0)
#define BIT_CTL1_ARM		(1 << 1)
#define BIT_CTL1_ADC_UNKNOWN4	(1 << 4)	/* adc enable? */
#define BIT_CTL1_RESETADC	(1 << 6)
#define BIT_CTL1_LED		(1 << 7)

/* bits - REG_CTL2 */
#define BITS_CTL2_BANK(x)	(x & 0x3)
#define BIT_CTL2_SLOWMODE	(1 << 5)

struct rate_map {
	uint32_t rate;
	uint16_t val;
	uint8_t slowmode;
};

static const struct rate_map rate_map[] = {
	{ SR_MHZ(200), 0x0205, 0 },
	{ SR_MHZ(100), 0x0105, 0 },
	{ SR_MHZ(50),  0x0005, 0 },
	{ SR_MHZ(20),  0x0303, 0 },
	{ SR_MHZ(10),  0x0308, 0 },
	{ SR_MHZ(5),   0x030c, 0 },
	{ SR_MHZ(2),   0x0330, 0 },
	{ SR_MHZ(1),   0x0362, 0 },
	{ SR_KHZ(500), 0x03c6, 0 },
	{ SR_KHZ(200), 0x07f2, 0 },
	{ SR_KHZ(100), 0x0fe6, 0 },
	{ SR_KHZ(50),  0x1fce, 0 },
	{ SR_KHZ(20),  0x4f86, 0 },
	{ SR_KHZ(10),  0x9f0e, 0 },
	{ SR_KHZ(5),   0x03c7, 0x20 },
	{ SR_KHZ(2),   0x07f3, 0x20 },
	{ SR_KHZ(1),   0x0fe7, 0x20 },
	{ SR_HZ(500),  0x1fcf, 0x20 },
	{ SR_HZ(200),  0x4f87, 0x20 },
	{ SR_HZ(100),  0x9f0f, 0x20 },
};

/* FIXME: Determine corresponding voltages */
static const uint16_t la_threshold_map[] = {
	0x8600,
	0x8770,
	0x88ff,
	0x8c70,
	0x8eff,
	0x8fff,
};

#endif
Commit	Line	Data
df92e5cf	1	/*
50985c20	2	* This file is part of the libsigrok project.
df92e5cf	3	*
f48cef78 UH	4	* Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
	5	* Copyright (C) 2012 Renato Caldas <rmsc@fe.up.pt>
	6	* Copyright (C) 2013 Lior Elazary <lelazary@yahoo.com>
df92e5cf	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
	22	#ifndef LIBSIGROK_HARDWARE_LINK_MSO19_PROTOCOL_H
	23	#define LIBSIGROK_HARDWARE_LINK_MSO19_PROTOCOL_H
	24
df92e5cf	25	#include <stdint.h>
	26	#include <string.h>
	27	#include <glib.h>
753d722f	28	#include <libudev.h>
df92e5cf	29	#include "libsigrok.h"
	30	#include "libsigrok-internal.h"
	31
	32	/* Message logging helpers with driver-specific prefix string. */
	33	#define DRIVER_LOG_DOMAIN "mso19: "
	34	#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
	35	#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
	36	#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
	37	#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
	38	#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
	39	#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
	40
00b44ccb UH	41	#define USB_VENDOR "3195"
	42	#define USB_PRODUCT "f190"
	43
365f04d6	44	#define NUM_PROBES (1 + 8)
00b44ccb	45	#define NUM_TRIGGER_STAGES 4
c50277a6	46	#define TRIGGER_TYPE "01" //the first r/f is used for the whole group
00b44ccb UH	47	#define SERIALCOMM "460800/8n1/flow=2"
	48	#define SERIALCONN "/dev/ttyUSB0"
	49	#define CLOCK_RATE SR_MHZ(100)
	50	#define MIN_NUM_SAMPLES 4
df92e5cf	51
df92e5cf	52	#define MSO_TRIGGER_UNKNOWN '!'
	53	#define MSO_TRIGGER_UNKNOWN1 '1'
	54	#define MSO_TRIGGER_UNKNOWN2 '2'
	55	#define MSO_TRIGGER_UNKNOWN3 '3'
	56	#define MSO_TRIGGER_WAIT '4'
	57	#define MSO_TRIGGER_FIRED '5'
	58	#define MSO_TRIGGER_DATAREADY '6'
	59
087a9161	60	enum trigger_slopes {
00b44ccb UH	61	SLOPE_POSITIVE = 0,
00b44ccb UH	62	SLOPE_NEGATIVE,
087a9161	63	};
087a9161	64
df92e5cf	65	/* Structure for the pattern generator state */
	66	struct mso_patgen {
	67	/* Pattern generator clock config */
	68	uint16_t clock;
	69	/* Buffer start address */
	70	uint16_t start;
	71	/* Buffer end address */
	72	uint16_t end;
	73	/* Pattern generator config */
	74	uint8_t config;
	75	/* Samples buffer */
	76	uint8_t buffer[1024];
00b44ccb	77	/* Input/output configuration for the samples buffer (?) */
df92e5cf	78	uint8_t io[1024];
	79	/* Number of loops for the pattern generator */
	80	uint8_t loops;
	81	/* Bit enable mask for the I/O lines */
	82	uint8_t mask;
	83	};
	84
	85	/* Data structure for the protocol trigger state */
	86	struct mso_prototrig {
	87	/* Word match buffer */
	88	uint8_t word[4];
	89	/* Masks for the wordmatch buffer */
	90	uint8_t mask[4];
	91	/* SPI mode 0, 1, 2, 3. Set to 0 for I2C */
	92	uint8_t spimode;
	93	};
	94
	95	/* Private, per-device-instance driver context. */
	96	struct dev_context {
	97	/* info */
	98	uint8_t hwmodel;
	99	uint8_t hwrev;
	100	struct sr_serial_dev_inst *serial;
00b44ccb	101	// uint8_t num_sample_rates;
df92e5cf	102	/* calibration */
	103	double vbit;
	104	uint16_t dac_offset;
	105	uint16_t offset_range;
00b44ccb UH	106	uint64_t limit_samples;
00b44ccb UH	107	uint64_t num_samples;
df92e5cf	108	/* register cache */
	109	uint8_t ctlbase1;
	110	uint8_t ctlbase2;
	111	/* state */
	112	uint8_t la_threshold;
	113	uint64_t cur_rate;
	114	uint8_t dso_probe_attn;
00b44ccb	115	int8_t use_trigger;
df92e5cf	116	uint8_t trigger_chan;
	117	uint8_t trigger_slope;
	118	uint8_t trigger_outsrc;
	119	uint8_t trigger_state;
087a9161	120	uint8_t trigger_holdoff[2];
df92e5cf	121	uint8_t la_trigger;
	122	uint8_t la_trigger_mask;
	123	double dso_trigger_voltage;
	124	uint16_t dso_trigger_width;
	125	struct mso_prototrig protocol_trigger;
3e9b7f9c	126	void *cb_data;
df92e5cf	127	uint16_t buffer_n;
	128	char buffer[4096];
	129	};
	130
	131	SR_PRIV int mso_parse_serial(const char iSerial, const char iProduct,
00b44ccb UH	132	struct dev_context *ctx);
	133	SR_PRIV int mso_check_trigger(struct sr_serial_dev_inst *serial,
	134	uint8_t * info);
df92e5cf	135	SR_PRIV int mso_reset_adc(struct sr_dev_inst *sdi);
df92e5cf	136	SR_PRIV int mso_clkrate_out(struct sr_serial_dev_inst *serial, uint16_t val);
753d722f	137	SR_PRIV int mso_configure_rate(const struct sr_dev_inst *sdi, uint32_t rate);
df92e5cf	138	SR_PRIV int mso_receive_data(int fd, int revents, void *cb_data);
753d722f UH	139	SR_PRIV int mso_configure_trigger(const struct sr_dev_inst *sdi);
753d722f UH	140	SR_PRIV int mso_configure_threshold_level(const struct sr_dev_inst *sdi);
4b719338	141	SR_PRIV int mso_read_buffer(struct sr_dev_inst *sdi);
753d722f	142	SR_PRIV int mso_arm(const struct sr_dev_inst *sdi);
4b719338	143	SR_PRIV int mso_force_capture(struct sr_dev_inst *sdi);
753d722f	144	SR_PRIV int mso_dac_out(const struct sr_dev_inst *sdi, uint16_t val);
4b719338	145	SR_PRIV inline uint16_t mso_calc_raw_from_mv(struct dev_context *devc);
4db2aaff	146	SR_PRIV int mso_reset_fsm(struct sr_dev_inst *sdi);
4db2aaff	147	SR_PRIV int mso_toggle_led(struct sr_dev_inst *sdi, int state);
4b719338	148
5a24e89c	149	SR_PRIV int mso_configure_probes(const struct sr_dev_inst *sdi);
df92e5cf	150	SR_PRIV void stop_acquisition(const struct sr_dev_inst *sdi);
df92e5cf	151
df92e5cf	152	/* bank agnostic registers */
	153	#define REG_CTL2 15
	154
	155	/* bank 0 registers */
	156	#define REG_BUFFER 1
	157	#define REG_TRIGGER 2
	158	#define REG_CLKRATE1 9
	159	#define REG_CLKRATE2 10
	160	#define REG_DAC1 12
	161	#define REG_DAC2 13
	162	/* possibly bank agnostic: */
	163	#define REG_CTL1 14
	164
	165	/* bank 2 registers (SPI/I2C protocol trigger) */
00b44ccb UH	166	#define REG_PT_WORD(x) (x)
	167	#define REG_PT_MASK(x) (x + 4)
	168	#define REG_PT_SPIMODE 8
df92e5cf	169
df92e5cf	170	/* bits - REG_CTL1 */
00b44ccb UH	171	#define BIT_CTL1_RESETFSM (1 << 0)
	172	#define BIT_CTL1_ARM (1 << 1)
	173	#define BIT_CTL1_ADC_UNKNOWN4 (1 << 4) /* adc enable? */
	174	#define BIT_CTL1_RESETADC (1 << 6)
	175	#define BIT_CTL1_LED (1 << 7)
df92e5cf	176
df92e5cf	177	/* bits - REG_CTL2 */
00b44ccb UH	178	#define BITS_CTL2_BANK(x) (x & 0x3)
00b44ccb UH	179	#define BIT_CTL2_SLOWMODE (1 << 5)
df92e5cf	180
	181	struct rate_map {
	182	uint32_t rate;
	183	uint16_t val;
	184	uint8_t slowmode;
	185	};
	186
753d722f	187	static const struct rate_map rate_map[] = {
00b44ccb UH	188	{ SR_MHZ(200), 0x0205, 0 },
	189	{ SR_MHZ(100), 0x0105, 0 },
	190	{ SR_MHZ(50), 0x0005, 0 },
	191	{ SR_MHZ(20), 0x0303, 0 },
	192	{ SR_MHZ(10), 0x0308, 0 },
	193	{ SR_MHZ(5), 0x030c, 0 },
	194	{ SR_MHZ(2), 0x0330, 0 },
	195	{ SR_MHZ(1), 0x0362, 0 },
	196	{ SR_KHZ(500), 0x03c6, 0 },
	197	{ SR_KHZ(200), 0x07f2, 0 },
	198	{ SR_KHZ(100), 0x0fe6, 0 },
	199	{ SR_KHZ(50), 0x1fce, 0 },
	200	{ SR_KHZ(20), 0x4f86, 0 },
	201	{ SR_KHZ(10), 0x9f0e, 0 },
	202	{ SR_KHZ(5), 0x03c7, 0x20 },
	203	{ SR_KHZ(2), 0x07f3, 0x20 },
	204	{ SR_KHZ(1), 0x0fe7, 0x20 },
	205	{ SR_HZ(500), 0x1fcf, 0x20 },
	206	{ SR_HZ(200), 0x4f87, 0x20 },
	207	{ SR_HZ(100), 0x9f0f, 0x20 },
df92e5cf	208	};
	209
	210	/* FIXME: Determine corresponding voltages */
753d722f	211	static const uint16_t la_threshold_map[] = {
df92e5cf	212	0x8600,
	213	0x8770,
	214	0x88ff,
	215	0x8c70,
	216	0x8eff,
	217	0x8fff,
	218	};
	219
df92e5cf	220	#endif