[libsigrok.git] / libsigrok-internal.h

/*
 * This file is part of the libsigrok project.
 *
 * 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_SIGROK_INTERNAL_H
#define LIBSIGROK_SIGROK_INTERNAL_H

#include <stdarg.h>
#include <glib.h>
#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
#ifdef HAVE_LIBUSB_1_0
#include <libusb.h>
#endif
#ifdef HAVE_LIBSERIALPORT
#include <libserialport.h>
#endif

/**
 * @file
 *
 * libsigrok private header file, only to be used internally.
 */

/*--- Macros ----------------------------------------------------------------*/

#ifndef ARRAY_SIZE
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
#endif

#ifndef ARRAY_AND_SIZE
#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
#endif

/* Portability fixes for FreeBSD. */
#ifdef __FreeBSD__
#define LIBUSB_CLASS_APPLICATION 0xfe
#define libusb_handle_events_timeout_completed(ctx, tv, c) \
	libusb_handle_events_timeout(ctx, tv)
#endif

struct sr_context {
#ifdef HAVE_LIBUSB_1_0
	libusb_context *libusb_ctx;
#endif
};

#ifdef HAVE_LIBUSB_1_0
struct sr_usb_dev_inst {
	uint8_t bus;
	uint8_t address;
	struct libusb_device_handle *devhdl;
};
#endif

#ifdef HAVE_LIBSERIALPORT
#define SERIAL_PARITY_NONE SP_PARITY_NONE
#define SERIAL_PARITY_EVEN SP_PARITY_EVEN
#define SERIAL_PARITY_ODD  SP_PARITY_ODD
struct sr_serial_dev_inst {
	char *port;
	char *serialcomm;
	int fd;
	int nonblocking;
	struct sp_port *data;
};
#endif

struct sr_usbtmc_dev_inst {
	char *device;
	int fd;
};

/* Private driver context. */
struct drv_context {
	struct sr_context *sr_ctx;
	GSList *instances;
};

/*--- log.c -----------------------------------------------------------------*/

SR_PRIV int sr_log(int loglevel, const char *format, ...);
SR_PRIV int sr_spew(const char *format, ...);
SR_PRIV int sr_dbg(const char *format, ...);
SR_PRIV int sr_info(const char *format, ...);
SR_PRIV int sr_warn(const char *format, ...);
SR_PRIV int sr_err(const char *format, ...);

/*--- device.c --------------------------------------------------------------*/

SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
		gboolean enabled, const char *name);

/* Generic device instances */
SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
		const char *vendor, const char *model, const char *version);
SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);

#ifdef HAVE_LIBUSB_1_0
/* USB-specific instances */
SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
		uint8_t address, struct libusb_device_handle *hdl);
SR_PRIV GSList *sr_usb_find_usbtmc(libusb_context *usb_ctx);
SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
#endif

#ifdef HAVE_LIBSERIALPORT
/* Serial-specific instances */
SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
		const char *serialcomm);
SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
#endif

/* USBTMC-specific instances */
SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);

/*--- hwdriver.c ------------------------------------------------------------*/

SR_PRIV void sr_hw_cleanup_all(void);
SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data);
SR_PRIV void sr_config_free(struct sr_config *src);
SR_PRIV int sr_source_remove(int fd);
SR_PRIV int sr_source_add(int fd, int events, int timeout,
		sr_receive_data_callback_t cb, void *cb_data);

/*--- session.c -------------------------------------------------------------*/

struct sr_session {
	/** List of struct sr_dev pointers. */
	GSList *devs;
	/** List of struct datafeed_callback pointers. */
	GSList *datafeed_callbacks;
	GTimeVal starttime;
	gboolean running;

	unsigned int num_sources;

	/*
	 * Both "sources" and "pollfds" are of the same size and contain pairs
	 * of descriptor and callback function. We can not embed the GPollFD
	 * into the source struct since we want to be able to pass the array
	 * of all poll descriptors to g_poll().
	 */
	struct source *sources;
	GPollFD *pollfds;
	int source_timeout;

