/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef LIBSIGROK_SIGROK_PROTO_H
-#define LIBSIGROK_SIGROK_PROTO_H
+#ifndef LIBSIGROK_PROTO_H
+#define LIBSIGROK_PROTO_H
+
+/**
+ * @file
+ *
+ * Header file containing API function prototypes.
+ */
/*--- backend.c -------------------------------------------------------------*/
-SR_API int sr_init(void);
-SR_API int sr_exit(void);
+SR_API int sr_init(struct sr_context **ctx);
+SR_API int sr_exit(struct sr_context *ctx);
/*--- log.c -----------------------------------------------------------------*/
SR_API int sr_log_logdomain_set(const char *logdomain);
SR_API char *sr_log_logdomain_get(void);
-/*--- datastore.c -----------------------------------------------------------*/
-
-SR_API int sr_datastore_new(int unitsize, struct sr_datastore **ds);
-SR_API int sr_datastore_destroy(struct sr_datastore *ds);
-SR_API int sr_datastore_put(struct sr_datastore *ds, void *data,
- unsigned int length, int in_unitsize,
- const int *probelist);
-
/*--- device.c --------------------------------------------------------------*/
-SR_API int sr_dev_scan(void);
-SR_API GSList *sr_dev_list(void);
-SR_API struct sr_dev *sr_dev_new(const struct sr_dev_driver *driver,
- int driver_index);
-SR_API int sr_dev_probe_add(struct sr_dev *dev, const char *name);
-SR_API struct sr_probe *sr_dev_probe_find(const struct sr_dev *dev,
- int probenum);
-SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum,
- const char *name);
-SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
+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 int sr_dev_trigger_remove_all(struct sr_dev *dev);
-SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
+SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum,
const char *trigger);
-SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap);
-SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data);
+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);
/*--- filter.c --------------------------------------------------------------*/
-SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
- const int *probelist, const uint8_t *data_in,
+SR_API int sr_filter_channels(unsigned int in_unitsize, unsigned int out_unitsize,
+ const GArray *channel_array, const uint8_t *data_in,
uint64_t length_in, uint8_t **data_out,
uint64_t *length_out);
/*--- hwdriver.c ------------------------------------------------------------*/
SR_API struct sr_dev_driver **sr_driver_list(void);
-SR_API int sr_driver_init(struct sr_dev_driver *driver);
+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 gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap);
-SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt);
-SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap);
-SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
- const void **data, const struct sr_dev_inst *sdi);
+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_t)(const struct sr_dev_inst *sdi,
- struct sr_datafeed_packet *packet);
+ const struct sr_datafeed_packet *packet, void *cb_data);
/* 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(struct sr_dev *dev);
+SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
+SR_API int sr_session_dev_list(GSList **devlist);
/* Datafeed setup */
SR_API int sr_session_datafeed_callback_remove_all(void);
-SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t 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_halt(void);
SR_API int sr_session_stop(void);
-SR_API int sr_session_save(const char *filename);
+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_t cb, void *cb_data);
SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
/*--- 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(struct sr_rational *voltage);
+SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
const char *triggerstring);
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, struct sr_rational *r);
-SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r);
+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 -------------------------------------------------------------*/
projects / libsigrok.git / blobdiff