[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_SET_TRIGGER_SOURCE = 1,
	SCPI_CMD_SET_TIMEBASE,
	SCPI_CMD_SET_VERTICAL_DIV,
	SCPI_CMD_SET_TRIGGER_SLOPE,
	SCPI_CMD_SET_COUPLING,
	SCPI_CMD_SET_HORIZ_TRIGGERPOS,
	SCPI_CMD_GET_ANALOG_CHAN_STATE,
	SCPI_CMD_GET_DIG_CHAN_STATE,
	SCPI_CMD_GET_TIMEBASE,
	SCPI_CMD_GET_VERTICAL_DIV,
	SCPI_CMD_GET_VERTICAL_OFFSET,
	SCPI_CMD_GET_TRIGGER_SOURCE,
	SCPI_CMD_GET_HORIZ_TRIGGERPOS,
	SCPI_CMD_GET_TRIGGER_SLOPE,
	SCPI_CMD_GET_COUPLING,
	SCPI_CMD_SET_ANALOG_CHAN_STATE,
	SCPI_CMD_SET_DIG_CHAN_STATE,
	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_SAMPLE_RATE_LIVE,
};

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;
	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 (*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 (*read_complete)(void *priv);
	int (*close)(struct sr_scpi_dev_inst *scpi);
	void (*free)(void *priv);
	unsigned int read_timeout_ms;
	void *priv;
};

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_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_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_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_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_vendor_alias(const char *raw_vendor);
SR_PRIV const char *scpi_cmd_get(const struct scpi_command *cmdtable, int command);
SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi,
		const struct scpi_command *cmdtable, int command, ...);
SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi,
		const struct scpi_command *cmdtable,
		GVariant **gvar, const GVariantType *gvtype, int command, ...);

#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 {
	36	SCPI_CMD_SET_TRIGGER_SOURCE = 1,
	37	SCPI_CMD_SET_TIMEBASE,
	38	SCPI_CMD_SET_VERTICAL_DIV,
	39	SCPI_CMD_SET_TRIGGER_SLOPE,
	40	SCPI_CMD_SET_COUPLING,
	41	SCPI_CMD_SET_HORIZ_TRIGGERPOS,
	42	SCPI_CMD_GET_ANALOG_CHAN_STATE,
	43	SCPI_CMD_GET_DIG_CHAN_STATE,
	44	SCPI_CMD_GET_TIMEBASE,
	45	SCPI_CMD_GET_VERTICAL_DIV,
	46	SCPI_CMD_GET_VERTICAL_OFFSET,
	47	SCPI_CMD_GET_TRIGGER_SOURCE,
	48	SCPI_CMD_GET_HORIZ_TRIGGERPOS,
	49	SCPI_CMD_GET_TRIGGER_SLOPE,
	50	SCPI_CMD_GET_COUPLING,
	51	SCPI_CMD_SET_ANALOG_CHAN_STATE,
	52	SCPI_CMD_SET_DIG_CHAN_STATE,
	53	SCPI_CMD_GET_DIG_POD_STATE,
	54	SCPI_CMD_SET_DIG_POD_STATE,
	55	SCPI_CMD_GET_ANALOG_DATA,
	56	SCPI_CMD_GET_DIG_DATA,
	57	SCPI_CMD_GET_SAMPLE_RATE,
	58	SCPI_CMD_GET_SAMPLE_RATE_LIVE,
	59	};
	60
91ef511d BV	61	struct scpi_command {
	62	int command;
	63	const char *string;
	64	};
	65
5a1afc09 BV	66	struct sr_scpi_hw_info {
	67	char *manufacturer;
	68	char *model;
	69	char *serial_number;
	70	char *firmware_version;
	71	};
	72
	73	struct sr_scpi_dev_inst {
	74	const char *name;
	75	const char *prefix;
	76	int priv_size;
	77	GSList (scan)(struct drv_context *drvc);
	78	int (dev_inst_new)(void priv, struct drv_context *drvc,
	79	const char resource, char params, const char serialcomm);
04229f7b	80	int (open)(struct sr_scpi_dev_inst scpi);
5a1afc09 BV	81	int (source_add)(struct sr_session session, void *priv, int events,
	82	int timeout, sr_receive_data_callback cb, void *cb_data);
	83	int (source_remove)(struct sr_session session, void *priv);
	84	int (send)(void priv, const char *command);
	85	int (read_begin)(void priv);
	86	int (read_data)(void priv, char *buf, int maxlen);
	87	int (read_complete)(void priv);
04229f7b	88	int (close)(struct sr_scpi_dev_inst scpi);
5a1afc09 BV	89	void (free)(void priv);
	90	unsigned int read_timeout_ms;
	91	void *priv;
	92	};
	93
	94	SR_PRIV GSList sr_scpi_scan(struct drv_context drvc, GSList *options,
	95	struct sr_dev_inst (probe_device)(struct sr_scpi_dev_inst *scpi));
	96	SR_PRIV struct sr_scpi_dev_inst scpi_dev_inst_new(struct drv_context drvc,
	97	const char resource, const char serialcomm);
	98	SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
	99	SR_PRIV int sr_scpi_source_add(struct sr_session *session,
	100	struct sr_scpi_dev_inst *scpi, int events, int timeout,
	101	sr_receive_data_callback cb, void *cb_data);
	102	SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
	103	struct sr_scpi_dev_inst *scpi);
	104	SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
	105	const char *format, ...);
	106	SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
	107	const char *format, va_list args);
	108	SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
	109	SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst scpi, char buf, int maxlen);
	110	SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
	111	SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
	112	SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
	113
	114	SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
	115	const char command, char *scpi_response);
	116	SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
	117	const char command, gboolean scpi_response);
	118	SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
	119	const char command, int scpi_response);
	120	SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
	121	const char command, float scpi_response);
	122	SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
	123	const char command, double scpi_response);
	124	SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
	125	SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
	126	const char command, GArray *scpi_response);
	127	SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
	128	const char command, GArray *scpi_response);
	129	SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
	130	struct sr_scpi_hw_info **scpi_response);
	131	SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
	132
91ef511d BV	133	SR_PRIV const char sr_vendor_alias(const char raw_vendor);
	134	SR_PRIV const char scpi_cmd_get(const struct scpi_command cmdtable, int command);
	135	SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi,
	136	const struct scpi_command *cmdtable, int command, ...);
	137	SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi,
	138	const struct scpi_command *cmdtable,
	139	GVariant *gvar, const GVariantType gvtype, int command, ...);
	140
5a1afc09	141	#endif