[libsigrok.git] / include / libsigrok / proto.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_PROTO_H
#define LIBSIGROK_PROTO_H

/**
 * @file
 *
 * Header file containing API function prototypes.
 */

/*--- backend.c -------------------------------------------------------------*/

SR_API int sr_init(struct sr_context **ctx);
SR_API int sr_exit(struct sr_context *ctx);

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

typedef int (*sr_log_callback)(void *cb_data, int loglevel,
				const char *format, va_list args);

SR_API int sr_log_loglevel_set(int loglevel);
SR_API int sr_log_loglevel_get(void);
SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
SR_API int sr_log_callback_set_default(void);
SR_API int sr_log_logdomain_set(const char *logdomain);
SR_API char *sr_log_logdomain_get(void);

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

SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
		int channelnum, const char *name);
SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
		gboolean state);
SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
SR_API int sr_dev_open(struct sr_dev_inst *sdi);
SR_API int sr_dev_close(struct sr_dev_inst *sdi);

SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);

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

SR_API struct sr_dev_driver **sr_driver_list(void);
SR_API int sr_driver_init(struct sr_context *ctx,
		struct sr_dev_driver *driver);
SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
SR_API int sr_config_get(const struct sr_dev_driver *driver,
		const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg,
		uint32_t key, GVariant **data);
SR_API int sr_config_set(const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg,
		uint32_t key, GVariant *data);
SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
SR_API int sr_config_list(const struct sr_dev_driver *driver,
		const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg,
		uint32_t key, GVariant **data);
SR_API const struct sr_config_info *sr_config_info_get(uint32_t key);
SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);

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

typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
		const struct sr_datafeed_packet *packet, void *cb_data);
SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);

/* Session setup */
SR_API int sr_session_load(const char *filename, struct sr_session **session);
SR_API int sr_session_new(struct sr_session **session);
SR_API int sr_session_destroy(struct sr_session *session);
SR_API int sr_session_dev_remove_all(struct sr_session *session);
SR_API int sr_session_dev_add(struct sr_session *session,
		struct sr_dev_inst *sdi);
SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);

/* Datafeed setup */
SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
		sr_datafeed_callback cb, void *cb_data);

/* Session control */
SR_API int sr_session_start(struct sr_session *session);
SR_API int sr_session_run(struct sr_session *session);
SR_API int sr_session_stop(struct sr_session *session);
SR_API int sr_session_save(struct sr_session *session, const char *filename,
		const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
		int units);
SR_API int sr_session_save_init(struct sr_session *session,
		const char *filename, uint64_t samplerate, char **channels);
SR_API int sr_session_append(struct sr_session *session,
		const char *filename, unsigned char *buf, int unitsize, int units);
SR_API int sr_session_source_add(struct sr_session *session, int fd,
		int events, int timeout, sr_receive_data_callback cb, void *cb_data);
SR_API int sr_session_source_add_pollfd(struct sr_session *session,
		GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
		void *cb_data);
SR_API int sr_session_source_add_channel(struct sr_session *session,
		GIOChannel *channel, int events, int timeout,
		sr_receive_data_callback cb, void *cb_data);
SR_API int sr_session_source_remove(struct sr_session *session, int fd);
SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
		GPollFD *pollfd);
SR_API int sr_session_source_remove_channel(struct sr_session *session,
		GIOChannel *channel);

/*--- input/input.c ---------------------------------------------------------*/

SR_API const struct sr_input_module **sr_input_list(void);
SR_API const char *sr_input_id_get(const struct sr_input_module *in);
SR_API const char *sr_input_name_get(const struct sr_input_module *in);
SR_API const char *sr_input_description_get(const struct sr_input_module *in);
SR_API const struct sr_input_module *sr_input_find(char *id);
SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *in);
SR_API void sr_input_options_free(const struct sr_option **options);
SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
		GHashTable *options);
SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
SR_API int sr_input_send(const struct sr_input *in, GString *buf);
SR_API int sr_input_end(const struct sr_input *in);
SR_API void sr_input_free(const struct sr_input *in);

/*--- output/output.c -------------------------------------------------------*/

SR_API const struct sr_output_module **sr_output_list(void);
SR_API const char *sr_output_id_get(const struct sr_output_module *o);
SR_API const char *sr_output_name_get(const struct sr_output_module *o);
SR_API const char *sr_output_description_get(const struct sr_output_module *o);
SR_API const struct sr_output_module *sr_output_find(char *id);
SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *o);
SR_API void sr_output_options_free(const struct sr_option **opts);
SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
		GHashTable *params, const struct sr_dev_inst *sdi);
