[libsigrok.git] / libsigrok-internal.h

/*
 * This file is part of the sigrok 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

/* Versions < 2.30.0 of glib don't have g_match_info_unref(). */
#if !GLIB_CHECK_VERSION(2,30,0)
#define g_match_info_unref g_match_info_free
#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_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);

SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di,
			const char *prefix);
SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
			void *cb_data, dev_close_t hw_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);

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

SR_PRIV int sr_dmm_parse_fs9922(const uint8_t *buf, float *floatval,
				struct sr_datafeed_analog *analog);

/*--- 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_is_packet_start(uint8_t b);
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);

/*--- 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
1483577e UH	1	/*
	2	* This file is part of the sigrok project.
	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
b08024a8	29
393fb9cb UH	30	/**
	31	* @file
	32	*
	33	* libsigrok private header file, only to be used internally.
	34	*/
	35
4cea9eb2 UH	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
33df15f1 UH	46	/* Versions < 2.30.0 of glib don't have g_match_info_unref(). */
	47	#if !GLIB_CHECK_VERSION(2,30,0)
	48	#define g_match_info_unref g_match_info_free
	49	#endif
	50
b8072700	51	struct sr_context {
785b9ff2 PS	52	#ifdef HAVE_LIBUSB_1_0
	53	libusb_context *libusb_ctx;
	54	#endif
b8072700 PS	55	};
b8072700 PS	56
69890f73	57	#ifdef HAVE_LIBUSB_1_0
d68e2d1a	58	struct sr_usb_dev_inst {
69890f73 UH	59	uint8_t bus;
	60	uint8_t address;
	61	struct libusb_device_handle *devhdl;
	62	};
	63	#endif
	64
f8c1fcda BV	65	#define SERIAL_PARITY_NONE 0
	66	#define SERIAL_PARITY_EVEN 1
	67	#define SERIAL_PARITY_ODD 2
d68e2d1a	68	struct sr_serial_dev_inst {
69890f73	69	char *port;
299bdb24	70	char *serialcomm;
69890f73 UH	71	int fd;
	72	};
	73
026c822d UH	74	/* Private driver context. */
026c822d UH	75	struct drv_context {
1ebe4b4e	76	struct sr_context *sr_ctx;
026c822d UH	77	GSList *instances;
	78	};
	79
48a486cd BV	80	/--- log.c -----------------------------------------------------------------/
	81
	82	SR_PRIV int sr_log(int loglevel, const char *format, ...);
	83	SR_PRIV int sr_spew(const char *format, ...);
	84	SR_PRIV int sr_dbg(const char *format, ...);
	85	SR_PRIV int sr_info(const char *format, ...);
	86	SR_PRIV int sr_warn(const char *format, ...);
	87	SR_PRIV int sr_err(const char *format, ...);
	88
	89	/--- device.c --------------------------------------------------------------/
	90
	91	SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
	92	gboolean enabled, const char *name);
	93
	94	/* Generic device instances */
	95	SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
	96	const char vendor, const char model, const char *version);
	97	SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
48a486cd	98
545f9786	99	#ifdef HAVE_LIBUSB_1_0
69890f73	100	/* USB-specific instances */
d68e2d1a	101	SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
69890f73	102	uint8_t address, struct libusb_device_handle *hdl);
91162629	103	SR_PRIV GSList sr_usb_find_usbtmc(libusb_context usb_ctx);
d68e2d1a	104	SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
69890f73 UH	105	#endif
	106
	107	/* Serial-specific instances */
299bdb24 BV	108	SR_PRIV struct sr_serial_dev_inst sr_serial_dev_inst_new(const char port,
299bdb24 BV	109	const char *serialcomm);
d68e2d1a	110	SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
69890f73	111
b08024a8	112
c09f0b57	113	/--- hwdriver.c ------------------------------------------------------------/
996b0c72	114
93a04e3b	115	SR_PRIV void sr_hw_cleanup_all(void);
bc1c2f00	116	SR_PRIV struct sr_config sr_config_new(int key, GVariant data);
722db131	117	SR_PRIV void sr_config_free(struct sr_config *src);
48a486cd BV	118	SR_PRIV int sr_source_remove(int fd);
	119	SR_PRIV int sr_source_add(int fd, int events, int timeout,
	120	sr_receive_data_callback_t cb, void *cb_data);
996b0c72	121
a1645fcd BV	122	/--- session.c -------------------------------------------------------------/
a1645fcd BV	123
de4d3f99	124	SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
bf53457d	125	const struct sr_datafeed_packet *packet);
33c6e4c5	126	SR_PRIV int sr_session_stop_sync(void);
a1645fcd	127
063e7aef UH	128	/--- std.c -----------------------------------------------------------------/
063e7aef UH	129
cd2f0fe2 UH	130	typedef int (dev_close_t)(struct sr_dev_inst sdi);
cd2f0fe2 UH	131
063e7aef UH	132	SR_PRIV int std_hw_init(struct sr_context sr_ctx, struct sr_dev_driver di,
063e7aef UH	133	const char *prefix);
cd2f0fe2 UH	134	SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi,
	135	void *cb_data, dev_close_t hw_dev_close_fn,
	136	struct sr_serial_dev_inst serial, const char prefix);
