[libsigrok.git] / 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);

/*--- 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,
		int key, GVariant **data);
SR_API int sr_config_set(const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg,
		int 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,
		int key, GVariant **data);
SR_API const struct sr_config_info *sr_config_info_get(int 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(void);

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

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

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

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

SR_API struct sr_input_format **sr_input_list(void);

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

SR_API struct sr_output_format **sr_output_list(void);
SR_API struct sr_output *sr_output_new(struct sr_output_format *of,
		GHashTable *params, const struct sr_dev_inst *sdi);
SR_API int sr_output_send(struct sr_output *o,
		const struct sr_datafeed_packet *packet, GString **out);
SR_API int sr_output_free(struct sr_output *o);

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

SR_API struct sr_trigger *sr_trigger_new(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
	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_PROTO_H
	21	#define LIBSIGROK_PROTO_H
	22
	23	/**
	24	* @file
	25	*
	26	* Header file containing API function prototypes.
	27	*/
	28
	29	/--- backend.c -------------------------------------------------------------/
	30
	31	SR_API int sr_init(struct sr_context **ctx);
	32	SR_API int sr_exit(struct sr_context *ctx);
	33
	34	/--- log.c -----------------------------------------------------------------/
	35
	36	typedef int (sr_log_callback)(void cb_data, int loglevel,
	37	const char *format, va_list args);
	38
	39	SR_API int sr_log_loglevel_set(int loglevel);
	40	SR_API int sr_log_loglevel_get(void);
	41	SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
	42	SR_API int sr_log_callback_set_default(void);
	43	SR_API int sr_log_logdomain_set(const char *logdomain);
	44	SR_API char *sr_log_logdomain_get(void);
	45
	46	/--- device.c --------------------------------------------------------------/
	47
	48	SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
	49	int channelnum, const char *name);
	50	SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
	51	gboolean state);
	52	SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
	53	SR_API GSList sr_dev_list(const struct sr_dev_driver driver);
	54	SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
	55	SR_API int sr_dev_open(struct sr_dev_inst *sdi);
	56	SR_API int sr_dev_close(struct sr_dev_inst *sdi);
	57
	58	/--- hwdriver.c ------------------------------------------------------------/
	59
	60	SR_API struct sr_dev_driver **sr_driver_list(void);
	61	SR_API int sr_driver_init(struct sr_context *ctx,
	62	struct sr_dev_driver *driver);
	63	SR_API GSList sr_driver_scan(struct sr_dev_driver driver, GSList *options);
	64	SR_API int sr_config_get(const struct sr_dev_driver *driver,
	65	const struct sr_dev_inst *sdi,
	66	const struct sr_channel_group *cg,
	67	int key, GVariant **data);
	68	SR_API int sr_config_set(const struct sr_dev_inst *sdi,
	69	const struct sr_channel_group *cg,
	70	int key, GVariant *data);
	71	SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
	72	SR_API int sr_config_list(const struct sr_dev_driver *driver,
	73	const struct sr_dev_inst *sdi,
	74	const struct sr_channel_group *cg,
	75	int key, GVariant **data);
	76	SR_API const struct sr_config_info *sr_config_info_get(int key);
	77	SR_API const struct sr_config_info sr_config_info_name_get(const char optname);
	78
	79	/--- session.c -------------------------------------------------------------/
	80
	81	typedef void (sr_datafeed_callback)(const struct sr_dev_inst sdi,
	82	const struct sr_datafeed_packet packet, void cb_data);
	83	SR_API struct sr_trigger *sr_session_trigger_get(void);
	84
	85	/* Session setup */
	86	SR_API int sr_session_load(const char *filename);
	87	SR_API struct sr_session *sr_session_new(void);
	88	SR_API int sr_session_destroy(void);
	89	SR_API int sr_session_dev_remove_all(void);
	90	SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
	91	SR_API int sr_session_dev_list(GSList **devlist);
	92	SR_API int sr_session_trigger_set(struct sr_trigger *trig);
	93
	94	/* Datafeed setup */
	95	SR_API int sr_session_datafeed_callback_remove_all(void);
	96	SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb,
	97	void *cb_data);
	98
	99	/* Session control */
	100	SR_API int sr_session_start(void);
	101	SR_API int sr_session_run(void);
	102	SR_API int sr_session_stop(void);
	103	SR_API int sr_session_save(const char filename, const struct sr_dev_inst sdi,
	104	unsigned char *buf, int unitsize, int units);
	105	SR_API int sr_session_save_init(const char *filename, uint64_t samplerate,
	106	char **channels);
	107	SR_API int sr_session_append(const char filename, unsigned char buf,
	108	int unitsize, int units);
	109	SR_API int sr_session_source_add(int fd, int events, int timeout,
	110	sr_receive_data_callback cb, void *cb_data);
	111	SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
	112	sr_receive_data_callback cb, void *cb_data);
	113	SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
	114	int timeout, sr_receive_data_callback cb, void *cb_data);
	115	SR_API int sr_session_source_remove(int fd);
	116	SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
	117	SR_API int sr_session_source_remove_channel(GIOChannel *channel);
	118
	119	/--- input/input.c ---------------------------------------------------------/
	120
	121	SR_API struct sr_input_format **sr_input_list(void);
	122
	123	/--- output/output.c -------------------------------------------------------/
	124
	125	SR_API struct sr_output_format **sr_output_list(void);
	126	SR_API struct sr_output sr_output_new(struct sr_output_format of,
	127	GHashTable params, const struct sr_dev_inst sdi);
	128	SR_API int sr_output_send(struct sr_output *o,
	129	const struct sr_datafeed_packet packet, GString *out);
	130	SR_API int sr_output_free(struct sr_output *o);
	131
	132	/--- trigger.c -------------------------------------------------------------/
	133
	134	SR_API struct sr_trigger sr_trigger_new(char name);
	135	SR_API void sr_trigger_free(struct sr_trigger *trig);
	136	SR_API struct sr_trigger_stage sr_trigger_stage_add(struct sr_trigger trig);
	137	SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
	138	struct sr_channel *ch, int trigger_match, float value);
	139
	140	/--- strutil.c -------------------------------------------------------------/
	141
	142	SR_API char sr_si_string_u64(uint64_t x, const char unit);
	143	SR_API char *sr_samplerate_string(uint64_t samplerate);
	144	SR_API char *sr_period_string(uint64_t frequency);
	145	SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
	146	SR_API int sr_parse_sizestring(const char sizestring, uint64_t size);
	147	SR_API uint64_t sr_parse_timestring(const char *timestring);
	148	SR_API gboolean sr_parse_boolstring(const char *boolstring);
	149	SR_API int sr_parse_period(const char periodstr, uint64_t p, uint64_t *q);
	150	SR_API int sr_parse_voltage(const char voltstr, uint64_t p, uint64_t *q);
	151
	152	/--- version.c -------------------------------------------------------------/
	153
	154	SR_API int sr_package_version_major_get(void);
	155	SR_API int sr_package_version_minor_get(void);
	156	SR_API int sr_package_version_micro_get(void);
	157	SR_API const char *sr_package_version_string_get(void);
	158
	159	SR_API int sr_lib_version_current_get(void);
	160	SR_API int sr_lib_version_revision_get(void);
	161	SR_API int sr_lib_version_age_get(void);
	162	SR_API const char *sr_lib_version_string_get(void);
	163
	164	/--- error.c ---------------------------------------------------------------/
	165
	166	SR_API const char *sr_strerror(int error_code);
	167	SR_API const char *sr_strerror_name(int error_code);
	168
	169	#endif