	/*
	 * These are our synchronization primitives for stopping the session in
	 * an async fashion. We need to make sure the session is stopped from
	 * within the session thread itself.
	 */
	GMutex stop_mutex;
	gboolean abort_session;
};

SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
		const struct sr_datafeed_packet *packet);
SR_PRIV int sr_session_stop_sync(void);
SR_PRIV int sr_sessionfile_check(const char *filename);

/*--- std.c -----------------------------------------------------------------*/

typedef int (*dev_close_t)(struct sr_dev_inst *sdi);
typedef void (*std_dev_clear_t)(void *priv);

SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
		const char *prefix);
#ifdef HAVE_LIBSERIALPORT
SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
		void *cb_data, dev_close_t dev_close_fn,
		struct sr_serial_dev_inst *serial, const char *prefix);
#endif
SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
		const char *prefix);
SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
		std_dev_clear_t clear_private);

/*--- hardware/common/serial.c ----------------------------------------------*/

#ifdef HAVE_LIBSERIALPORT
enum {
	SERIAL_RDWR = 1,
	SERIAL_RDONLY = 2,
	SERIAL_NONBLOCK = 4,
};

typedef gboolean (*packet_valid_t)(const uint8_t *buf);

SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
		const void *buf, size_t count);
SR_PRIV int serial_read(struct sr_serial_dev_inst *serial, void *buf,
		size_t count);
SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
		int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
		const char *paramstr);
SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
		int *buflen, gint64 timeout_ms);
SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
				 uint8_t *buf, size_t *buflen,
				 size_t packet_size, packet_valid_t is_valid,
				 uint64_t timeout_ms, int baudrate);
#endif

/*--- hardware/common/ezusb.c -----------------------------------------------*/

#ifdef HAVE_LIBUSB_1_0
SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
				   const char *filename);
SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
				  const char *filename);
#endif

/*--- hardware/common/usb.c -------------------------------------------------*/

#ifdef HAVE_LIBUSB_1_0
SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
#endif

/*--- hardware/common/scpi.c ------------------------------------------------*/

#ifdef HAVE_LIBSERIALPORT

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

enum {
	SCPI_CMD_SET_TRIGGER_SOURCE,
	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,
};

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

SR_PRIV int sr_scpi_send(struct sr_serial_dev_inst *serial,
			 const char *command);
SR_PRIV int sr_scpi_get_string(struct sr_serial_dev_inst *serial,
			       const char *command, char **scpi_response);
SR_PRIV int sr_scpi_get_bool(struct sr_serial_dev_inst *serial,
			     const char *command, gboolean *scpi_response);
SR_PRIV int sr_scpi_get_int(struct sr_serial_dev_inst *serial,
				  const char *command, int *scpi_response);
SR_PRIV int sr_scpi_get_float(struct sr_serial_dev_inst *serial,
			      const char *command, float *scpi_response);
SR_PRIV int sr_scpi_get_double(struct sr_serial_dev_inst *serial,
			      const char *command, double *scpi_response);
SR_PRIV int sr_scpi_get_opc(struct sr_serial_dev_inst *serial);
SR_PRIV int sr_scpi_get_floatv(struct sr_serial_dev_inst *serial,
			      const char *command, GArray **scpi_response);
SR_PRIV int sr_scpi_get_uint8v(struct sr_serial_dev_inst *serial,
			      const char *command, GArray **scpi_response);
SR_PRIV int sr_scpi_get_hw_id(struct sr_serial_dev_inst *serial,
			      struct sr_scpi_hw_info **scpi_reponse);
SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);

#endif

/*--- hardware/common/dmm/es51922.c -----------------------------------------*/

#define ES51922_PACKET_SIZE 14

struct es51922_info {
	gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
	gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
	gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
	gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
	gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
	gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
};

SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es51922_parse(const uint8_t *buf, float *floatval,
			     struct sr_datafeed_analog *analog, void *info);

/*--- hardware/common/dmm/es519xx.c -----------------------------------------*/

/**
 * All 11-byte es519xx chips repeat each block twice for each conversion cycle
 * so always read 2 blocks at a time.
 */
#define ES519XX_11B_PACKET_SIZE (11 * 2)
#define ES519XX_14B_PACKET_SIZE 14

