probe names: Fix cosmetics, add docs, fix off-by-one.

[libsigrok.git] / sigrok-proto.h

diff --git a/sigrok-proto.h b/sigrok-proto.h
index 88c84e898f5e4e6d6a72c0b45a24f1853846a031..557730174aa8d46068f987b5133f60c69f4f300d 100644 (file)
--- a/sigrok-proto.h
+++ b/sigrok-proto.h
@@ -23,45 +23,49 @@
 /*--- backend.c -------------------------------------------------------------*/
 
 int sr_init(void);
-void sr_exit(void);
+int sr_exit(void);
+
+/*--- log.c -----------------------------------------------------------------*/
+
+int sr_set_loglevel(int loglevel);
+int sr_get_loglevel(void);
 
 /*--- datastore.c -----------------------------------------------------------*/
 
 int sr_datastore_new(int unitsize, struct sr_datastore **ds);
 int sr_datastore_destroy(struct sr_datastore *ds);
-void sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
-                     int in_unitsize, int *probelist);
+int sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
+                    int in_unitsize, int *probelist);
 
 /*--- device.c --------------------------------------------------------------*/
 
-void sr_device_scan(void);
-int sr_device_plugin_init(struct sr_device_plugin *plugin);
-void sr_device_close_all(void);
+int sr_device_scan(void);
 GSList *sr_device_list(void);
-struct sr_device *sr_device_new(struct sr_device_plugin *plugin,
-                               int plugin_index, int num_probes);
-void sr_device_clear(struct sr_device *device);
-void sr_device_destroy(struct sr_device *dev);
-
-void sr_device_probe_clear(struct sr_device *device, int probenum);
-void sr_device_probe_add(struct sr_device *device, char *name);
-struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum);
-void sr_device_probe_name(struct sr_device *device, int probenum, char *name);
-
-void sr_device_trigger_clear(struct sr_device *device);
-void sr_device_trigger_set(struct sr_device *device, int probenum,
-                          char *trigger);
-gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap);
+struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
+                               int plugin_index);
+int sr_device_clear(struct sr_device *device);
+int sr_device_probe_clear(struct sr_device *device, int probenum);
+int sr_device_probe_add(struct sr_device *device, const char *name);
+struct sr_probe *sr_device_probe_find(const struct sr_device *device,
+                                     int probenum);
+int sr_device_probe_name(struct sr_device *device, int probenum,
+                        const char *name);
+int sr_device_trigger_clear(struct sr_device *device);
+int sr_device_trigger_set(struct sr_device *device, int probenum,
+                         const char *trigger);
+gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap);
 
 /*--- filter.c --------------------------------------------------------------*/
 
-int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
-                 char *data_in, uint64_t length_in, char **data_out,
-                 uint64_t *length_out);
+int sr_filter_probes(int in_unitsize, int out_unitsize, const int *probelist,
+                    const unsigned char *data_in, uint64_t length_in,
+                    char **data_out, uint64_t *length_out);
 
 /*--- hwplugin.c ------------------------------------------------------------*/
 
 GSList *sr_list_hwplugins(void);
+int sr_init_hwplugins(struct sr_device_plugin *plugin);
+void sr_cleanup_hwplugins(void);
 
 /* Generic device instances */
 struct sr_device_instance *sr_device_instance_new(int index,
@@ -86,15 +90,12 @@ int sr_find_hwcap(int *capabilities, int hwcap);
 struct sr_hwcap_option *sr_find_hwcap_option(int hwcap);
 void sr_source_remove(int fd);
 void sr_source_add(int fd, int events, int timeout,
-                  receive_data_callback rcv_cb, void *user_data);
+                  sr_receive_data_callback rcv_cb, void *user_data);
 
 /*--- session.c -------------------------------------------------------------*/
 
-typedef void (*source_callback_remove) (int fd);
-typedef void (*source_callback_add) (int fd, int events, int timeout,
-               receive_data_callback callback, void *user_data);
-typedef void (*datafeed_callback) (struct sr_device *device,
-                                struct sr_datafeed_packet *packet);
+typedef void (*sr_datafeed_callback) (struct sr_device *device,
+                                     struct sr_datafeed_packet *packet);
 
 /* Session setup */
 int sr_session_load(const char *filename);
@@ -103,13 +104,15 @@ void sr_session_destroy(void);
 void sr_session_device_clear(void);
 int sr_session_device_add(struct sr_device *device);
 
+#if 0
 /* Protocol analyzers setup */
 void sr_session_pa_clear(void);
-void sr_session_pa_add(struct analyzer *pa);
+void sr_session_pa_add(struct sr_analyzer *pa);
+#endif
 
 /* Datafeed setup */
 void sr_session_datafeed_callback_clear(void);
-void sr_session_datafeed_callback_add(datafeed_callback callback);
+void sr_session_datafeed_callback_add(sr_datafeed_callback callback);
 
 /* Session control */
 int sr_session_start(void);
@@ -118,9 +121,9 @@ void sr_session_halt(void);
 void sr_session_stop(void);
 void sr_session_bus(struct sr_device *device,
                    struct sr_datafeed_packet *packet);
-int sr_session_save(char *filename);
+int sr_session_save(const char *filename);
 void sr_session_source_add(int fd, int events, int timeout,
-               receive_data_callback callback, void *user_data);
+               sr_receive_data_callback callback, void *user_data);
 void sr_session_source_remove(int fd);
 
 /*--- input/input.c ---------------------------------------------------------*/
@@ -137,7 +140,8 @@ char *sr_samplerate_string(uint64_t samplerate);
 char *sr_period_string(uint64_t frequency);
 char **sr_parse_triggerstring(struct sr_device *device,
                              const char *triggerstring);
-uint64_t sr_parse_sizestring(const char *sizestring);
+int sr_parse_sizestring(const char *sizestring, uint64_t *size);
 uint64_t sr_parse_timestring(const char *timestring);
+gboolean sr_parse_boolstring(const char *boolstring);
 
 #endif