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

/*--- analog.c --------------------------------------------------------------*/

SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
		float *buf);
SR_API int sr_analog_float_to_string(float value, int digits, char *outbuf,
		int bufsize);

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

SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
		const char *model, const char *version);
SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);

/*--- 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
	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	/--- analog.c --------------------------------------------------------------/
	30
	31	SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
	32	float *buf);
	33	SR_API int sr_analog_float_to_string(float value, int digits, char *outbuf,
	34	int bufsize);
	35
	36	/--- backend.c -------------------------------------------------------------/
	37
	38	SR_API int sr_init(struct sr_context **ctx);
	39	SR_API int sr_exit(struct sr_context *ctx);
	40
	41	/--- log.c -----------------------------------------------------------------/
	42
	43	typedef int (sr_log_callback)(void cb_data, int loglevel,
	44	const char *format, va_list args);
	45
	46	SR_API int sr_log_loglevel_set(int loglevel);
	47	SR_API int sr_log_loglevel_get(void);
	48	SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
	49	SR_API int sr_log_callback_set_default(void);
	50	SR_API int sr_log_logdomain_set(const char *logdomain);
	51	SR_API char *sr_log_logdomain_get(void);
	52
	53	/--- device.c --------------------------------------------------------------/
	54
	55	SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
	56	int channelnum, const char *name);
	57	SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
	58	gboolean state);
	59	SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
	60	SR_API GSList sr_dev_list(const struct sr_dev_driver driver);
	61	SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
	62	SR_API int sr_dev_open(struct sr_dev_inst *sdi);
	63	SR_API int sr_dev_close(struct sr_dev_inst *sdi);
	64
	65	SR_API struct sr_dev_driver sr_dev_inst_driver_get(const struct sr_dev_inst sdi);
	66	SR_API const char sr_dev_inst_vendor_get(const struct sr_dev_inst sdi);
	67	SR_API const char sr_dev_inst_model_get(const struct sr_dev_inst sdi);
	68	SR_API const char sr_dev_inst_version_get(const struct sr_dev_inst sdi);
	69	SR_API const char sr_dev_inst_sernum_get(const struct sr_dev_inst sdi);
	70	SR_API const char sr_dev_inst_connid_get(const struct sr_dev_inst sdi);
	71	SR_API GSList sr_dev_inst_channels_get(const struct sr_dev_inst sdi);
	72	SR_API GSList sr_dev_inst_channel_groups_get(const struct sr_dev_inst sdi);
	73
	74	SR_API struct sr_dev_inst sr_dev_inst_user_new(const char vendor,
	75	const char model, const char version);
	76	SR_API int sr_dev_inst_channel_add(struct sr_dev_inst sdi, int index, int type, const char name);
	77
	78	/--- hwdriver.c ------------------------------------------------------------/
	79
	80	SR_API struct sr_dev_driver **sr_driver_list(void);
	81	SR_API int sr_driver_init(struct sr_context *ctx,
	82	struct sr_dev_driver *driver);
	83	SR_API GSList sr_driver_scan(struct sr_dev_driver driver, GSList *options);
	84	SR_API int sr_config_get(const struct sr_dev_driver *driver,
	85	const struct sr_dev_inst *sdi,
	86	const struct sr_channel_group *cg,
	87	uint32_t key, GVariant **data);
	88	SR_API int sr_config_set(const struct sr_dev_inst *sdi,
	89	const struct sr_channel_group *cg,
	90	uint32_t key, GVariant *data);
	91	SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
	92	SR_API int sr_config_list(const struct sr_dev_driver *driver,
	93	const struct sr_dev_inst *sdi,
	94	const struct sr_channel_group *cg,
	95	uint32_t key, GVariant **data);
	96	SR_API const struct sr_config_info *sr_config_info_get(uint32_t key);
	97	SR_API const struct sr_config_info sr_config_info_name_get(const char optname);
	98
	99	/--- session.c -------------------------------------------------------------/
	100
	101	typedef void (sr_datafeed_callback)(const struct sr_dev_inst sdi,
	102	const struct sr_datafeed_packet packet, void cb_data);
	103	SR_API struct sr_trigger sr_session_trigger_get(struct sr_session session);
	104
	105	/* Session setup */
	106	SR_API int sr_session_load(const char filename, struct sr_session *session);
	107	SR_API int sr_session_new(struct sr_session **session);
	108	SR_API int sr_session_destroy(struct sr_session *session);
	109	SR_API int sr_session_dev_remove_all(struct sr_session *session);
	110	SR_API int sr_session_dev_add(struct sr_session *session,
	111	struct sr_dev_inst *sdi);
	112	SR_API int sr_session_dev_list(struct sr_session session, GSList *devlist);
	113	SR_API int sr_session_trigger_set(struct sr_session session, struct sr_trigger trig);
	114
	115	/* Datafeed setup */
	116	SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
	117	SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
	118	sr_datafeed_callback cb, void *cb_data);
	119
	120	/* Session control */
	121	SR_API int sr_session_start(struct sr_session *session);
	122	SR_API int sr_session_run(struct sr_session *session);
	123	SR_API int sr_session_stop(struct sr_session *session);
	124	SR_API int sr_session_save(struct sr_session session, const char filename,
	125	const struct sr_dev_inst sdi, unsigned char buf, int unitsize,
	126	int units);
	127	SR_API int sr_session_save_init(struct sr_session *session,
	128	const char filename, uint64_t samplerate, char *channels);
	129	SR_API int sr_session_append(struct sr_session *session,
	130	const char filename, unsigned char buf, int unitsize, int units);
	131	SR_API int sr_session_source_add(struct sr_session *session, int fd,
	132	int events, int timeout, sr_receive_data_callback cb, void *cb_data);
	133	SR_API int sr_session_source_add_pollfd(struct sr_session *session,
	134	GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
	135	void *cb_data);
	136	SR_API int sr_session_source_add_channel(struct sr_session *session,
	137	GIOChannel *channel, int events, int timeout,
	138	sr_receive_data_callback cb, void *cb_data);
	139	SR_API int sr_session_source_remove(struct sr_session *session, int fd);
	140	SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
	141	GPollFD *pollfd);
	142	SR_API int sr_session_source_remove_channel(struct sr_session *session,
	143	GIOChannel *channel);
	144
	145	/--- input/input.c ---------------------------------------------------------/
	146
	147	SR_API const struct sr_input_module **sr_input_list(void);
	148	SR_API const char sr_input_id_get(const struct sr_input_module in);
	149	SR_API const char sr_input_name_get(const struct sr_input_module in);
	150	SR_API const char sr_input_description_get(const struct sr_input_module in);
	151	SR_API const struct sr_input_module sr_input_find(char id);
	152	SR_API const struct sr_option *sr_input_options_get(const struct sr_input_module in);
	153	SR_API void sr_input_options_free(const struct sr_option **options);
	154	SR_API struct sr_input sr_input_new(const struct sr_input_module imod,
	155	GHashTable *options);
	156	SR_API int sr_input_scan_buffer(GString buf, const struct sr_input *in);
	157	SR_API int sr_input_scan_file(const char filename, const struct sr_input *in);
	158	SR_API struct sr_dev_inst sr_input_dev_inst_get(const struct sr_input in);
	159	SR_API int sr_input_send(const struct sr_input in, GString buf);
	160	SR_API int sr_input_end(const struct sr_input *in);
	161	SR_API void sr_input_free(const struct sr_input *in);
	162
	163	/--- output/output.c -------------------------------------------------------/
	164
	165	SR_API const struct sr_output_module **sr_output_list(void);
	166	SR_API const char sr_output_id_get(const struct sr_output_module o);
	167	SR_API const char sr_output_name_get(const struct sr_output_module o);
	168	SR_API const char sr_output_description_get(const struct sr_output_module o);
	169	SR_API const struct sr_output_module sr_output_find(char id);
	170	SR_API const struct sr_option *sr_output_options_get(const struct sr_output_module o);
	171	SR_API void sr_output_options_free(const struct sr_option **opts);
	172	SR_API const struct sr_output sr_output_new(const struct sr_output_module o,
	173	GHashTable params, const struct sr_dev_inst sdi);
	174	SR_API int sr_output_send(const struct sr_output *o,
	175	const struct sr_datafeed_packet packet, GString *out);
	176	SR_API int sr_output_free(const struct sr_output *o);
	177
	178	/--- trigger.c -------------------------------------------------------------/
	179
	180	SR_API struct sr_trigger sr_trigger_new(const char name);
	181	SR_API void sr_trigger_free(struct sr_trigger *trig);
	182	SR_API struct sr_trigger_stage sr_trigger_stage_add(struct sr_trigger trig);
	183	SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
	184	struct sr_channel *ch, int trigger_match, float value);
	185
	186	/--- strutil.c -------------------------------------------------------------/
	187
	188	SR_API char sr_si_string_u64(uint64_t x, const char unit);
	189	SR_API char *sr_samplerate_string(uint64_t samplerate);
	190	SR_API char *sr_period_string(uint64_t frequency);
	191	SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
	192	SR_API int sr_parse_sizestring(const char sizestring, uint64_t size);
	193	SR_API uint64_t sr_parse_timestring(const char *timestring);
	194	SR_API gboolean sr_parse_boolstring(const char *boolstring);
	195	SR_API int sr_parse_period(const char periodstr, uint64_t p, uint64_t *q);
	196	SR_API int sr_parse_voltage(const char voltstr, uint64_t p, uint64_t *q);
	197
	198	/--- version.c -------------------------------------------------------------/
	199
	200	SR_API int sr_package_version_major_get(void);
	201	SR_API int sr_package_version_minor_get(void);
	202	SR_API int sr_package_version_micro_get(void);
	203	SR_API const char *sr_package_version_string_get(void);
	204
	205	SR_API int sr_lib_version_current_get(void);
	206	SR_API int sr_lib_version_revision_get(void);
	207	SR_API int sr_lib_version_age_get(void);
	208	SR_API const char *sr_lib_version_string_get(void);
	209
	210	/--- error.c ---------------------------------------------------------------/
	211
	212	SR_API const char *sr_strerror(int error_code);
	213	SR_API const char *sr_strerror_name(int error_code);
	214
	215	#endif