[libsigrok.git] / hardware / rigol-ds / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
 * Copyright (C) 2013 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_RIGOL_DS_PROTOCOL_H
#define LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H

#include <stdint.h>
#include <stdbool.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"

#define LOG_PREFIX "rigol-ds"

#define DS1000_ANALOG_LIVE_WAVEFORM_SIZE 600
#define DS2000_ANALOG_LIVE_WAVEFORM_SIZE 1400
#define VS5000_ANALOG_LIVE_WAVEFORM_SIZE 2048
#define DSO1000_ANALOG_LIVE_WAVEFORM_SIZE 600
/* Needs to be made configurable later */
#define DS2000_ANALOG_MEM_WAVEFORM_SIZE_1C 14000
#define DS2000_ANALOG_MEM_WAVEFORM_SIZE_2C 7000
#define DIGITAL_WAVEFORM_SIZE 1210
/* Size of acquisition buffers */
#define ACQ_BUFFER_SIZE 32768

#define MAX_ANALOG_PROBES 4
#define MAX_DIGITAL_PROBES 16

enum rigol_ds_series {
	RIGOL_DS1000,
	RIGOL_DS1000Z,
	RIGOL_DS2000,
	RIGOL_DS4000,
	RIGOL_DS6000,
	RIGOL_VS5000,
	AGILENT_DSO1000,
};

enum rigol_protocol_flavor {
	/* Used by DS1000 and VS5000 series */
	PROTOCOL_LEGACY,
	/* Used by DS2000, DS4000, DS6000, ... series */
	PROTOCOL_IEEE488_2,
};

enum data_source {
	DATA_SOURCE_LIVE,
	DATA_SOURCE_MEMORY,
	DATA_SOURCE_SEGMENTED,
};

struct rigol_ds_model {
	char *vendor;
	char *name;
	enum rigol_ds_series series;
	enum rigol_protocol_flavor protocol;
	uint64_t min_timebase[2];
	uint64_t max_timebase[2];
	uint64_t min_vdiv[2];
	unsigned int analog_channels;
	bool has_digital;
	int num_horizontal_divs;
};

enum wait_events {
	WAIT_NONE,    /* Don't wait */
	WAIT_TRIGGER, /* Wait for trigger (only live capture) */
	WAIT_BLOCK,   /* Wait for block data (only when reading sample mem) */
	WAIT_STOP,    /* Wait for scope stopping (only single shots) */
};

/** Private, per-device-instance driver context. */
struct dev_context {
	/* Device model */
	const struct rigol_ds_model *model;

	/* Device properties */
	const uint64_t (*timebases)[2];
	uint64_t num_timebases;
	const uint64_t (*vdivs)[2];
	uint64_t num_vdivs;

	/* Probe groups */
	struct sr_probe_group analog_groups[MAX_ANALOG_PROBES];
	struct sr_probe_group digital_group;

	/* Acquisition settings */
	GSList *enabled_analog_probes;
	GSList *enabled_digital_probes;
	uint64_t limit_frames;
	void *cb_data;
	enum data_source data_source;
	uint64_t analog_frame_size;

	/* Device settings */
	gboolean analog_channels[MAX_ANALOG_PROBES];
	gboolean digital_channels[MAX_DIGITAL_PROBES];
	float timebase;
	float vdiv[MAX_ANALOG_PROBES];
	int vert_reference[MAX_ANALOG_PROBES];
	float vert_offset[MAX_ANALOG_PROBES];
	char *trigger_source;
	float horiz_triggerpos;
	char *trigger_slope;
	char *coupling[MAX_ANALOG_PROBES];

	/* Operational state */

	/* Number of frames received in total. */
	uint64_t num_frames;
	/* GSList entry for the current channel. */
	GSList *channel_entry;
	/* Number of samples received in current frame. */
	uint64_t num_frame_samples;
	/* Number of bytes in current data block, if 0 block header expected */
	uint64_t num_block_bytes;
	/* Number of data block bytes already read */
	uint64_t num_block_read;
	/* What to wait for in *_receive */
	enum wait_events wait_event;
	/* Trigger/block copying/stop waiting status */
	int wait_status;
	/* Acq buffers used for reading from the scope and sending data to app */
	unsigned char *buffer;
	float *data;
};

SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi);
SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi);
SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data);
SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi);

#endif
Commit	Line	Data
f4816ac6 ML	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 Martin Ling <martin-git@earth.li>
88e429c9	5	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
f4816ac6 ML	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
3086efdd ML	21	#ifndef LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H
3086efdd ML	22	#define LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H
f4816ac6 ML	23
f4816ac6 ML	24	#include <stdint.h>
bafd4890	25	#include <stdbool.h>
f4816ac6 ML	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28
3544f848	29	#define LOG_PREFIX "rigol-ds"
f4816ac6	30
babab622 ML	31	#define DS1000_ANALOG_LIVE_WAVEFORM_SIZE 600
babab622 ML	32	#define DS2000_ANALOG_LIVE_WAVEFORM_SIZE 1400
962af1a3	33	#define VS5000_ANALOG_LIVE_WAVEFORM_SIZE 2048
0d9f5a12	34	#define DSO1000_ANALOG_LIVE_WAVEFORM_SIZE 600
babab622 ML	35	/* Needs to be made configurable later */
	36	#define DS2000_ANALOG_MEM_WAVEFORM_SIZE_1C 14000
	37	#define DS2000_ANALOG_MEM_WAVEFORM_SIZE_2C 7000
