[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/>.
 */

/** @file
  * @internal
  */

#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
/** USB device instance */
struct sr_usb_dev_inst {
	/** USB bus */
	uint8_t bus;
	/** Device address on USB bus */
	uint8_t address;
	/** libusb device handle */
	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 {
	/** Port name, e.g. '/dev/tty42'. */
	char *port;
	/** Comm params for serial_set_paramstr(). */
	char *serialcomm;
	/** Port is non-blocking. */
	int nonblocking;
	/** libserialport port handle */
	struct sp_port *data;
};
#endif

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

/* Private driver context. */
struct drv_context {
	/** sigrok 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.
	 */
	/** Mutex protecting access to abort_session. */
	GMutex stop_mutex;
	/** Abort current session. See sr_session_stop(). */
	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_serial_dev_open(struct sr_dev_inst *sdi);
SR_PRIV int std_serial_dev_acquisition_stop(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);
SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);

/*--- strutil.c -------------------------------------------------------------*/

SR_PRIV int sr_atol(const char *str, long *ret);
SR_PRIV int sr_atoi(const char *str, int *ret);
SR_PRIV int sr_atod(const char *str, double *ret);
SR_PRIV int sr_atof(const char *str, float *ret);

/*--- 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);
SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device,
				      const char **serial_options);
SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
		int timeout, sr_receive_data_callback_t cb, void *cb_data);
SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
#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 ------------------------------------------------*/

#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;
};

struct sr_scpi_dev_inst {
	int (*open)(void *priv);
	int (*source_add)(void *priv, int events,
		int timeout, sr_receive_data_callback_t cb, void *cb_data);
	int (*source_remove)(void *priv);
	int (*send)(void *priv, const char *command);
	int (*receive)(void *priv, char **scpi_response);
	int (*read)(void *priv, char *buf, int maxlen);
	int (*close)(void *priv);
	void (*free)(void *priv);
	void *priv;
};

SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
		int timeout, sr_receive_data_callback_t cb, void *cb_data);
SR_PRIV int sr_scpi_source_remove(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_receive(struct sr_scpi_dev_inst *scpi,
			char **scpi_response);
SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen);
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);

/*--- hardware/common/scpi_serial.c -----------------------------------------*/

#ifdef HAVE_LIBSERIALPORT
SR_PRIV struct sr_scpi_dev_inst *scpi_serial_dev_inst_new(const char *port,
		        const char *serialcomm);
#endif

/*--- hardware/common/scpi_tcp.c --------------------------------------------*/

SR_PRIV struct sr_scpi_dev_inst *scpi_tcp_dev_inst_new(const char *address,
			const char *port);

/*--- hardware/common/scpi_usbtmc.c -----------------------------------------*/

SR_PRIV struct sr_scpi_dev_inst *scpi_usbtmc_dev_inst_new(const char *device);

