[libsigrok.git] / src / scpi.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 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/>.
 */

/** @file
  * @internal
  */

#ifndef LIBSIGROK_SCPI_H
#define LIBSIGROK_SCPI_H

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

#define SCPI_CMD_IDN "*IDN?"
#define SCPI_CMD_OPC "*OPC?"

enum {
	SCPI_CMD_GET_TIMEBASE = 1,
	SCPI_CMD_SET_TIMEBASE,
	SCPI_CMD_GET_VERTICAL_SCALE,
	SCPI_CMD_SET_VERTICAL_SCALE,
	SCPI_CMD_GET_TRIGGER_SLOPE,
	SCPI_CMD_SET_TRIGGER_SLOPE,
	SCPI_CMD_GET_TRIGGER_PATTERN,
	SCPI_CMD_SET_TRIGGER_PATTERN,
	SCPI_CMD_GET_TRIGGER_SOURCE,
	SCPI_CMD_SET_TRIGGER_SOURCE,
	SCPI_CMD_GET_COUPLING,
	SCPI_CMD_SET_COUPLING,
	SCPI_CMD_GET_HORIZ_TRIGGERPOS,
	SCPI_CMD_SET_HORIZ_TRIGGERPOS,
	SCPI_CMD_GET_ANALOG_CHAN_STATE,
	SCPI_CMD_SET_ANALOG_CHAN_STATE,
	SCPI_CMD_GET_DIG_CHAN_STATE,
	SCPI_CMD_SET_DIG_CHAN_STATE,
	SCPI_CMD_GET_VERTICAL_OFFSET,
	SCPI_CMD_GET_DIG_POD_STATE,
	SCPI_CMD_SET_DIG_POD_STATE,
	SCPI_CMD_GET_ANALOG_DATA,
	SCPI_CMD_GET_DIG_DATA,
	SCPI_CMD_GET_SAMPLE_RATE,
	SCPI_CMD_GET_PROBE_UNIT,
	SCPI_CMD_GET_DIG_POD_THRESHOLD,
	SCPI_CMD_SET_DIG_POD_THRESHOLD,
	SCPI_CMD_GET_DIG_POD_USER_THRESHOLD,
	SCPI_CMD_SET_DIG_POD_USER_THRESHOLD,
};

enum scpi_transport_layer {
	SCPI_TRANSPORT_LIBGPIB,
	SCPI_TRANSPORT_SERIAL,
	SCPI_TRANSPORT_RAW_TCP,
	SCPI_TRANSPORT_RIGOL_TCP,
	SCPI_TRANSPORT_USBTMC,
	SCPI_TRANSPORT_VISA,
	SCPI_TRANSPORT_VXI,
};

struct scpi_command {
	int command;
	const char *string;
};

struct sr_scpi_hw_info {
	char *manufacturer;
	char *model;
	char *serial_number;
	char *firmware_version;
};

struct sr_scpi_dev_inst {
	const char *name;
	const char *prefix;
	enum scpi_transport_layer transport;
	int priv_size;
	GSList *(*scan)(struct drv_context *drvc);
	int (*dev_inst_new)(void *priv, struct drv_context *drvc,
		const char *resource, char **params, const char *serialcomm);
	int (*open)(struct sr_scpi_dev_inst *scpi);
	int (*connection_id)(struct sr_scpi_dev_inst *scpi, char **connection_id);
	int (*source_add)(struct sr_session *session, void *priv, int events,
		int timeout, sr_receive_data_callback cb, void *cb_data);
	int (*source_remove)(struct sr_session *session, void *priv);
	int (*send)(void *priv, const char *command);
	int (*read_begin)(void *priv);
	int (*read_data)(void *priv, char *buf, int maxlen);
	int (*write_data)(void *priv, char *buf, int len);
	int (*read_complete)(void *priv);
	int (*close)(struct sr_scpi_dev_inst *scpi);
	void (*free)(void *priv);
	unsigned int read_timeout_us;
	void *priv;
	/* Only used for quirk workarounds, notably the Rigol DS1000 series. */
	uint64_t firmware_version;
	GMutex scpi_mutex;
	char *actual_channel_name;
};

SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options,
		struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi));
SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc,
		const char *resource, const char *serialcomm);
SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
		char **connection_id);
SR_PRIV int sr_scpi_source_add(struct sr_session *session,
		struct sr_scpi_dev_inst *scpi, int events, int timeout,
		sr_receive_data_callback cb, void *cb_data);
SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
		struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
		const char *format, ...);
SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
		const char *format, va_list args);
SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst *scpi, char *buf, int len);
SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);

SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
			GString *response, gint64 abs_timeout_us);
SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
			const char *command, char **scpi_response);
SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
			const char *command, gboolean *scpi_response);
SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
			const char *command, int *scpi_response);
SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
			const char *command, float *scpi_response);
SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
			const char *command, double *scpi_response);
SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
			const char *command, GArray **scpi_response);
SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
			const char *command, GArray **scpi_response);
SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
			const char *command, GString **scpi_response);
SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
			const char *command, GByteArray **scpi_response);
SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
			struct sr_scpi_hw_info **scpi_response);
SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);

SR_PRIV const char *sr_scpi_unquote_string(char *s);

SR_PRIV const char *sr_vendor_alias(const char *raw_vendor);
SR_PRIV const char *sr_scpi_cmd_get(const struct scpi_command *cmdtable,
		int command);
SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
		const struct scpi_command *cmdtable,
		int channel_command, const char *channel_name,
		int command, ...);
SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
		const struct scpi_command *cmdtable,
		int channel_command, const char *channel_name,
		GVariant **gvar, const GVariantType *gvtype, int command, ...);

/*--- GPIB only functions ---------------------------------------------------*/

#ifdef HAVE_LIBGPIB
SR_PRIV int sr_scpi_gpib_spoll(struct sr_scpi_dev_inst *scpi, char *buf);
#endif

#endif
Commit	Line	Data
5a1afc09 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 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	/** @file
	21	* @internal
	22	*/
	23
	24	#ifndef LIBSIGROK_SCPI_H
	25	#define LIBSIGROK_SCPI_H
	26
	27	#include <stdint.h>
	28	#include <glib.h>
	29	#include <libsigrok/libsigrok.h>
	30	#include "libsigrok-internal.h"
	31
	32	#define SCPI_CMD_IDN "*IDN?"
	33	#define SCPI_CMD_OPC "*OPC?"
	34
	35	enum {
a9f3fa05	36	SCPI_CMD_GET_TIMEBASE = 1,
5a1afc09	37	SCPI_CMD_SET_TIMEBASE,
66ddc22a GT	38	SCPI_CMD_GET_VERTICAL_SCALE,
66ddc22a GT	39	SCPI_CMD_SET_VERTICAL_SCALE,
a9f3fa05	40	SCPI_CMD_GET_TRIGGER_SLOPE,
5a1afc09	41	SCPI_CMD_SET_TRIGGER_SLOPE,
4fa4db2c GT	42	SCPI_CMD_GET_TRIGGER_PATTERN,
4fa4db2c GT	43	SCPI_CMD_SET_TRIGGER_PATTERN,
a9f3fa05 GT	44	SCPI_CMD_GET_TRIGGER_SOURCE,
	45	SCPI_CMD_SET_TRIGGER_SOURCE,
	46	SCPI_CMD_GET_COUPLING,
5a1afc09	47	SCPI_CMD_SET_COUPLING,
a9f3fa05	48	SCPI_CMD_GET_HORIZ_TRIGGERPOS,
5a1afc09 BV	49	SCPI_CMD_SET_HORIZ_TRIGGERPOS,
5a1afc09 BV	50	SCPI_CMD_GET_ANALOG_CHAN_STATE,
5a1afc09	51	SCPI_CMD_SET_ANALOG_CHAN_STATE,
a9f3fa05	52	SCPI_CMD_GET_DIG_CHAN_STATE,
5a1afc09	53	SCPI_CMD_SET_DIG_CHAN_STATE,
a9f3fa05	54	SCPI_CMD_GET_VERTICAL_OFFSET,
5a1afc09 BV	55	SCPI_CMD_GET_DIG_POD_STATE,
	56	SCPI_CMD_SET_DIG_POD_STATE,
	57	SCPI_CMD_GET_ANALOG_DATA,
	58	SCPI_CMD_GET_DIG_DATA,
	59	SCPI_CMD_GET_SAMPLE_RATE,
2d7da5df	60	SCPI_CMD_GET_PROBE_UNIT,
e131be0a GT	61	SCPI_CMD_GET_DIG_POD_THRESHOLD,
	62	SCPI_CMD_SET_DIG_POD_THRESHOLD,
	63	SCPI_CMD_GET_DIG_POD_USER_THRESHOLD,
	64	SCPI_CMD_SET_DIG_POD_USER_THRESHOLD,
5a1afc09 BV	65	};
5a1afc09 BV	66
87aa1e63 FS	67	enum scpi_transport_layer {
	68	SCPI_TRANSPORT_LIBGPIB,
	69	SCPI_TRANSPORT_SERIAL,
	70	SCPI_TRANSPORT_RAW_TCP,
	71	SCPI_TRANSPORT_RIGOL_TCP,
	72	SCPI_TRANSPORT_USBTMC,
	73	SCPI_TRANSPORT_VISA,
	74	SCPI_TRANSPORT_VXI,
	75	};
	76
91ef511d BV	77	struct scpi_command {
	78	int command;
	79	const char *string;
	80	};
	81
