[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

/**
 * @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

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

#define SERIAL_PARITY_NONE 0
#define SERIAL_PARITY_EVEN 1
#define SERIAL_PARITY_ODD  2
struct sr_serial_dev_inst {
	char *port;
	char *serialcomm;
	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

/* 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);


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

SR_PRIV int sr_session_iteration(gboolean block);
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);

/*--- 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);
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);
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 ----------------------------------------------*/

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);

/*--- 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/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/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);

/*--- 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_nano, is_micro, is_milli;
	gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
};

SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
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	#ifndef LIBSIGROK_SIGROK_INTERNAL_H
	21	#define LIBSIGROK_SIGROK_INTERNAL_H
	22
	23	#include <stdarg.h>
	24	#include <glib.h>
	25	#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
	26	#ifdef HAVE_LIBUSB_1_0
	27	#include <libusb.h>
	28	#endif
	29
	30	/**
	31	* @file
	32	*
	33	* libsigrok private header file, only to be used internally.
	34	*/
	35
	36	/--- Macros ----------------------------------------------------------------/
	37
	38	#ifndef ARRAY_SIZE
	39	#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
	40	#endif
	41
	42	#ifndef ARRAY_AND_SIZE
	43	#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
	44	#endif
	45
	46	struct sr_context {
	47	#ifdef HAVE_LIBUSB_1_0
	48	libusb_context *libusb_ctx;
	49	#endif
	50	};
	51
	52	#ifdef HAVE_LIBUSB_1_0
	53	struct sr_usb_dev_inst {
	54	uint8_t bus;
	55	uint8_t address;
	56	struct libusb_device_handle *devhdl;
	57	};
	58	#endif
	59
	60	#define SERIAL_PARITY_NONE 0
	61	#define SERIAL_PARITY_EVEN 1
	62	#define SERIAL_PARITY_ODD 2
	63	struct sr_serial_dev_inst {
	64	char *port;
	65	char *serialcomm;
	66	int fd;
	67	};
	68
	69	/* Private driver context. */
	70	struct drv_context {
	71	struct sr_context *sr_ctx;
	72	GSList *instances;
	73	};
	74
	75	/--- log.c -----------------------------------------------------------------/
	76
	77	SR_PRIV int sr_log(int loglevel, const char *format, ...);
	78	SR_PRIV int sr_spew(const char *format, ...);
	79	SR_PRIV int sr_dbg(const char *format, ...);
	80	SR_PRIV int sr_info(const char *format, ...);
	81	SR_PRIV int sr_warn(const char *format, ...);
	82	SR_PRIV int sr_err(const char *format, ...);
	83
	84	/--- device.c --------------------------------------------------------------/
	85
	86	SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
	87	gboolean enabled, const char *name);
	88
	89	/* Generic device instances */
	90	SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
	91	const char vendor, const char model, const char *version);
	92	SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
	93
	94	#ifdef HAVE_LIBUSB_1_0
	95	/* USB-specific instances */
	96	SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
	97	uint8_t address, struct libusb_device_handle *hdl);
	98	SR_PRIV GSList sr_usb_find_usbtmc(libusb_context usb_ctx);
	99	SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
	100	#endif
	101
	102	/* Serial-specific instances */
	103	SR_PRIV struct sr_serial_dev_inst sr_serial_dev_inst_new(const char port,
	104	const char *serialcomm);
	105	SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
	106
	107
	108	/--- hwdriver.c ------------------------------------------------------------/
	109
	110	SR_PRIV void sr_hw_cleanup_all(void);
	111	SR_PRIV struct sr_config sr_config_new(int key, GVariant data);
	112	SR_PRIV void sr_config_free(struct sr_config *src);
	113	SR_PRIV int sr_source_remove(int fd);
	114	SR_PRIV int sr_source_add(int fd, int events, int timeout,
	115	sr_receive_data_callback_t cb, void *cb_data);
	116
	117	/--- session.c -------------------------------------------------------------/
	118
	119	SR_PRIV int sr_session_iteration(gboolean block);
	120	SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
	121	const struct sr_datafeed_packet *packet);
	122	SR_PRIV int sr_session_stop_sync(void);
	123
	124	/--- std.c -----------------------------------------------------------------/
	125
	126	typedef int (dev_close_t)(struct sr_dev_inst sdi);
	127	typedef void (std_dev_clear_t)(void priv);
	128
	129	SR_PRIV int std_init(struct sr_context sr_ctx, struct sr_dev_driver di,
	130	const char *prefix);
	131	SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
	132	void *cb_data, dev_close_t dev_close_fn,
	133	struct sr_serial_dev_inst serial, const char prefix);
	134	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
	135	const char *prefix);
	136	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver,
	137	std_dev_clear_t clear_private);
	138
	139	/--- hardware/common/serial.c ----------------------------------------------/
	140
	141	enum {
	142	SERIAL_RDWR = 1,
	143	SERIAL_RDONLY = 2,
	144	SERIAL_NONBLOCK = 4,
	145	};
	146
	147	typedef gboolean (packet_valid_t)(const uint8_t buf);
	148
	149	SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
	150	SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
	151	SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
	152	SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
	153	const void *buf, size_t count);
	154	SR_PRIV int serial_read(struct sr_serial_dev_inst serial, void buf,
	155	size_t count);
	156	SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
	157	int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
	158	SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
	159	const char *paramstr);
	160	SR_PRIV int serial_readline(struct sr_serial_dev_inst serial, char *buf,
	161	int *buflen, gint64 timeout_ms);
	162	SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
	163	uint8_t buf, size_t buflen,
	164	size_t packet_size, packet_valid_t is_valid,
	165	uint64_t timeout_ms, int baudrate);
	166
	167	/--- hardware/common/ezusb.c -----------------------------------------------/
	168
	169	#ifdef HAVE_LIBUSB_1_0
	170	SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
	171	SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
	172	const char *filename);
	173	SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
	174	const char *filename);
	175	#endif
	176
	177	/--- hardware/common/usb.c -------------------------------------------------/
	178
	179	#ifdef HAVE_LIBUSB_1_0
	180	SR_PRIV GSList sr_usb_find(libusb_context usb_ctx, const char *conn);
	181	SR_PRIV int sr_usb_open(libusb_context usb_ctx, struct sr_usb_dev_inst usb);
	182	#endif
	183
	184	/--- hardware/common/dmm/es51922.c -----------------------------------------/
	185
	186	#define ES51922_PACKET_SIZE 14
	187
	188	struct es51922_info {
	189	gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
	190	gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
	191	gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
	192	gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
	193	gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
	194	gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
	195	};
	196
	197	SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
	198	SR_PRIV int sr_es51922_parse(const uint8_t buf, float floatval,
	199	struct sr_datafeed_analog analog, void info);
	200
	201	/--- hardware/common/dmm/fs9922.c ------------------------------------------/
	202
	203	#define FS9922_PACKET_SIZE 14
	204
	205	struct fs9922_info {
	206	gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
	207	gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
	208	gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
	209	gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
	210	gboolean is_celsius, is_fahrenheit;
	211	int bargraph_sign, bargraph_value;
	212	};
	213
	214	SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
	215	SR_PRIV int sr_fs9922_parse(const uint8_t buf, float floatval,
	216	struct sr_datafeed_analog analog, void info);
	217
	218	/--- hardware/common/dmm/fs9721.c ------------------------------------------/
	219
	220	#define FS9721_PACKET_SIZE 14
	221
	222	struct fs9721_info {
	223	gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
	224	gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
	225	gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
	226	gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
	227	};
	228
	229	SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
	230	SR_PRIV int sr_fs9721_parse(const uint8_t buf, float floatval,
	231	struct sr_datafeed_analog analog, void info);
	232	SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog analog, void info);
	233	SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog analog, void info);
	234	SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog analog, void info);
	235	SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog analog, void info);
	236
	237	/--- hardware/common/dmm/metex14.c -----------------------------------------/
	238
	239	#define METEX14_PACKET_SIZE 14
	240
	241	struct metex14_info {
	242	gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
	243	gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
	244	gboolean is_hertz, is_ohm, is_celsius, is_nano, is_micro, is_milli;
	245	gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
	246	};
	247
	248	SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
	249	SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
	250	SR_PRIV int sr_metex14_parse(const uint8_t buf, float floatval,
	251	struct sr_datafeed_analog analog, void info);
	252
	253	/--- hardware/common/dmm/rs9lcd.c ------------------------------------------/
	254
	255	#define RS9LCD_PACKET_SIZE 9
	256
	257	/* Dummy info struct. The parser does not use it. */
	258	struct rs9lcd_info { int dummy; };
	259
	260	SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
	261	SR_PRIV int sr_rs9lcd_parse(const uint8_t buf, float floatval,
	262	struct sr_datafeed_analog analog, void info);
	263
	264	#endif