struct es519xx_info {
	gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
	gboolean is_milli, is_resistance, is_continuity, is_diode;
	gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
	gboolean is_temperature, is_celsius, is_fahrenheit;
	gboolean is_adp0, is_adp1, is_adp2, is_adp3;
	gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
	gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
	gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
	uint32_t baudrate;
	int packet_size;
	gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
};

SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
		struct sr_datafeed_analog *analog, void *info);
SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
		float *floatval, struct sr_datafeed_analog *analog, void *info);
SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
		float *floatval, struct sr_datafeed_analog *analog, void *info);
SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
		struct sr_datafeed_analog *analog, void *info);
SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
		struct sr_datafeed_analog *analog, void *info);
SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
		float *floatval, struct sr_datafeed_analog *analog, void *info);

/*--- hardware/common/dmm/fs9922.c ------------------------------------------*/

#define FS9922_PACKET_SIZE 14

struct fs9922_info {
	gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
	gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
	gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
	gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
	gboolean is_celsius, is_fahrenheit;
	int bargraph_sign, bargraph_value;
};

SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
			    struct sr_datafeed_analog *analog, void *info);
SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);

/*--- hardware/common/dmm/fs9721.c ------------------------------------------*/

#define FS9721_PACKET_SIZE 14

struct fs9721_info {
	gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
	gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
	gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
	gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
};

SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
			    struct sr_datafeed_analog *analog, void *info);
SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);

/*--- hardware/common/dmm/metex14.c -----------------------------------------*/

#define METEX14_PACKET_SIZE 14

struct metex14_info {
	gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
	gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
	gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
	gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
	gboolean is_unitless;
};

#ifdef HAVE_LIBSERIALPORT
SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
#endif
SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
			     struct sr_datafeed_analog *analog, void *info);

/*--- hardware/common/dmm/rs9lcd.c ------------------------------------------*/

#define RS9LCD_PACKET_SIZE 9

/* Dummy info struct. The parser does not use it. */
struct rs9lcd_info { int dummy; };

SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
			    struct sr_datafeed_analog *analog, void *info);

#endif
Commit	Line	Data
1483577e	1	/*
50985c20	2	* This file is part of the libsigrok project.
1483577e	3	*
13d8e03c	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
1483577e UH	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
0f8522bf UH	20	#ifndef LIBSIGROK_SIGROK_INTERNAL_H
0f8522bf UH	21	#define LIBSIGROK_SIGROK_INTERNAL_H
1483577e	22
b08024a8	23	#include <stdarg.h>
cc8a7d25	24	#include <glib.h>
1a081ca6	25	#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
69890f73 UH	26	#ifdef HAVE_LIBUSB_1_0
	27	#include <libusb.h>
	28	#endif
c4f2dfd0	29	#ifdef HAVE_LIBSERIALPORT
dc991353	30	#include <libserialport.h>
c4f2dfd0	31	#endif
b08024a8	32
393fb9cb UH	33	/**
	34	* @file
	35	*
	36	* libsigrok private header file, only to be used internally.
	37	*/
	38
4cea9eb2 UH	39	/--- Macros ----------------------------------------------------------------/
	40
	41	#ifndef ARRAY_SIZE
	42	#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
	43	#endif
	44
	45	#ifndef ARRAY_AND_SIZE
	46	#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
	47	#endif
	48
6bf4273e UH	49	/* Portability fixes for FreeBSD. */
	50	#ifdef __FreeBSD__
	51	#define LIBUSB_CLASS_APPLICATION 0xfe
	52	#define libusb_handle_events_timeout_completed(ctx, tv, c) \
	53	libusb_handle_events_timeout(ctx, tv)
	54	#endif
	55
b8072700	56	struct sr_context {
785b9ff2 PS	57	#ifdef HAVE_LIBUSB_1_0
	58	libusb_context *libusb_ctx;
	59	#endif
b8072700 PS	60	};
b8072700 PS	61
69890f73	62	#ifdef HAVE_LIBUSB_1_0
d68e2d1a	63	struct sr_usb_dev_inst {
69890f73 UH	64	uint8_t bus;
	65	uint8_t address;
	66	struct libusb_device_handle *devhdl;
	67	};
	68	#endif
	69
