sr: Fix/document probe names.

[libsigrok.git] / sigrok-proto.h

diff --git a/sigrok-proto.h b/sigrok-proto.h
index 3e91a3fa0a4d2fa39363bbdc2e34135ddfd2609a..d5f1c0cd51a07028040354984245dcf436f5cd83 100644 (file)
--- a/sigrok-proto.h
+++ b/sigrok-proto.h
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 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
@@ -27,8 +27,15 @@ SR_API int sr_exit(void);
 
 /*--- log.c -----------------------------------------------------------------*/
 
-SR_API int sr_set_loglevel(int loglevel);
-SR_API int sr_get_loglevel(void);
+typedef int (*sr_log_handler_t)(void *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_handler_set(sr_log_handler_t handler, void *data);
+SR_API int sr_log_handler_set_default(void);
+SR_API int sr_log_logdomain_set(const char *logdomain);
+SR_API char *sr_log_logdomain_get(void);
 
 /*--- datastore.c -----------------------------------------------------------*/
 
@@ -40,23 +47,20 @@ SR_API int sr_datastore_put(struct sr_datastore *ds, void *data,
 
 /*--- device.c --------------------------------------------------------------*/
 
-SR_API int sr_device_scan(void);
-SR_API GSList *sr_device_list(void);
-SR_API struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
-                                      int plugin_index);
-SR_API int sr_device_clear(struct sr_device *device);
-SR_API int sr_device_probe_clear(struct sr_device *device, int probenum);
-SR_API int sr_device_probe_add(struct sr_device *device, const char *name);
-SR_API struct sr_probe *sr_device_probe_find(const struct sr_device *device,
-                                            int probenum);
-SR_API int sr_device_probe_name(struct sr_device *device, int probenum,
-                               const char *name);
-SR_API int sr_device_trigger_clear(struct sr_device *device);
-SR_API int sr_device_trigger_set(struct sr_device *device, int probenum,
-                                const char *trigger);
-SR_API gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap);
-SR_API int sr_device_get_info(const struct sr_device *device, int id,
-                             const void **data);
+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_plugin *plugin,
+                                int plugin_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(struct sr_dev *dev, int probenum,
+                            const char *name);
+SR_API int sr_dev_trigger_clear(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);
 
 /*--- filter.c --------------------------------------------------------------*/
 
@@ -67,34 +71,22 @@ SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
 
 /*--- hwplugin.c ------------------------------------------------------------*/
 
-SR_API GSList *sr_list_hwplugins(void);
-SR_API int sr_init_hwplugins(struct sr_device_plugin *plugin);
-SR_API void sr_cleanup_hwplugins(void);
-
-/* Generic device instances */
-SR_API struct sr_device_instance *sr_device_instance_new(int index,
-       int status, const char *vendor, const char *model, const char *version);
-SR_API struct sr_device_instance *sr_get_device_instance(
-                       GSList *device_instances, int device_index);
-SR_API void sr_device_instance_free(struct sr_device_instance *sdi);
-
-SR_API int sr_find_hwcap(int *capabilities, int hwcap);
-SR_API struct sr_hwcap_option *sr_find_hwcap_option(int hwcap);
-SR_API void sr_source_remove(int fd);
-SR_API void sr_source_add(int fd, int events, int timeout,
-                         sr_receive_data_callback rcv_cb, void *user_data);
+SR_API struct sr_dev_plugin **sr_hw_list(void);
+SR_API int sr_hw_init(struct sr_dev_plugin *plugin);
+SR_API gboolean sr_hw_has_hwcap(struct sr_dev_plugin *plugin, int hwcap);
+SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap);
 
 /*--- session.c -------------------------------------------------------------*/
 
-typedef void (*sr_datafeed_callback) (struct sr_device *device,
+typedef void (*sr_datafeed_callback) (struct sr_dev *dev,
                                      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_device_clear(void);
-SR_API int sr_session_device_add(struct sr_device *device);
+SR_API int sr_session_dev_clear(void);
+SR_API int sr_session_dev_add(struct sr_dev *dev);
 
 /* Datafeed setup */
 SR_API int sr_session_datafeed_callback_clear(void);
@@ -105,8 +97,6 @@ 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_bus(struct sr_device *device,
-                         struct sr_datafeed_packet *packet);
 SR_API int sr_session_save(const char *filename);
 SR_API int sr_session_source_add(int fd, int events, int timeout,
                sr_receive_data_callback callback, void *user_data);
@@ -120,11 +110,11 @@ SR_API struct sr_input_format **sr_input_list(void);
 
 SR_API struct sr_output_format **sr_output_list(void);
 
-/*--- output/common.c -------------------------------------------------------*/
+/*--- strutil.c -------------------------------------------------------------*/
 
 SR_API char *sr_samplerate_string(uint64_t samplerate);
 SR_API char *sr_period_string(uint64_t frequency);
-SR_API char **sr_parse_triggerstring(struct sr_device *device,
+SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
                                     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);