SR_API int sr_output_send(const struct sr_output *o,
		const struct sr_datafeed_packet *packet, GString **out);
SR_API int sr_output_free(const struct sr_output *o);

/*--- trigger.c -------------------------------------------------------------*/

SR_API struct sr_trigger *sr_trigger_new(const char *name);
SR_API void sr_trigger_free(struct sr_trigger *trig);
SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
		struct sr_channel *ch, int trigger_match, float value);

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

SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
SR_API char *sr_samplerate_string(uint64_t samplerate);
SR_API char *sr_period_string(uint64_t frequency);
SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
SR_API uint64_t sr_parse_timestring(const char *timestring);
SR_API gboolean sr_parse_boolstring(const char *boolstring);
SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);

/*--- version.c -------------------------------------------------------------*/

SR_API int sr_package_version_major_get(void);
SR_API int sr_package_version_minor_get(void);
SR_API int sr_package_version_micro_get(void);
SR_API const char *sr_package_version_string_get(void);

SR_API int sr_lib_version_current_get(void);
SR_API int sr_lib_version_revision_get(void);
SR_API int sr_lib_version_age_get(void);
SR_API const char *sr_lib_version_string_get(void);

/*--- error.c ---------------------------------------------------------------*/

SR_API const char *sr_strerror(int error_code);
SR_API const char *sr_strerror_name(int error_code);

#endif
Commit	Line	Data
10509bc2	1	/*
50985c20	2	* This file is part of the libsigrok project.
10509bc2	3	*
13d8e03c	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
10509bc2 BV	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
a5827886 UH	20	#ifndef LIBSIGROK_PROTO_H
a5827886 UH	21	#define LIBSIGROK_PROTO_H
10509bc2	22
393fb9cb UH	23	/**
	24	* @file
	25	*
	26	* Header file containing API function prototypes.
	27	*/
	28
10509bc2 BV	29	/--- backend.c -------------------------------------------------------------/
10509bc2 BV	30
b8072700 PS	31	SR_API int sr_init(struct sr_context **ctx);
b8072700 PS	32	SR_API int sr_exit(struct sr_context *ctx);
10509bc2	33
1352eedd UH	34	/--- log.c -----------------------------------------------------------------/
1352eedd UH	35
144f6660 UH	36	typedef int (sr_log_callback)(void cb_data, int loglevel,
144f6660 UH	37	const char *format, va_list args);
0ae67ff7 UH	38
	39	SR_API int sr_log_loglevel_set(int loglevel);
	40	SR_API int sr_log_loglevel_get(void);
144f6660	41	SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
b5118d6c	42	SR_API int sr_log_callback_set_default(void);
0ae67ff7 UH	43	SR_API int sr_log_logdomain_set(const char *logdomain);
0ae67ff7 UH	44	SR_API char *sr_log_logdomain_get(void);
1352eedd	45
aa0b6b20	46	/--- device.c --------------------------------------------------------------/
10509bc2	47
f3ca73ed	48	SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
fca75cbb UH	49	int channelnum, const char *name);
fca75cbb UH	50	SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
be5bf44d	51	gboolean state);
4d15e5c9	52	SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
f99e32af BV	53	SR_API GSList sr_dev_list(const struct sr_dev_driver driver);
f99e32af BV	54	SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
efdecf4c BV	55	SR_API int sr_dev_open(struct sr_dev_inst *sdi);
efdecf4c BV	56	SR_API int sr_dev_close(struct sr_dev_inst *sdi);
10509bc2	57
2f5f9705 UH	58	SR_API struct sr_dev_driver sr_dev_inst_driver_get(const struct sr_dev_inst sdi);
	59	SR_API const char sr_dev_inst_vendor_get(const struct sr_dev_inst sdi);
	60	SR_API const char sr_dev_inst_model_get(const struct sr_dev_inst sdi);
	61	SR_API const char sr_dev_inst_version_get(const struct sr_dev_inst sdi);
	62	SR_API const char sr_dev_inst_sernum_get(const struct sr_dev_inst sdi);
	63	SR_API const char sr_dev_inst_connid_get(const struct sr_dev_inst sdi);
	64	SR_API GSList sr_dev_inst_channels_get(const struct sr_dev_inst sdi);
	65	SR_API GSList sr_dev_inst_channel_groups_get(const struct sr_dev_inst sdi);