c4f2dfd0	70	#ifdef HAVE_LIBSERIALPORT
a9bce5a5 ML	71	#define SERIAL_PARITY_NONE SP_PARITY_NONE
	72	#define SERIAL_PARITY_EVEN SP_PARITY_EVEN
	73	#define SERIAL_PARITY_ODD SP_PARITY_ODD
d68e2d1a	74	struct sr_serial_dev_inst {
69890f73	75	char *port;
299bdb24	76	char *serialcomm;
69890f73	77	int fd;
9647ce69	78	int nonblocking;
c9bc57b6	79	struct sp_port *data;
69890f73	80	};
c4f2dfd0	81	#endif
69890f73	82
ae67644f ML	83	struct sr_usbtmc_dev_inst {
	84	char *device;
	85	int fd;
	86	};
	87
026c822d UH	88	/* Private driver context. */
026c822d UH	89	struct drv_context {
1ebe4b4e	90	struct sr_context *sr_ctx;
026c822d UH	91	GSList *instances;
	92	};
	93
48a486cd BV	94	/--- log.c -----------------------------------------------------------------/
	95
	96	SR_PRIV int sr_log(int loglevel, const char *format, ...);
	97	SR_PRIV int sr_spew(const char *format, ...);
	98	SR_PRIV int sr_dbg(const char *format, ...);
	99	SR_PRIV int sr_info(const char *format, ...);
	100	SR_PRIV int sr_warn(const char *format, ...);
	101	SR_PRIV int sr_err(const char *format, ...);
	102
	103	/--- device.c --------------------------------------------------------------/
	104
	105	SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
	106	gboolean enabled, const char *name);
	107
	108	/* Generic device instances */
	109	SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
	110	const char vendor, const char model, const char *version);
	111	SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
48a486cd	112
545f9786	113	#ifdef HAVE_LIBUSB_1_0
69890f73	114	/* USB-specific instances */
d68e2d1a	115	SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
69890f73	116	uint8_t address, struct libusb_device_handle *hdl);
91162629	117	SR_PRIV GSList sr_usb_find_usbtmc(libusb_context usb_ctx);
d68e2d1a	118	SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
69890f73 UH	119	#endif
69890f73 UH	120
c4f2dfd0	121	#ifdef HAVE_LIBSERIALPORT
69890f73	122	/* Serial-specific instances */
299bdb24 BV	123	SR_PRIV struct sr_serial_dev_inst sr_serial_dev_inst_new(const char port,
299bdb24 BV	124	const char *serialcomm);
d68e2d1a	125	SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
c4f2dfd0	126	#endif
69890f73	127
ae67644f ML	128	/* USBTMC-specific instances */
	129	SR_PRIV struct sr_usbtmc_dev_inst sr_usbtmc_dev_inst_new(const char device);
	130	SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
b08024a8	131
c09f0b57	132	/--- hwdriver.c ------------------------------------------------------------/
996b0c72	133
93a04e3b	134	SR_PRIV void sr_hw_cleanup_all(void);
bc1c2f00	135	SR_PRIV struct sr_config sr_config_new(int key, GVariant data);
722db131	136	SR_PRIV void sr_config_free(struct sr_config *src);
48a486cd BV	137	SR_PRIV int sr_source_remove(int fd);
48a486cd BV	138	SR_PRIV int sr_source_add(int fd, int events, int timeout,
ae5859ff	139	sr_receive_data_callback_t cb, void *cb_data);
996b0c72	140
a1645fcd BV	141	/--- session.c -------------------------------------------------------------/
a1645fcd BV	142
e2b23821 UH	143	struct sr_session {
	144	/** List of struct sr_dev pointers. */
	145	GSList *devs;
	146	/** List of struct datafeed_callback pointers. */
	147	GSList *datafeed_callbacks;
	148	GTimeVal starttime;
	149	gboolean running;
	150
	151	unsigned int num_sources;
	152
	153	/*
	154	* Both "sources" and "pollfds" are of the same size and contain pairs
	155	* of descriptor and callback function. We can not embed the GPollFD
	156	* into the source struct since we want to be able to pass the array
	157	* of all poll descriptors to g_poll().
	158	*/
	159	struct source *sources;
	160	GPollFD *pollfds;
	161	int source_timeout;
	162
	163	/*
	164	* These are our synchronization primitives for stopping the session in
	165	* an async fashion. We need to make sure the session is stopped from
	166	* within the session thread itself.
	167	*/
	168	GMutex stop_mutex;
	169	gboolean abort_session;
	170	};
	171