6bb192bc	38	#define DIGITAL_WAVEFORM_SIZE 1210
babab622 ML	39	/* Size of acquisition buffers */
	40	#define ACQ_BUFFER_SIZE 32768
	41
821fbcad ML	42	#define MAX_ANALOG_PROBES 4
	43	#define MAX_DIGITAL_PROBES 16
	44
babab622 ML	45	enum rigol_ds_series {
	46	RIGOL_DS1000,
	47	RIGOL_DS1000Z,
	48	RIGOL_DS2000,
	49	RIGOL_DS4000,
	50	RIGOL_DS6000,
962af1a3	51	RIGOL_VS5000,
10afee13	52	AGILENT_DSO1000,
babab622 ML	53	};
	54
	55	enum rigol_protocol_flavor {
962af1a3	56	/* Used by DS1000 and VS5000 series */
babab622 ML	57	PROTOCOL_LEGACY,
	58	/* Used by DS2000, DS4000, DS6000, ... series */
	59	PROTOCOL_IEEE488_2,
	60	};
	61
	62	enum data_source {
	63	DATA_SOURCE_LIVE,
	64	DATA_SOURCE_MEMORY,
	65	DATA_SOURCE_SEGMENTED,
	66	};
e0b7d23c	67
bafd4890	68	struct rigol_ds_model {
10afee13	69	char *vendor;
bafd4890	70	char *name;
babab622 ML	71	enum rigol_ds_series series;
babab622 ML	72	enum rigol_protocol_flavor protocol;
bafd4890 ML	73	uint64_t min_timebase[2];
	74	uint64_t max_timebase[2];
	75	uint64_t min_vdiv[2];
821fbcad	76	unsigned int analog_channels;
bafd4890	77	bool has_digital;
babab622 ML	78	int num_horizontal_divs;
	79	};
	80
	81	enum wait_events {
	82	WAIT_NONE, /* Don't wait */
	83	WAIT_TRIGGER, /* Wait for trigger (only live capture) */
	84	WAIT_BLOCK, /* Wait for block data (only when reading sample mem) */
	85	WAIT_STOP, /* Wait for scope stopping (only single shots) */
bafd4890 ML	86	};
bafd4890 ML	87
f4816ac6 ML	88	/** Private, per-device-instance driver context. */
f4816ac6 ML	89	struct dev_context {
bafd4890 ML	90	/* Device model */
	91	const struct rigol_ds_model *model;
	92
	93	/* Device properties */
	94	const uint64_t (*timebases)[2];
	95	uint64_t num_timebases;
	96	const uint64_t (*vdivs)[2];
	97	uint64_t num_vdivs;
6bb192bc	98
3d3a601e	99	/* Probe groups */
821fbcad	100	struct sr_probe_group analog_groups[MAX_ANALOG_PROBES];
3d3a601e ML	101	struct sr_probe_group digital_group;
3d3a601e ML	102
254dd102	103	/* Acquisition settings */
6bb192bc ML	104	GSList *enabled_analog_probes;
6bb192bc ML	105	GSList *enabled_digital_probes;
e0b7d23c	106	uint64_t limit_frames;
f4816ac6	107	void *cb_data;
babab622 ML	108	enum data_source data_source;
babab622 ML	109	uint64_t analog_frame_size;
f4816ac6	110
254dd102	111	/* Device settings */
821fbcad ML	112	gboolean analog_channels[MAX_ANALOG_PROBES];
821fbcad ML	113	gboolean digital_channels[MAX_DIGITAL_PROBES];
254dd102	114	float timebase;
821fbcad ML	115	float vdiv[MAX_ANALOG_PROBES];
	116	int vert_reference[MAX_ANALOG_PROBES];
	117	float vert_offset[MAX_ANALOG_PROBES];
254dd102 BV	118	char *trigger_source;
	119	float horiz_triggerpos;
	120	char *trigger_slope;
821fbcad	121	char *coupling[MAX_ANALOG_PROBES];
254dd102 BV	122
254dd102 BV	123	/* Operational state */
0d87bd93 ML	124
0d87bd93 ML	125	/* Number of frames received in total. */
254dd102	126	uint64_t num_frames;
821fbcad ML	127	/* GSList entry for the current channel. */
821fbcad ML	128	GSList *channel_entry;
0d87bd93 ML	129	/* Number of samples received in current frame. */
0d87bd93 ML	130	uint64_t num_frame_samples;
bafd4890 ML	131	/* Number of bytes in current data block, if 0 block header expected */
	132	uint64_t num_block_bytes;
	133	/* Number of data block bytes already read */
	134	uint64_t num_block_read;
babab622 ML	135	/* What to wait for in _receive /
	136	enum wait_events wait_event;
	137	/* Trigger/block copying/stop waiting status */
	138	int wait_status;
	139	/* Acq buffers used for reading from the scope and sending data to app */
	140	unsigned char *buffer;
	141	float *data;
f4816ac6 ML	142	};
f4816ac6 ML	143
babab622	144	SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi);
677f85d0	145	SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi);
3086efdd	146	SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data);
3086efdd	147	SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi);
e0b7d23c	148
f4816ac6	149	#endif