0157fdce	66
c09f0b57	67	/--- hwdriver.c ------------------------------------------------------------/
aa0b6b20	68
cfe064d8	69	SR_API struct sr_dev_driver **sr_driver_list(void);
44fc870c PS	70	SR_API int sr_driver_init(struct sr_context *ctx,
44fc870c PS	71	struct sr_dev_driver *driver);
80bf0426	72	SR_API GSList sr_driver_scan(struct sr_dev_driver driver, GSList *options);
8f996b89 ML	73	SR_API int sr_config_get(const struct sr_dev_driver *driver,
8f996b89 ML	74	const struct sr_dev_inst *sdi,
53b4680f	75	const struct sr_channel_group *cg,
584560f1	76	uint32_t key, GVariant **data);
8f996b89	77	SR_API int sr_config_set(const struct sr_dev_inst *sdi,
53b4680f	78	const struct sr_channel_group *cg,
584560f1	79	uint32_t key, GVariant *data);
2a854d71	80	SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
8f996b89 ML	81	SR_API int sr_config_list(const struct sr_dev_driver *driver,
8f996b89 ML	82	const struct sr_dev_inst *sdi,
53b4680f	83	const struct sr_channel_group *cg,
584560f1 BV	84	uint32_t key, GVariant **data);
584560f1 BV	85	SR_API const struct sr_config_info *sr_config_info_get(uint32_t key);
c89c1c9c	86	SR_API const struct sr_config_info sr_config_info_name_get(const char optname);
10509bc2 BV	87
	88	/--- session.c -------------------------------------------------------------/
	89
144f6660	90	typedef void (sr_datafeed_callback)(const struct sr_dev_inst sdi,
2726474a	91	const struct sr_datafeed_packet packet, void cb_data);
0812c40e	92	SR_API struct sr_trigger sr_session_trigger_get(struct sr_session session);
10509bc2 BV	93
10509bc2 BV	94	/* Session setup */
0812c40e ML	95	SR_API int sr_session_load(const char filename, struct sr_session *session);
	96	SR_API int sr_session_new(struct sr_session **session);
	97	SR_API int sr_session_destroy(struct sr_session *session);
	98	SR_API int sr_session_dev_remove_all(struct sr_session *session);
	99	SR_API int sr_session_dev_add(struct sr_session *session,
	100	struct sr_dev_inst *sdi);
	101	SR_API int sr_session_dev_list(struct sr_session session, GSList *devlist);
	102	SR_API int sr_session_trigger_set(struct sr_session session, struct sr_trigger trig);
10509bc2	103
10509bc2	104	/* Datafeed setup */
0812c40e ML	105	SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
	106	SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
	107	sr_datafeed_callback cb, void *cb_data);
10509bc2 BV	108
10509bc2 BV	109	/* Session control */
0812c40e ML	110	SR_API int sr_session_start(struct sr_session *session);
	111	SR_API int sr_session_run(struct sr_session *session);
	112	SR_API int sr_session_stop(struct sr_session *session);
	113	SR_API int sr_session_save(struct sr_session session, const char filename,
	114	const struct sr_dev_inst sdi, unsigned char buf, int unitsize,
	115	int units);
	116	SR_API int sr_session_save_init(struct sr_session *session,
	117	const char filename, uint64_t samplerate, char *channels);
	118	SR_API int sr_session_append(struct sr_session *session,
	119	const char filename, unsigned char buf, int unitsize, int units);
	120	SR_API int sr_session_source_add(struct sr_session *session, int fd,
	121	int events, int timeout, sr_receive_data_callback cb, void *cb_data);
	122	SR_API int sr_session_source_add_pollfd(struct sr_session *session,
	123	GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
	124	void *cb_data);
	125	SR_API int sr_session_source_add_channel(struct sr_session *session,
	126	GIOChannel *channel, int events, int timeout,
144f6660	127	sr_receive_data_callback cb, void *cb_data);
0812c40e ML	128	SR_API int sr_session_source_remove(struct sr_session *session, int fd);
	129	SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
	130	GPollFD *pollfd);
	131	SR_API int sr_session_source_remove_channel(struct sr_session *session,
	132	GIOChannel *channel);
10509bc2	133
aa0b6b20	134	/--- input/input.c ---------------------------------------------------------/
10509bc2	135
17bfaca6 BV	136	SR_API const struct sr_input_module **sr_input_list(void);
	137	SR_API const char sr_input_id_get(const struct sr_input_module in);
	138	SR_API const char sr_input_name_get(const struct sr_input_module in);
	139	SR_API const char sr_input_description_get(const struct sr_input_module in);
	140	SR_API const struct sr_input_module sr_input_find(char id);