de4d3f99	172	SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
ae5859ff	173	const struct sr_datafeed_packet *packet);
33c6e4c5	174	SR_PRIV int sr_session_stop_sync(void);
f438e0c9	175	SR_PRIV int sr_sessionfile_check(const char *filename);
a1645fcd	176
063e7aef UH	177	/--- std.c -----------------------------------------------------------------/
063e7aef UH	178
cd2f0fe2	179	typedef int (dev_close_t)(struct sr_dev_inst sdi);
ae5859ff	180	typedef void (std_dev_clear_t)(void priv);
cd2f0fe2	181
f6beaac5	182	SR_PRIV int std_init(struct sr_context sr_ctx, struct sr_dev_driver di,
ae5859ff	183	const char *prefix);
c4f2dfd0	184	#ifdef HAVE_LIBSERIALPORT
f6beaac5	185	SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
6078d2c9	186	void *cb_data, dev_close_t dev_close_fn,
ae5859ff	187	struct sr_serial_dev_inst serial, const char prefix);
c4f2dfd0	188	#endif
4afdfd46	189	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
ae5859ff BV	190	const char *prefix);
	191	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
	192	std_dev_clear_t clear_private);
4afdfd46	193
058b7035 UH	194	/--- hardware/common/serial.c ----------------------------------------------/
058b7035 UH	195
c4f2dfd0	196	#ifdef HAVE_LIBSERIALPORT
a54dd31e UH	197	enum {
	198	SERIAL_RDWR = 1,
	199	SERIAL_RDONLY = 2,
	200	SERIAL_NONBLOCK = 4,
	201	};
	202
766456be UH	203	typedef gboolean (packet_valid_t)(const uint8_t buf);
766456be UH	204
299bdb24 BV	205	SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
	206	SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
	207	SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
	208	SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
	209	const void *buf, size_t count);
	210	SR_PRIV int serial_read(struct sr_serial_dev_inst serial, void buf,
	211	size_t count);
	212	SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
71caaad4	213	int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
299bdb24 BV	214	SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
	215	const char *paramstr);
	216	SR_PRIV int serial_readline(struct sr_serial_dev_inst serial, char *buf,
	217	int *buflen, gint64 timeout_ms);
766456be UH	218	SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
	219	uint8_t buf, size_t buflen,
	220	size_t packet_size, packet_valid_t is_valid,
	221	uint64_t timeout_ms, int baudrate);
c4f2dfd0	222	#endif
1483577e	223
058b7035 UH	224	/--- hardware/common/ezusb.c -----------------------------------------------/
058b7035 UH	225
22b02383	226	#ifdef HAVE_LIBUSB_1_0
1a081ca6 UH	227	SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
	228	SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
	229	const char *filename);
	230	SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
	231	const char *filename);
22b02383	232	#endif
058b7035	233
0c632d36 UH	234	/--- hardware/common/usb.c -------------------------------------------------/
	235
	236	#ifdef HAVE_LIBUSB_1_0
7ae6a758	237	SR_PRIV GSList sr_usb_find(libusb_context usb_ctx, const char *conn);
0c632d36 UH	238	SR_PRIV int sr_usb_open(libusb_context usb_ctx, struct sr_usb_dev_inst usb);
	239	#endif
	240