4afdfd46 UH	137	SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi,
4afdfd46 UH	138	const char *prefix);
49f00e13	139	SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
4afdfd46	140
058b7035 UH	141	/--- hardware/common/serial.c ----------------------------------------------/
058b7035 UH	142
a54dd31e UH	143	enum {
	144	SERIAL_RDWR = 1,
	145	SERIAL_RDONLY = 2,
	146	SERIAL_NONBLOCK = 4,
	147	};
	148
766456be UH	149	typedef gboolean (packet_valid_t)(const uint8_t buf);
766456be UH	150
299bdb24 BV	151	SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
	152	SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
	153	SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
	154	SR_PRIV int serial_write(struct sr_serial_dev_inst *serial,
	155	const void *buf, size_t count);
	156	SR_PRIV int serial_read(struct sr_serial_dev_inst serial, void buf,
	157	size_t count);
	158	SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
71caaad4	159	int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
299bdb24 BV	160	SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
	161	const char *paramstr);
	162	SR_PRIV int serial_readline(struct sr_serial_dev_inst serial, char *buf,
	163	int *buflen, gint64 timeout_ms);
766456be UH	164	SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
	165	uint8_t buf, size_t buflen,
	166	size_t packet_size, packet_valid_t is_valid,
	167	uint64_t timeout_ms, int baudrate);
1483577e	168
058b7035 UH	169	/--- hardware/common/ezusb.c -----------------------------------------------/
058b7035 UH	170
22b02383	171	#ifdef HAVE_LIBUSB_1_0
1a081ca6 UH	172	SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
	173	SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl,
	174	const char *filename);
	175	SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration,
	176	const char *filename);
22b02383	177	#endif
058b7035	178
0c632d36 UH	179	/--- hardware/common/usb.c -------------------------------------------------/
	180
	181	#ifdef HAVE_LIBUSB_1_0
7ae6a758	182	SR_PRIV GSList sr_usb_find(libusb_context usb_ctx, const char *conn);
0c632d36 UH	183	SR_PRIV int sr_usb_open(libusb_context usb_ctx, struct sr_usb_dev_inst usb);
	184	#endif
	185
fe0c0b98 UH	186	/--- hardware/common/dmm/es51922.c -----------------------------------------/
	187
	188	#define ES51922_PACKET_SIZE 14
	189
	190	struct es51922_info {
	191	gboolean is_judge, is_vbar, is_voltage, is_auto, is_micro, is_current;
	192	gboolean is_milli, is_resistance, is_continuity, is_diode, is_lpf;
	193	gboolean is_frequency, is_duty_cycle, is_capacitance, is_temperature;
	194	gboolean is_celsius, is_fahrenheit, is_adp, is_sign, is_batt, is_ol;
	195	gboolean is_max, is_min, is_rel, is_rmr, is_ul, is_pmax, is_pmin;
	196	gboolean is_dc, is_ac, is_vahz, is_hold, is_nano, is_kilo, is_mega;
	197	};
	198
	199	SR_PRIV gboolean sr_es51922_packet_valid(const uint8_t *buf);
	200	SR_PRIV int sr_es51922_parse(const uint8_t buf, float floatval,
	201	struct sr_datafeed_analog analog, void info);
	202
79081ec8 UH	203	/--- hardware/common/dmm/fs9922.c ------------------------------------------/
	204
	205	SR_PRIV int sr_dmm_parse_fs9922(const uint8_t buf, float floatval,
	206	struct sr_datafeed_analog *analog);
	207
6c701476 UH	208	/--- hardware/common/dmm/fs9721.c ------------------------------------------/
6c701476 UH	209
8c1adf37 UH	210	#define FS9721_PACKET_SIZE 14
	211
	212	struct fs9721_info {
	213	gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
	214	gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
	215	gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
	216	gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
	217	};
	218
	219	SR_PRIV gboolean sr_fs9721_is_packet_start(uint8_t b);
	220	SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
	221	SR_PRIV int sr_fs9721_parse(const uint8_t buf, float floatval,
93357bc3	222	struct sr_datafeed_analog analog, void info);
6c701476	223
ac913e5c UH	224	/--- hardware/common/dmm/metex14.c -----------------------------------------/
	225
	226	#define METEX14_PACKET_SIZE 14
	227
	228	struct metex14_info {
	229	gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
	230	gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
	231	gboolean is_hertz, is_ohm, is_celsius, is_nano, is_micro, is_milli;
9871215c	232	gboolean is_kilo, is_mega, is_gain, is_decibel, is_hfe, is_unitless;
ac913e5c UH	233	};
ac913e5c UH	234
ce3777ad	235	SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
ac913e5c UH	236	SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
ac913e5c UH	237	SR_PRIV int sr_metex14_parse(const uint8_t buf, float floatval,
1fbab466	238	struct sr_datafeed_analog analog, void info);
ac913e5c	239
05f134ab AG	240	/--- hardware/common/dmm/rs9lcd.c ------------------------------------------/
05f134ab AG	241
21829e67	242	#define RS9LCD_PACKET_SIZE 9
05f134ab	243
e7ed87a4	244	/* Dummy info struct. The parser does not use it. */
bf6f8399	245	struct rs9lcd_info { int dummy; };
e7ed87a4	246
05f134ab AG	247	SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
	248	SR_PRIV int sr_rs9lcd_parse(const uint8_t buf, float floatval,
	249	struct sr_datafeed_analog analog, void info);
	250
1483577e	251	#endif