]> sigrok.org Git - libsigrok.git/blobdiff - proto.h
Bump copyright year
[libsigrok.git] / proto.h
diff --git a/proto.h b/proto.h
index 3481c582756b2a3aa18c3a522e27731e7baaee3b..ed72d4b320ea312cdcb3ce89e4f25660e90896ee 100644 (file)
--- a/proto.h
+++ b/proto.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok 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
 #ifndef LIBSIGROK_SIGROK_PROTO_H
 #define LIBSIGROK_SIGROK_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 -----------------------------------------------------------------*/
 
@@ -37,56 +43,51 @@ 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);
 
-/*--- 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_trigger_remove_all(struct sr_dev *dev);
-SR_API int sr_dev_trigger_set(struct sr_dev *dev, int probenum,
-                             const char *trigger);
-SR_API gboolean sr_dev_has_hwcap(const struct sr_dev *dev, int hwcap);
-SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data);
+SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
+               int probenum, const char *name);
+SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
+               gboolean state);
+SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
+               const char *trigger);
+SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
+SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver);
+SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver);
 
 /*--- 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_probes(unsigned int in_unitsize, unsigned int out_unitsize,
+                           const GArray *probe_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 gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap);
-SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap);
+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, int key,
+               const void **data, const struct sr_dev_inst *sdi);
+SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
+               const void *value);
+SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
+               const void **data, const struct sr_dev_inst *sdi);
+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)(struct sr_dev *dev,
-                                      struct sr_datafeed_packet *packet);
+typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi,
+               const struct sr_datafeed_packet *packet);
 
 /* 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);
 
 /* Datafeed setup */
 SR_API int sr_session_datafeed_callback_remove_all(void);
@@ -95,12 +96,18 @@ SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
 /* 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_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,
+               sr_receive_data_callback_t cb, void *cb_data);
+SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
+               int timeout, sr_receive_data_callback_t 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 ---------------------------------------------------------*/
 
@@ -112,11 +119,12 @@ SR_API struct sr_output_format **sr_output_list(void);
 
 /*--- 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_parse_triggerstring(struct sr_dev *dev,
-                                    const char *triggerstring);
+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);
@@ -135,4 +143,9 @@ 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