7b9d7320 DJ	241	/--- hardware/common/scpi.c ------------------------------------------------/
	242
	243	#ifdef HAVE_LIBSERIALPORT
	244
	245	#define SCPI_CMD_IDN "*IDN?"
	246	#define SCPI_CMD_OPC "*OPC?"
	247
	248	enum {
	249	SCPI_CMD_SET_TRIGGER_SOURCE,
	250	SCPI_CMD_SET_TIMEBASE,
	251	SCPI_CMD_SET_VERTICAL_DIV,
	252	SCPI_CMD_SET_TRIGGER_SLOPE,
	253	SCPI_CMD_SET_COUPLING,
	254	SCPI_CMD_SET_HORIZ_TRIGGERPOS,
	255	SCPI_CMD_GET_ANALOG_CHAN_STATE,
	256	SCPI_CMD_GET_DIG_CHAN_STATE,
	257	SCPI_CMD_GET_TIMEBASE,
	258	SCPI_CMD_GET_VERTICAL_DIV,
	259	SCPI_CMD_GET_VERTICAL_OFFSET,
	260	SCPI_CMD_GET_TRIGGER_SOURCE,
	261	SCPI_CMD_GET_HORIZ_TRIGGERPOS,
	262	SCPI_CMD_GET_TRIGGER_SLOPE,
	263	SCPI_CMD_GET_COUPLING,
	264	SCPI_CMD_SET_ANALOG_CHAN_STATE,
	265	SCPI_CMD_SET_DIG_CHAN_STATE,
	266	SCPI_CMD_GET_DIG_POD_STATE,
	267	SCPI_CMD_SET_DIG_POD_STATE,
	268	SCPI_CMD_GET_ANALOG_DATA,
	269	SCPI_CMD_GET_DIG_DATA,
	270	};
	271
	272	struct sr_scpi_hw_info {
	273	char *manufacturer;
	274	char *model;
	275	char *serial_number;
	276	char *firmware_version;
	277	};
	278
	279	SR_PRIV int sr_scpi_send(struct sr_serial_dev_inst *serial,
	280	const char *command);
	281	SR_PRIV int sr_scpi_get_string(struct sr_serial_dev_inst *serial,
	282	const char command, char *scpi_response);
d730f70e DJ	283	SR_PRIV int sr_scpi_get_bool(struct sr_serial_dev_inst *serial,
	284	const char command, gboolean scpi_response);
	285	SR_PRIV int sr_scpi_get_int(struct sr_serial_dev_inst *serial,
	286	const char command, int scpi_response);
	287	SR_PRIV int sr_scpi_get_float(struct sr_serial_dev_inst *serial,
	288	const char command, float scpi_response);
	289	SR_PRIV int sr_scpi_get_double(struct sr_serial_dev_inst *serial,
	290	const char command, double scpi_response);
f5922ade	291	SR_PRIV int sr_scpi_get_opc(struct sr_serial_dev_inst *serial);
8acbb89a DJ	292	SR_PRIV int sr_scpi_get_floatv(struct sr_serial_dev_inst *serial,
8acbb89a DJ	293	const char command, GArray *scpi_response);
1a323dd8 DJ	294	SR_PRIV int sr_scpi_get_uint8v(struct sr_serial_dev_inst *serial,
1a323dd8 DJ	295	const char command, GArray *scpi_response);
7b9d7320 DJ	296	SR_PRIV int sr_scpi_get_hw_id(struct sr_serial_dev_inst *serial,
	297	struct sr_scpi_hw_info **scpi_reponse);
	298	SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
	299
	300	#endif
	301
fe0c0b98 UH	302	/--- hardware/common/dmm/es51922.c -----------------------------------------/
	303
	304	#define ES51922_PACKET_SIZE 14
	305
	306	struct es51922_info {
	307	gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
	308	gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
	309	gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
	310	gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
	311	gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
	312	gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
	313	};
	314
	315	SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
	316	SR_PRIV int sr_es51922_parse(const uint8_t buf, float floatval,
	317	struct sr_datafeed_analog analog, void info);
	318
c01bdebc AJ	319	/--- hardware/common/dmm/es519xx.c -----------------------------------------/
c01bdebc AJ	320
bfb926c1 AJ	321	/**
	322	* All 11-byte es519xx chips repeat each block twice for each conversion cycle
	323	* so always read 2 blocks at a time.
	324	*/
	325	#define ES519XX_11B_PACKET_SIZE (11 * 2)