5a1afc09 BV	82	struct sr_scpi_hw_info {
	83	char *manufacturer;
	84	char *model;
	85	char *serial_number;
	86	char *firmware_version;
	87	};
	88
	89	struct sr_scpi_dev_inst {
	90	const char *name;
	91	const char *prefix;
87aa1e63	92	enum scpi_transport_layer transport;
5a1afc09 BV	93	int priv_size;
	94	GSList (scan)(struct drv_context *drvc);
	95	int (dev_inst_new)(void priv, struct drv_context *drvc,
	96	const char resource, char params, const char serialcomm);
04229f7b	97	int (open)(struct sr_scpi_dev_inst scpi);
8107a9a6	98	int (connection_id)(struct sr_scpi_dev_inst scpi, char **connection_id);
5a1afc09 BV	99	int (source_add)(struct sr_session session, void *priv, int events,
	100	int timeout, sr_receive_data_callback cb, void *cb_data);
	101	int (source_remove)(struct sr_session session, void *priv);
	102	int (send)(void priv, const char *command);
	103	int (read_begin)(void priv);
	104	int (read_data)(void priv, char *buf, int maxlen);
b6be55ce	105	int (write_data)(void priv, char *buf, int len);
5a1afc09	106	int (read_complete)(void priv);
04229f7b	107	int (close)(struct sr_scpi_dev_inst scpi);
5a1afc09	108	void (free)(void priv);
37ef582d	109	unsigned int read_timeout_us;
5a1afc09	110	void *priv;
de285cce BV	111	/* Only used for quirk workarounds, notably the Rigol DS1000 series. */
de285cce BV	112	uint64_t firmware_version;
fd20e59c	113	GMutex scpi_mutex;
3d118722	114	char *actual_channel_name;
5a1afc09 BV	115	};
	116
	117	SR_PRIV GSList sr_scpi_scan(struct drv_context drvc, GSList *options,
	118	struct sr_dev_inst (probe_device)(struct sr_scpi_dev_inst *scpi));
	119	SR_PRIV struct sr_scpi_dev_inst scpi_dev_inst_new(struct drv_context drvc,
	120	const char resource, const char serialcomm);
	121	SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
8107a9a6 FS	122	SR_PRIV int sr_scpi_connection_id(struct sr_scpi_dev_inst *scpi,
8107a9a6 FS	123	char **connection_id);
5a1afc09 BV	124	SR_PRIV int sr_scpi_source_add(struct sr_session *session,
	125	struct sr_scpi_dev_inst *scpi, int events, int timeout,
	126	sr_receive_data_callback cb, void *cb_data);
	127	SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
	128	struct sr_scpi_dev_inst *scpi);
	129	SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
	130	const char *format, ...);
	131	SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
	132	const char *format, va_list args);
	133	SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
	134	SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst scpi, char buf, int maxlen);
b6be55ce	135	SR_PRIV int sr_scpi_write_data(struct sr_scpi_dev_inst scpi, char buf, int len);
5a1afc09 BV	136	SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
	137	SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
	138	SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
	139
d64be25b SB	140	SR_PRIV int sr_scpi_read_response(struct sr_scpi_dev_inst *scpi,
d64be25b SB	141	GString *response, gint64 abs_timeout_us);
5a1afc09 BV	142	SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
	143	const char command, char *scpi_response);
	144	SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
	145	const char command, gboolean scpi_response);
	146	SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
	147	const char command, int scpi_response);
	148	SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
	149	const char command, float scpi_response);
	150	SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
	151	const char command, double scpi_response);
	152	SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
	153	SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
	154	const char command, GArray *scpi_response);
	155	SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
	156	const char command, GArray *scpi_response);
ff01b0ea SB	157	SR_PRIV int sr_scpi_get_data(struct sr_scpi_dev_inst *scpi,
	158	const char command, GString *scpi_response);
	159	SR_PRIV int sr_scpi_get_block(struct sr_scpi_dev_inst *scpi,
	160	const char command, GByteArray *scpi_response);
5a1afc09 BV	161	SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
	162	struct sr_scpi_hw_info **scpi_response);
	163	SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
	164
a019bc48 GS	165	SR_PRIV const char sr_scpi_unquote_string(char s);
a019bc48 GS	166
91ef511d	167	SR_PRIV const char sr_vendor_alias(const char raw_vendor);
17a82e83 FS	168	SR_PRIV const char sr_scpi_cmd_get(const struct scpi_command cmdtable,
17a82e83 FS	169	int command);
fd20e59c	170	SR_PRIV int sr_scpi_cmd(const struct sr_dev_inst *sdi,
17a82e83 FS	171	const struct scpi_command *cmdtable,
	172	int channel_command, const char *channel_name,
	173	int command, ...);
fd20e59c	174	SR_PRIV int sr_scpi_cmd_resp(const struct sr_dev_inst *sdi,
91ef511d	175	const struct scpi_command *cmdtable,
17a82e83	176	int channel_command, const char *channel_name,
91ef511d BV	177	GVariant *gvar, const GVariantType gvtype, int command, ...);
91ef511d BV	178
02d4db35 FS	179	/--- GPIB only functions ---------------------------------------------------/
	180
	181	#ifdef HAVE_LIBGPIB
	182	SR_PRIV int sr_scpi_gpib_spoll(struct sr_scpi_dev_inst scpi, char buf);
	183	#endif
	184
5a1afc09	185	#endif