bd0bfaaf BV	141	SR_API const struct sr_option *sr_input_options_get(const struct sr_input_module in);
bd0bfaaf BV	142	SR_API void sr_input_options_free(const struct sr_option **options);
17bfaca6 BV	143	SR_API struct sr_input sr_input_new(const struct sr_input_module imod,
17bfaca6 BV	144	GHashTable *options);
4f979115 BV	145	SR_API int sr_input_scan_buffer(GString buf, const struct sr_input *in);
4f979115 BV	146	SR_API int sr_input_scan_file(const char filename, const struct sr_input *in);
17bfaca6 BV	147	SR_API struct sr_dev_inst sr_input_dev_inst_get(const struct sr_input in);
17bfaca6 BV	148	SR_API int sr_input_send(const struct sr_input in, GString buf);
7066fd46	149	SR_API int sr_input_end(const struct sr_input *in);
d5cc282f	150	SR_API void sr_input_free(const struct sr_input *in);
aa0b6b20 UH	151
	152	/--- output/output.c -------------------------------------------------------/
	153
a755b0e1 BV	154	SR_API const struct sr_output_module **sr_output_list(void);
	155	SR_API const char sr_output_id_get(const struct sr_output_module o);
	156	SR_API const char sr_output_name_get(const struct sr_output_module o);
	157	SR_API const char sr_output_description_get(const struct sr_output_module o);
	158	SR_API const struct sr_output_module sr_output_find(char id);
fc746430 BV	159	SR_API const struct sr_option *sr_output_options_get(const struct sr_output_module o);
fc746430 BV	160	SR_API void sr_output_options_free(const struct sr_option **opts);
a755b0e1	161	SR_API const struct sr_output sr_output_new(const struct sr_output_module o,
dba3e682	162	GHashTable params, const struct sr_dev_inst sdi);
a755b0e1	163	SR_API int sr_output_send(const struct sr_output *o,
dba3e682	164	const struct sr_datafeed_packet packet, GString *out);
a755b0e1	165	SR_API int sr_output_free(const struct sr_output *o);
aa0b6b20	166
7b5e6d29 BV	167	/--- trigger.c -------------------------------------------------------------/
7b5e6d29 BV	168
00ebcbf4	169	SR_API struct sr_trigger sr_trigger_new(const char name);
7b5e6d29	170	SR_API void sr_trigger_free(struct sr_trigger *trig);
a153d6b8	171	SR_API struct sr_trigger_stage sr_trigger_stage_add(struct sr_trigger trig);
7b5e6d29 BV	172	SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
	173	struct sr_channel *ch, int trigger_match, float value);
	174
bb7ef793	175	/--- strutil.c -------------------------------------------------------------/
aa0b6b20	176
4cc9aea1	177	SR_API char sr_si_string_u64(uint64_t x, const char unit);
1a081ca6 UH	178	SR_API char *sr_samplerate_string(uint64_t samplerate);
1a081ca6 UH	179	SR_API char *sr_period_string(uint64_t frequency);
e0e15067	180	SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
1a081ca6 UH	181	SR_API int sr_parse_sizestring(const char sizestring, uint64_t size);
	182	SR_API uint64_t sr_parse_timestring(const char *timestring);
	183	SR_API gboolean sr_parse_boolstring(const char *boolstring);
76e107d6 BV	184	SR_API int sr_parse_period(const char periodstr, uint64_t p, uint64_t *q);
76e107d6 BV	185	SR_API int sr_parse_voltage(const char voltstr, uint64_t p, uint64_t *q);
10509bc2	186
787c4390 UH	187	/--- version.c -------------------------------------------------------------/
	188
	189	SR_API int sr_package_version_major_get(void);
	190	SR_API int sr_package_version_minor_get(void);
	191	SR_API int sr_package_version_micro_get(void);
	192	SR_API const char *sr_package_version_string_get(void);
	193
	194	SR_API int sr_lib_version_current_get(void);
	195	SR_API int sr_lib_version_revision_get(void);
	196	SR_API int sr_lib_version_age_get(void);
	197	SR_API const char *sr_lib_version_string_get(void);
	198
b5a8e848 UH	199	/--- error.c ---------------------------------------------------------------/
	200
	201	SR_API const char *sr_strerror(int error_code);
	202	SR_API const char *sr_strerror_name(int error_code);
	203
c2bd92ec	204	#endif