72e1672f	326	#define ES519XX_14B_PACKET_SIZE 14
c01bdebc AJ	327
	328	struct es519xx_info {
	329	gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
	330	gboolean is_milli, is_resistance, is_continuity, is_diode;
	331	gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
	332	gboolean is_temperature, is_celsius, is_fahrenheit;
	333	gboolean is_adp0, is_adp1, is_adp2, is_adp3;
	334	gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
	335	gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
	336	gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
	337	uint32_t baudrate;
	338	int packet_size;
	339	gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
	340	};
	341
72e1672f UH	342	SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
	343	SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t buf, float floatval,
	344	struct sr_datafeed_analog analog, void info);
	345	SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
93d719cd	346	SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
72e1672f UH	347	float floatval, struct sr_datafeed_analog analog, void *info);
	348	SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
	349	SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
	350	float floatval, struct sr_datafeed_analog analog, void *info);
	351	SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
	352	SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t buf, float floatval,
	353	struct sr_datafeed_analog analog, void info);
	354	SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
	355	SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t buf, float floatval,
	356	struct sr_datafeed_analog analog, void info);
	357	SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
	358	SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
	359	float floatval, struct sr_datafeed_analog analog, void *info);
c01bdebc	360
79081ec8 UH	361	/--- hardware/common/dmm/fs9922.c ------------------------------------------/
79081ec8 UH	362
913abe83 UH	363	#define FS9922_PACKET_SIZE 14
	364
	365	struct fs9922_info {
	366	gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
	367	gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
	368	gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
	369	gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
	370	gboolean is_celsius, is_fahrenheit;
	371	int bargraph_sign, bargraph_value;
	372	};
	373
913abe83 UH	374	SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
	375	SR_PRIV int sr_fs9922_parse(const uint8_t buf, float floatval,
	376	struct sr_datafeed_analog analog, void info);
e52bb9be	377	SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog analog, void info);
79081ec8	378
6c701476 UH	379	/--- hardware/common/dmm/fs9721.c ------------------------------------------/
6c701476 UH	380
8c1adf37 UH	381	#define FS9721_PACKET_SIZE 14
	382
	383	struct fs9721_info {
	384	gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
	385	gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
	386	gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
	387	gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
	388	};
	389
8c1adf37 UH	390	SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
8c1adf37 UH	391	SR_PRIV int sr_fs9721_parse(const uint8_t buf, float floatval,
93357bc3	392	struct sr_datafeed_analog analog, void info);
2451a20f UH	393	SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog analog, void info);
	394	SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog analog, void info);
	395	SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog analog, void info);
	396	SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog analog, void info);
6c701476	397
ac913e5c UH	398	/--- hardware/common/dmm/metex14.c -----------------------------------------/
	399
	400	#define METEX14_PACKET_SIZE 14
	401
	402	struct metex14_info {
	403	gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
	404	gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
c02dc3e2 UH	405	gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
	406	gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
	407	gboolean is_unitless;
ac913e5c UH	408	};
ac913e5c UH	409
c4f2dfd0	410	#ifdef HAVE_LIBSERIALPORT
ce3777ad	411	SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
c4f2dfd0	412	#endif
ac913e5c UH	413	SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
ac913e5c UH	414	SR_PRIV int sr_metex14_parse(const uint8_t buf, float floatval,
1fbab466	415	struct sr_datafeed_analog analog, void info);
ac913e5c	416
05f134ab AG	417	/--- hardware/common/dmm/rs9lcd.c ------------------------------------------/
05f134ab AG	418
21829e67	419	#define RS9LCD_PACKET_SIZE 9
05f134ab	420
e7ed87a4	421	/* Dummy info struct. The parser does not use it. */
bf6f8399	422	struct rs9lcd_info { int dummy; };
e7ed87a4	423
05f134ab AG	424	SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
	425	SR_PRIV int sr_rs9lcd_parse(const uint8_t buf, float floatval,
	426	struct sr_datafeed_analog analog, void info);
	427
1483577e	428	#endif