[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 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)(void *priv);
	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)(void *priv);
	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);

#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
	61	struct sr_scpi_hw_info {
	62	char *manufacturer;
	63	char *model;
	64	char *serial_number;
65	char *firmware_version;
66	};
67
68	struct sr_scpi_dev_inst {
69	const char *name;
70	const char *prefix;
71	int priv_size;
72	GSList (scan)(struct drv_context *drvc);
73	int (dev_inst_new)(void priv, struct drv_context *drvc,
74	const char resource, char params, const char serialcomm);
75	int (open)(void priv);
76	int (source_add)(struct sr_session session, void *priv, int events,
77	int timeout, sr_receive_data_callback cb, void *cb_data);
78	int (source_remove)(struct sr_session session, void *priv);
79	int (send)(void priv, const char *command);
80	int (read_begin)(void priv);
81	int (read_data)(void priv, char *buf, int maxlen);
82	int (read_complete)(void priv);
83	int (close)(void priv);
84	void (free)(void priv);
85	unsigned int read_timeout_ms;
86	void *priv;
87	};
88
89	SR_PRIV GSList sr_scpi_scan(struct drv_context drvc, GSList *options,
90	struct sr_dev_inst (probe_device)(struct sr_scpi_dev_inst *scpi));
91	SR_PRIV struct sr_scpi_dev_inst scpi_dev_inst_new(struct drv_context drvc,
92	const char resource, const char serialcomm);
93	SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
94	SR_PRIV int sr_scpi_source_add(struct sr_session *session,
95	struct sr_scpi_dev_inst *scpi, int events, int timeout,
96	sr_receive_data_callback cb, void *cb_data);
97	SR_PRIV int sr_scpi_source_remove(struct sr_session *session,
98	struct sr_scpi_dev_inst *scpi);
99	SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
100	const char *format, ...);
101	SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
102	const char *format, va_list args);
103	SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi);
104	SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst scpi, char buf, int maxlen);
105	SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi);
106	SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
107	SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
108
109	SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
110	const char command, char *scpi_response);
111	SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
112	const char command, gboolean scpi_response);
113	SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
114	const char command, int scpi_response);
115	SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
116	const char command, float scpi_response);
117	SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
118	const char command, double scpi_response);
119	SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
120	SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
121	const char command, GArray *scpi_response);
122	SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
123	const char command, GArray *scpi_response);
124	SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
125	struct sr_scpi_hw_info **scpi_response);
126	SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
127
128	#endif