Move the probe naming to the creator of the device, and let each driver name its...

[libsigrok.git] / sigrok-proto.h

diff --git a/sigrok-proto.h b/sigrok-proto.h
index 4d700f3147d3ee0d3a552089e2e48a8787bb4831..557730174aa8d46068f987b5133f60c69f4f300d 100644 (file)
--- a/sigrok-proto.h
+++ b/sigrok-proto.h
@@ -23,44 +23,49 @@
 /*--- backend.c -------------------------------------------------------------*/
 
 int sr_init(void);
-void sr_cleanup(void);
+int sr_exit(void);
 
-/*--- datastore.c -----------------------------------------------------------*/
+/*--- log.c -----------------------------------------------------------------*/
 
-int datastore_new(int unitsize, struct datastore **ds);
-int datastore_destroy(struct datastore *ds);
-void datastore_put(struct datastore *ds, void *data, unsigned int length,
-                  int in_unitsize, int *probelist);
+int sr_set_loglevel(int loglevel);
+int sr_get_loglevel(void);
 
-/*--- device.c --------------------------------------------------------------*/
+/*--- datastore.c -----------------------------------------------------------*/
 
-void device_scan(void);
-int device_plugin_init(struct sr_device_plugin *plugin);
-void device_close_all(void);
-GSList *device_list(void);
-struct sr_device *device_new(struct sr_device_plugin *plugin, int plugin_index,
-                            int num_probes);
-void device_clear(struct sr_device *device);
-void device_destroy(struct sr_device *dev);
+int sr_datastore_new(int unitsize, struct sr_datastore **ds);
+int sr_datastore_destroy(struct sr_datastore *ds);
+int sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
+                    int in_unitsize, int *probelist);
 
-void device_probe_clear(struct sr_device *device, int probenum);
-void device_probe_add(struct sr_device *device, char *name);
-struct probe *probe_find(struct sr_device *device, int probenum);
-void device_probe_name(struct sr_device *device, int probenum, char *name);
+/*--- device.c --------------------------------------------------------------*/
 
-void device_trigger_clear(struct sr_device *device);
-void device_trigger_set(struct sr_device *device, int probenum, char *trigger);
+int sr_device_scan(void);
+GSList *sr_device_list(void);
+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 ------------------------------------------------------------*/
 
-int load_hwplugins(void);
-GSList *list_hwplugins(void);
+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,
@@ -70,55 +75,56 @@ struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
 void sr_device_instance_free(struct sr_device_instance *sdi);
 
 /* USB-specific instances */
-struct usb_device_instance *usb_device_instance_new(uint8_t bus,
+#ifdef HAVE_LIBUSB_1_0
+struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
                uint8_t address, struct libusb_device_handle *hdl);
-void usb_device_instance_free(struct usb_device_instance *usb);
+void sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
+#endif
 
 /* Serial-specific instances */
-struct serial_device_instance *serial_device_instance_new(
+struct sr_serial_device_instance *sr_serial_device_instance_new(
                                        const char *port, int fd);
-void serial_device_instance_free(struct serial_device_instance *serial);
+void sr_serial_device_instance_free(struct sr_serial_device_instance *serial);
 
-int find_hwcap(int *capabilities, int hwcap);
-struct hwcap_option *find_hwcap_option(int hwcap);
-void source_remove(int fd);
-void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
-               void *user_data);
+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,
+                  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 */
-struct session *session_load(const char *filename);
-struct session *session_new(void);
-void session_destroy(void);
-void session_device_clear(void);
-int session_device_add(struct sr_device *device);
+int sr_session_load(const char *filename);
+struct sr_session *sr_session_new(void);
+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 session_pa_clear(void);
-void session_pa_add(struct analyzer *pa);
+void sr_session_pa_clear(void);
+void sr_session_pa_add(struct sr_analyzer *pa);
+#endif
 
 /* Datafeed setup */
-void session_datafeed_callback_clear(void);
-void session_datafeed_callback_add(datafeed_callback callback);
+void sr_session_datafeed_callback_clear(void);
+void sr_session_datafeed_callback_add(sr_datafeed_callback callback);
 
 /* Session control */
-int session_start(void);
-void session_run(void);
-void session_halt(void);
-void session_stop(void);
-void session_bus(struct sr_device *device, struct sr_datafeed_packet *packet);
-void make_metadata(char *filename);
-int session_save(char *filename);
-void session_source_add(int fd, int events, int timeout,
-               receive_data_callback callback, void *user_data);
-void session_source_remove(int fd);
+int sr_session_start(void);
+void sr_session_run(void);
+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(const char *filename);
+void sr_session_source_add(int fd, int events, int timeout,
+               sr_receive_data_callback callback, void *user_data);
+void sr_session_source_remove(int fd);
 
 /*--- input/input.c ---------------------------------------------------------*/
 
@@ -132,5 +138,10 @@ struct sr_output_format **sr_output_list(void);
 
 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);
+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