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

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.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

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

#include <stdint.h>
#include <string.h>
#include <glib.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 NUM_PROBES             8
#define NUM_TRIGGER_STAGES     4
#define TRIGGER_TYPES          "01"
#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'

/* 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;
	/* register cache */
	uint8_t ctlbase1;
	uint8_t ctlbase2;
	/* state */
	uint8_t la_threshold;
	uint64_t cur_rate;
	uint8_t dso_probe_attn;
	uint8_t trigger_chan;
	uint8_t trigger_slope;
	uint8_t trigger_outsrc;
	uint8_t trigger_state;
	uint8_t la_trigger;
	uint8_t la_trigger_mask;
	double dso_trigger_voltage;
	uint16_t dso_trigger_width;
	struct mso_prototrig protocol_trigger;
	void *session_dev_id;
	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(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(struct sr_dev_inst *sdi);
SR_PRIV int mso_configure_threshold_level(struct sr_dev_inst *sdi);
SR_PRIV int mso_read_buffer(struct sr_dev_inst *sdi);
SR_PRIV int mso_arm(struct sr_dev_inst *sdi);
SR_PRIV int mso_force_capture(struct sr_dev_inst *sdi);
SR_PRIV int mso_dac_out(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);

///////////////////////
//

/* serial protocol */
#define mso_trans(a, v) \
	(((v) & 0x3f) | (((v) & 0xc0) << 6) | (((a) & 0xf) << 8) | \
	((~(v) & 0x20) << 1) | ((~(v) & 0x80) << 7))

SR_PRIV static const char mso_head[] = { 0x40, 0x4c, 0x44, 0x53, 0x7e };
SR_PRIV static const char mso_foot[] = { 0x7e };

/* 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 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	},
	{ 500,		0x1fcf, 0x20	},
	{ 200,		0x4f87, 0x20	},
	{ 100,		0x9f0f, 0x20	},
};

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

#endif
Commit	Line	Data
df92e5cf	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#ifndef LIBSIGROK_HARDWARE_LINK_MSO19_PROTOCOL_H
	21	#define LIBSIGROK_HARDWARE_LINK_MSO19_PROTOCOL_H
	22
	23	#define USB_VENDOR "3195"
	24	#define USB_PRODUCT "f190"
	25
	26	#include <stdint.h>
	27	#include <string.h>
	28	#include <glib.h>
	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
	41	#define NUM_PROBES 8
	42	#define NUM_TRIGGER_STAGES 4
	43	#define TRIGGER_TYPES "01"
4db2aaff	44	#define SERIALCOMM "460800/8n1/flow=2"
4db2aaff	45	#define SERIALCONN "/dev/ttyUSB0"
df92e5cf	46	#define CLOCK_RATE SR_MHZ(100)
	47	#define MIN_NUM_SAMPLES 4
	48
df92e5cf	49	#define MSO_TRIGGER_UNKNOWN '!'
	50	#define MSO_TRIGGER_UNKNOWN1 '1'
	51	#define MSO_TRIGGER_UNKNOWN2 '2'
	52	#define MSO_TRIGGER_UNKNOWN3 '3'
	53	#define MSO_TRIGGER_WAIT '4'
	54	#define MSO_TRIGGER_FIRED '5'
	55	#define MSO_TRIGGER_DATAREADY '6'
	56
	57	/* Structure for the pattern generator state */
	58	struct mso_patgen {
	59	/* Pattern generator clock config */
	60	uint16_t clock;
	61	/* Buffer start address */
	62	uint16_t start;
	63	/* Buffer end address */
	64	uint16_t end;
	65	/* Pattern generator config */
	66	uint8_t config;
	67	/* Samples buffer */
	68	uint8_t buffer[1024];
	69	/* Input/output configuration for the samples buffer (?)*/
	70	uint8_t io[1024];
	71	/* Number of loops for the pattern generator */
	72	uint8_t loops;
	73	/* Bit enable mask for the I/O lines */
	74	uint8_t mask;
	75	};
	76
	77	/* Data structure for the protocol trigger state */
	78	struct mso_prototrig {
	79	/* Word match buffer */
	80	uint8_t word[4];
	81	/* Masks for the wordmatch buffer */
	82	uint8_t mask[4];
	83	/* SPI mode 0, 1, 2, 3. Set to 0 for I2C */
	84	uint8_t spimode;
	85	};
	86
	87	/* Private, per-device-instance driver context. */
	88	struct dev_context {
	89	/* info */
	90	uint8_t hwmodel;
	91	uint8_t hwrev;
	92	struct sr_serial_dev_inst *serial;
	93	// uint8_t num_sample_rates;
	94	/* calibration */
	95	double vbit;
	96	uint16_t dac_offset;
	97	uint16_t offset_range;
	98	/* register cache */
	99	uint8_t ctlbase1;
	100	uint8_t ctlbase2;
	101	/* state */
	102	uint8_t la_threshold;
	103	uint64_t cur_rate;
	104	uint8_t dso_probe_attn;
	105	uint8_t trigger_chan;
	106	uint8_t trigger_slope;
	107	uint8_t trigger_outsrc;
	108	uint8_t trigger_state;
	109	uint8_t la_trigger;
	110	uint8_t la_trigger_mask;
	111	double dso_trigger_voltage;
	112	uint16_t dso_trigger_width;
113	struct mso_prototrig protocol_trigger;
114	void *session_dev_id;
115	uint16_t buffer_n;
116	char buffer[4096];
117	};
118
119	SR_PRIV int mso_parse_serial(const char iSerial, const char iProduct,
120	struct dev_context *ctx);
121	SR_PRIV int mso_check_trigger(struct sr_serial_dev_inst serial, uint8_t info);
122	SR_PRIV int mso_reset_adc(struct sr_dev_inst *sdi);
123	SR_PRIV int mso_clkrate_out(struct sr_serial_dev_inst *serial, uint16_t val);
124	SR_PRIV int mso_configure_rate(struct sr_dev_inst *sdi, uint32_t rate);
125	SR_PRIV int mso_receive_data(int fd, int revents, void *cb_data);
4b719338	126	SR_PRIV int mso_configure_trigger(struct sr_dev_inst *sdi);
	127	SR_PRIV int mso_configure_threshold_level(struct sr_dev_inst *sdi);
	128	SR_PRIV int mso_read_buffer(struct sr_dev_inst *sdi);
	129	SR_PRIV int mso_arm(struct sr_dev_inst *sdi);
	130	SR_PRIV int mso_force_capture(struct sr_dev_inst *sdi);
	131	SR_PRIV int mso_dac_out(struct sr_dev_inst *sdi, uint16_t val);
4b719338	132	SR_PRIV inline uint16_t mso_calc_raw_from_mv(struct dev_context *devc);
4db2aaff	133	SR_PRIV int mso_reset_fsm(struct sr_dev_inst *sdi);
4db2aaff	134	SR_PRIV int mso_toggle_led(struct sr_dev_inst *sdi, int state);
4b719338	135
5a24e89c	136	SR_PRIV int mso_configure_probes(const struct sr_dev_inst *sdi);
df92e5cf	137	SR_PRIV void stop_acquisition(const struct sr_dev_inst *sdi);
	138
	139	///////////////////////
	140	//
	141
	142	/* serial protocol */
	143	#define mso_trans(a, v) \
	144	(((v) & 0x3f) \| (((v) & 0xc0) << 6) \| (((a) & 0xf) << 8) \| \
	145	((~(v) & 0x20) << 1) \| ((~(v) & 0x80) << 7))
	146
	147	SR_PRIV static const char mso_head[] = { 0x40, 0x4c, 0x44, 0x53, 0x7e };
	148	SR_PRIV static const char mso_foot[] = { 0x7e };
	149
	150	/* bank agnostic registers */
	151	#define REG_CTL2 15
	152
	153	/* bank 0 registers */
	154	#define REG_BUFFER 1
	155	#define REG_TRIGGER 2
	156	#define REG_CLKRATE1 9
	157	#define REG_CLKRATE2 10
	158	#define REG_DAC1 12
	159	#define REG_DAC2 13
	160	/* possibly bank agnostic: */
	161	#define REG_CTL1 14
	162
	163	/* bank 2 registers (SPI/I2C protocol trigger) */
	164	#define REG_PT_WORD(x) (x)
	165	#define REG_PT_MASK(x) (x+4)
	166	#define REG_PT_SPIMODE 8
	167
	168	/* bits - REG_CTL1 */
	169	#define BIT_CTL1_RESETFSM (1 << 0)
	170	#define BIT_CTL1_ARM (1 << 1)
	171	#define BIT_CTL1_ADC_UNKNOWN4 (1 << 4) /* adc enable? */
	172	#define BIT_CTL1_RESETADC (1 << 6)
	173	#define BIT_CTL1_LED (1 << 7)
	174
	175	/* bits - REG_CTL2 */
	176	#define BITS_CTL2_BANK(x) (x & 0x3)
	177	#define BIT_CTL2_SLOWMODE (1 << 5)
	178
	179	struct rate_map {
	180	uint32_t rate;
	181	uint16_t val;
	182	uint8_t slowmode;
	183	};
	184
	185	static struct rate_map rate_map[] = {
	186	{ SR_MHZ(200), 0x0205, 0 },
	187	{ SR_MHZ(100), 0x0105, 0 },
	188	{ SR_MHZ(50), 0x0005, 0 },
	189	{ SR_MHZ(20), 0x0303, 0 },
	190	{ SR_MHZ(10), 0x0308, 0 },
	191	{ SR_MHZ(5), 0x030c, 0 },
	192	{ SR_MHZ(2), 0x0330, 0 },
	193	{ SR_MHZ(1), 0x0362, 0 },
	194	{ SR_KHZ(500), 0x03c6, 0 },
	195	{ SR_KHZ(200), 0x07f2, 0 },
	196	{ SR_KHZ(100), 0x0fe6, 0 },
	197	{ SR_KHZ(50), 0x1fce, 0 },
	198	{ SR_KHZ(20), 0x4f86, 0 },
	199	{ SR_KHZ(10), 0x9f0e, 0 },
	200	{ SR_KHZ(5), 0x03c7, 0x20 },
201	{ SR_KHZ(2), 0x07f3, 0x20 },
202	{ SR_KHZ(1), 0x0fe7, 0x20 },
203	{ 500, 0x1fcf, 0x20 },
204	{ 200, 0x4f87, 0x20 },
205	{ 100, 0x9f0f, 0x20 },
206	};
207
208	/* FIXME: Determine corresponding voltages */
209	static uint16_t la_threshold_map[] = {
210	0x8600,
211	0x8770,
212	0x88ff,
213	0x8c70,
214	0x8eff,
215	0x8fff,
216	};
217
df92e5cf	218	#endif