/*--- 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
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 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_SIGROK_INTERNAL_H
	25	#define LIBSIGROK_SIGROK_INTERNAL_H
	26
	27	#include <stdarg.h>
	28	#include <glib.h>
	29	#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
	30	#ifdef HAVE_LIBUSB_1_0
	31	#include <libusb.h>
	32	#endif
	33	#ifdef HAVE_LIBSERIALPORT
	34	#include <libserialport.h>
	35	#endif
	36
	37	/**
	38	* @file
	39	*
	40	* libsigrok private header file, only to be used internally.
	41	*/
	42
	43	/--- Macros ----------------------------------------------------------------/
	44
	45	#ifndef ARRAY_SIZE
	46	#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
	47	#endif
	48
	49	#ifndef ARRAY_AND_SIZE
	50	#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
	51	#endif
	52
	53	/* Portability fixes for FreeBSD. */
	54	#ifdef __FreeBSD__
	55	#define LIBUSB_CLASS_APPLICATION 0xfe
	56	#define libusb_handle_events_timeout_completed(ctx, tv, c) \
	57	libusb_handle_events_timeout(ctx, tv)
	58	#endif
	59
	60	struct sr_context {
	61	#ifdef HAVE_LIBUSB_1_0
	62	libusb_context *libusb_ctx;
	63	#endif
	64	};
	65
	66	#ifdef HAVE_LIBUSB_1_0
	67	/** USB device instance */
	68	struct sr_usb_dev_inst {
	69	/** USB bus */
	70	uint8_t bus;
	71	/** Device address on USB bus */
	72	uint8_t address;
	73	/** libusb device handle */
	74	struct libusb_device_handle *devhdl;
	75	};
	76	#endif
	77
	78	#ifdef HAVE_LIBSERIALPORT
	79	#define SERIAL_PARITY_NONE SP_PARITY_NONE
	80	#define SERIAL_PARITY_EVEN SP_PARITY_EVEN
	81	#define SERIAL_PARITY_ODD SP_PARITY_ODD
	82	struct sr_serial_dev_inst {
	83	/** Port name, e.g. '/dev/tty42'. */
	84	char *port;
	85	/** Comm params for serial_set_paramstr(). */
	86	char *serialcomm;
	87	/** Port is non-blocking. */
	88	int nonblocking;
	89	/** libserialport port handle */
	90	struct sp_port *data;
	91	};
	92	#endif
	93
	94	struct sr_usbtmc_dev_inst {
	95	char *device;
	96	int fd;
	97	};
	98
	99	/* Private driver context. */
	100	struct drv_context {
	101	/** sigrok context */
	102	struct sr_context *sr_ctx;
	103	GSList *instances;
	104	};
	105
	106	/--- log.c -----------------------------------------------------------------/
	107
	108	SR_PRIV int sr_log(int loglevel, const char *format, ...);
	109	SR_PRIV int sr_spew(const char *format, ...);
	110	SR_PRIV int sr_dbg(const char *format, ...);
	111	SR_PRIV int sr_info(const char *format, ...);
	112	SR_PRIV int sr_warn(const char *format, ...);
	113	SR_PRIV int sr_err(const char *format, ...);
	114
	115	/--- device.c --------------------------------------------------------------/
	116
	117	SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
	118	gboolean enabled, const char *name);
	119
	120	/* Generic device instances */
	121	SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
	122	const char vendor, const char model, const char *version);
	123	SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
	124
	125	#ifdef HAVE_LIBUSB_1_0
	126	/* USB-specific instances */
	127	SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
	128	uint8_t address, struct libusb_device_handle *hdl);
	129	SR_PRIV GSList sr_usb_find_usbtmc(libusb_context usb_ctx);
	130	SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
	131	#endif
	132
	133	#ifdef HAVE_LIBSERIALPORT
	134	/* Serial-specific instances */
	135	SR_PRIV struct sr_serial_dev_inst sr_serial_dev_inst_new(const char port,
	136	const char *serialcomm);
	137	SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
	138	#endif
	139
	140	/* USBTMC-specific instances */
	141	SR_PRIV struct sr_usbtmc_dev_inst sr_usbtmc_dev_inst_new(const char device);
	142	SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
	143
	144	/--- hwdriver.c ------------------------------------------------------------/
	145
	146	SR_PRIV void sr_hw_cleanup_all(void);
	147	SR_PRIV struct sr_config sr_config_new(int key, GVariant data);
	148	SR_PRIV void sr_config_free(struct sr_config *src);
	149	SR_PRIV int sr_source_remove(int fd);
	150	SR_PRIV int sr_source_add(int fd, int events, int timeout,
	151	sr_receive_data_callback_t cb, void *cb_data);
	152
	153	/--- session.c -------------------------------------------------------------/
	154
	155	struct sr_session {
	156	/** List of struct sr_dev pointers. */
	157	GSList *devs;
	158	/** List of struct datafeed_callback pointers. */
	159	GSList *datafeed_callbacks;
	160	GTimeVal starttime;
	161	gboolean running;
	162
	163	unsigned int num_sources;
	164
	165	/*
	166	* Both "sources" and "pollfds" are of the same size and contain pairs
	167	* of descriptor and callback function. We can not embed the GPollFD
	168	* into the source struct since we want to be able to pass the array
	169	* of all poll descriptors to g_poll().
	170	*/
	171	struct source *sources;
	172	GPollFD *pollfds;
	173	int source_timeout;
	174
	175	/*
	176	* These are our synchronization primitives for stopping the session in
	177	* an async fashion. We need to make sure the session is stopped from
	178	* within the session thread itself.
	179	*/
	180	/** Mutex protecting access to abort_session. */
	181	GMutex stop_mutex;
	182	/** Abort current session. See sr_session_stop(). */
	183	gboolean abort_session;
	184	};
	185
	186	SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
	187	const struct sr_datafeed_packet *packet);
	188	SR_PRIV int sr_session_stop_sync(void);
	189	SR_PRIV int sr_sessionfile_check(const char *filename);
	190
	191	/--- std.c -----------------------------------------------------------------/
	192
	193	typedef int (dev_close_t)(struct sr_dev_inst sdi);
	194	typedef void (std_dev_clear_t)(void priv);
	195
	196	SR_PRIV int std_init(struct sr_context sr_ctx, struct sr_dev_driver di,
	197	const char *prefix);
	198	#ifdef HAVE_LIBSERIALPORT
	199	SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
	200	SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi,
	201	void *cb_data, dev_close_t dev_close_fn,
	202	struct sr_serial_dev_inst serial, const char prefix);
	203	#endif
	204	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
	205	const char *prefix);
	206	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
	207	std_dev_clear_t clear_private);
	208	SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
	209
	210	/--- strutil.c -------------------------------------------------------------/
	211
	212	SR_PRIV int sr_atol(const char str, long ret);
	213	SR_PRIV int sr_atoi(const char str, int ret);
	214	SR_PRIV int sr_atod(const char str, double ret);
	215	SR_PRIV int sr_atof(const char str, float ret);
	216
	217	/--- hardware/common/serial.c ----------------------------------------------/
	218
	219	#ifdef HAVE_LIBSERIALPORT
	220	enum {
	221	SERIAL_RDWR = 1,
	222	SERIAL_RDONLY = 2,
	223	SERIAL_NONBLOCK = 4,
	224	};
	225
	226	typedef gboolean (packet_valid_t)(const uint8_t buf);
	227
	228	SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
	229	SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
	230	SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
	231	SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
	232	const void *buf, size_t count);
	233	SR_PRIV int serial_read(struct sr_serial_dev_inst serial, void buf,
	234	size_t count);
	235	SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
	236	int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
	237	SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
	238	const char *paramstr);
	239	SR_PRIV int serial_readline(struct sr_serial_dev_inst serial, char *buf,
	240	int *buflen, gint64 timeout_ms);
	241	SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
	242	uint8_t buf, size_t buflen,
	243	size_t packet_size, packet_valid_t is_valid,
	244	uint64_t timeout_ms, int baudrate);
	245	SR_PRIV int sr_serial_extract_options(GSList options, const char *serial_device,
	246	const char **serial_options);
	247	SR_PRIV int serial_source_add(struct sr_serial_dev_inst *serial, int events,
	248	int timeout, sr_receive_data_callback_t cb, void *cb_data);
	249	SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial);
	250	#endif
	251
	252	/--- hardware/common/ezusb.c -----------------------------------------------/
	253
	254	#ifdef HAVE_LIBUSB_1_0
	255	SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
	256	SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
	257	const char *filename);
	258	SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
	259	const char *filename);
	260	#endif
	261
	262	/--- hardware/common/usb.c -------------------------------------------------/
	263
	264	#ifdef HAVE_LIBUSB_1_0
	265	SR_PRIV GSList sr_usb_find(libusb_context usb_ctx, const char *conn);
	266	SR_PRIV int sr_usb_open(libusb_context usb_ctx, struct sr_usb_dev_inst usb);
	267	#endif
	268
	269	/--- hardware/common/scpi.c ------------------------------------------------/
	270
	271	#define SCPI_CMD_IDN "*IDN?"
	272	#define SCPI_CMD_OPC "*OPC?"
	273
	274	enum {
	275	SCPI_CMD_SET_TRIGGER_SOURCE,
	276	SCPI_CMD_SET_TIMEBASE,
	277	SCPI_CMD_SET_VERTICAL_DIV,
	278	SCPI_CMD_SET_TRIGGER_SLOPE,
	279	SCPI_CMD_SET_COUPLING,
	280	SCPI_CMD_SET_HORIZ_TRIGGERPOS,
	281	SCPI_CMD_GET_ANALOG_CHAN_STATE,
	282	SCPI_CMD_GET_DIG_CHAN_STATE,
	283	SCPI_CMD_GET_TIMEBASE,
	284	SCPI_CMD_GET_VERTICAL_DIV,
	285	SCPI_CMD_GET_VERTICAL_OFFSET,
	286	SCPI_CMD_GET_TRIGGER_SOURCE,
	287	SCPI_CMD_GET_HORIZ_TRIGGERPOS,
	288	SCPI_CMD_GET_TRIGGER_SLOPE,
	289	SCPI_CMD_GET_COUPLING,
	290	SCPI_CMD_SET_ANALOG_CHAN_STATE,
	291	SCPI_CMD_SET_DIG_CHAN_STATE,
	292	SCPI_CMD_GET_DIG_POD_STATE,
	293	SCPI_CMD_SET_DIG_POD_STATE,
	294	SCPI_CMD_GET_ANALOG_DATA,
	295	SCPI_CMD_GET_DIG_DATA,
	296	};
	297
	298	struct sr_scpi_hw_info {
	299	char *manufacturer;
	300	char *model;
	301	char *serial_number;
	302	char *firmware_version;
	303	};
	304
	305	struct sr_scpi_dev_inst {
	306	int (open)(void priv);
	307	int (source_add)(void priv, int events,
	308	int timeout, sr_receive_data_callback_t cb, void *cb_data);
	309	int (source_remove)(void priv);
	310	int (send)(void priv, const char *command);
	311	int (receive)(void priv, char **scpi_response);
	312	int (read)(void priv, char *buf, int maxlen);
	313	int (close)(void priv);
	314	void (free)(void priv);
	315	void *priv;
	316	};
	317
	318	SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi);
	319	SR_PRIV int sr_scpi_source_add(struct sr_scpi_dev_inst *scpi, int events,
	320	int timeout, sr_receive_data_callback_t cb, void *cb_data);
	321	SR_PRIV int sr_scpi_source_remove(struct sr_scpi_dev_inst *scpi);
	322	SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi,
	323	const char *format, ...);
	324	SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi,
	325	const char *format, va_list args);
	326	SR_PRIV int sr_scpi_receive(struct sr_scpi_dev_inst *scpi,
	327	char **scpi_response);
	328	SR_PRIV int sr_scpi_read(struct sr_scpi_dev_inst scpi, char buf, int maxlen);
	329	SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi);
	330	SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi);
	331
	332	SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi,
	333	const char command, char *scpi_response);
	334	SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi,
	335	const char command, gboolean scpi_response);
	336	SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi,
	337	const char command, int scpi_response);
	338	SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi,
	339	const char command, float scpi_response);
	340	SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi,
	341	const char command, double scpi_response);
	342	SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi);
	343	SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi,
	344	const char command, GArray *scpi_response);
	345	SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi,
	346	const char command, GArray *scpi_response);
	347	SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi,
	348	struct sr_scpi_hw_info **scpi_response);
	349	SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info);
	350
	351	/--- hardware/common/scpi_serial.c -----------------------------------------/
	352
	353	#ifdef HAVE_LIBSERIALPORT
	354	SR_PRIV struct sr_scpi_dev_inst scpi_serial_dev_inst_new(const char port,
	355	const char *serialcomm);
	356	#endif
	357
	358	/--- hardware/common/scpi_tcp.c --------------------------------------------/
	359
	360	SR_PRIV struct sr_scpi_dev_inst scpi_tcp_dev_inst_new(const char address,
	361	const char *port);
	362
	363	/--- hardware/common/scpi_usbtmc.c -----------------------------------------/
	364
	365	SR_PRIV struct sr_scpi_dev_inst scpi_usbtmc_dev_inst_new(const char device);
	366
	367	/--- hardware/common/dmm/es51922.c -----------------------------------------/
	368
	369	#define ES51922_PACKET_SIZE 14
	370
	371	struct es51922_info {
	372	gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
	373	gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
	374	gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
	375	gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
	376	gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
	377	gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
	378	};
	379
	380	SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
	381	SR_PRIV int sr_es51922_parse(const uint8_t buf, float floatval,
	382	struct sr_datafeed_analog analog, void info);
	383
	384	/--- hardware/common/dmm/es519xx.c -----------------------------------------/
	385
	386	/**
	387	* All 11-byte es519xx chips repeat each block twice for each conversion cycle
	388	* so always read 2 blocks at a time.
	389	*/
	390	#define ES519XX_11B_PACKET_SIZE (11 * 2)
	391	#define ES519XX_14B_PACKET_SIZE 14
	392
	393	struct es519xx_info {
	394	gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
	395	gboolean is_milli, is_resistance, is_continuity, is_diode;
	396	gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
	397	gboolean is_temperature, is_celsius, is_fahrenheit;
	398	gboolean is_adp0, is_adp1, is_adp2, is_adp3;
	399	gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
	400	gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
	401	gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
	402	uint32_t baudrate;
	403	int packet_size;
	404	gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
	405	};
	406
	407	SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
	408	SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t buf, float floatval,
	409	struct sr_datafeed_analog analog, void info);
	410	SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
	411	SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
	412	float floatval, struct sr_datafeed_analog analog, void *info);
	413	SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
	414	SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
	415	float floatval, struct sr_datafeed_analog analog, void *info);
	416	SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
	417	SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t buf, float floatval,
	418	struct sr_datafeed_analog analog, void info);
	419	SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
	420	SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t buf, float floatval,
	421	struct sr_datafeed_analog analog, void info);
	422	SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
	423	SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
	424	float floatval, struct sr_datafeed_analog analog, void *info);
	425
	426	/--- hardware/common/dmm/fs9922.c ------------------------------------------/
	427
	428	#define FS9922_PACKET_SIZE 14
	429
	430	struct fs9922_info {
	431	gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
	432	gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
	433	gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
	434	gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
	435	gboolean is_celsius, is_fahrenheit;
	436	int bargraph_sign, bargraph_value;
	437	};
	438
	439	SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
	440	SR_PRIV int sr_fs9922_parse(const uint8_t buf, float floatval,
	441	struct sr_datafeed_analog analog, void info);
	442	SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog analog, void info);
	443
	444	/--- hardware/common/dmm/fs9721.c ------------------------------------------/
	445
	446	#define FS9721_PACKET_SIZE 14
	447
	448	struct fs9721_info {
	449	gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
	450	gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
	451	gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
	452	gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
	453	};
	454
	455	SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
	456	SR_PRIV int sr_fs9721_parse(const uint8_t buf, float floatval,
	457	struct sr_datafeed_analog analog, void info);
	458	SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog analog, void info);
	459	SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog analog, void info);
	460	SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog analog, void info);
	461	SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog analog, void info);
	462
	463	/--- hardware/common/dmm/metex14.c -----------------------------------------/
	464
	465	#define METEX14_PACKET_SIZE 14
	466
	467	struct metex14_info {
	468	gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
	469	gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
	470	gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro;
	471	gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe;
	472	gboolean is_unitless;
	473	};
	474
	475	#ifdef HAVE_LIBSERIALPORT
	476	SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
	477	#endif
	478	SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
	479	SR_PRIV int sr_metex14_parse(const uint8_t buf, float floatval,
	480	struct sr_datafeed_analog analog, void info);
	481
	482	/--- hardware/common/dmm/rs9lcd.c ------------------------------------------/
	483
	484	#define RS9LCD_PACKET_SIZE 9
	485
	486	/* Dummy info struct. The parser does not use it. */
	487	struct rs9lcd_info { int dummy; };
	488
	489	SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
	490	SR_PRIV int sr_rs9lcd_parse(const uint8_t buf, float floatval,
	491	struct sr_datafeed_analog analog, void info);
	492
	493	#endif