Consistently use _exit prefix for functions.

[libsigrok.git] / sigrok-proto.h

diff --git a/sigrok-proto.h b/sigrok-proto.h
index ec80e404853ed51e05a5f0053ef38fd58de1b9b2..bba85b206239464a8c177699d0953ef7979125cd 100644 (file)
--- a/sigrok-proto.h
+++ b/sigrok-proto.h
@@ -22,8 +22,8 @@
 
 /*--- backend.c -------------------------------------------------------------*/
 
-int sigrok_init(void);
-void sigrok_cleanup(void);
+int sr_init(void);
+void sr_exit(void);
 
 /*--- datastore.c -----------------------------------------------------------*/
 
@@ -35,21 +35,21 @@ void datastore_put(struct datastore *ds, void *data, unsigned int length,
 /*--- device.c --------------------------------------------------------------*/
 
 void device_scan(void);
-int device_plugin_init(struct device_plugin *plugin);
+int device_plugin_init(struct sr_device_plugin *plugin);
 void device_close_all(void);
 GSList *device_list(void);
-struct device *device_new(struct device_plugin *plugin, int plugin_index,
-                         int num_probes);
-void device_clear(struct device *device);
-void device_destroy(struct device *dev);
+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);
 
-void device_probe_clear(struct device *device, int probenum);
-void device_probe_add(struct device *device, char *name);
-struct probe *probe_find(struct device *device, int probenum);
-void device_probe_name(struct device *device, int probenum, char *name);
+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);
 
-void device_trigger_clear(struct device *device);
-void device_trigger_set(struct device *device, int probenum, char *trigger);
+void device_trigger_clear(struct sr_device *device);
+void device_trigger_set(struct sr_device *device, int probenum, char *trigger);
 
 /*--- filter.c --------------------------------------------------------------*/
 
@@ -63,21 +63,21 @@ int load_hwplugins(void);
 GSList *list_hwplugins(void);
 
 /* Generic device instances */
-struct sigrok_device_instance *sigrok_device_instance_new(int index,
+struct sr_device_instance *sr_device_instance_new(int index,
        int status, const char *vendor, const char *model, const char *version);
-struct sigrok_device_instance *get_sigrok_device_instance(
-                       GSList *device_instances, int device_index);
-void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
+struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
+                                                 int device_index);
+void sr_device_instance_free(struct sr_device_instance *sdi);
 
 /* USB-specific instances */
-struct usb_device_instance *usb_device_instance_new(uint8_t bus,
+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);
 
 /* 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);
@@ -90,15 +90,15 @@ void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
 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 device *device,
-                                struct datafeed_packet *packet);
+typedef void (*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 device *device);
+int session_device_add(struct sr_device *device);
 
 /* Protocol analyzers setup */
 void session_pa_clear(void);
@@ -110,22 +110,27 @@ void session_datafeed_callback_add(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 device *device, struct datafeed_packet *packet);
+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);
 
 /*--- input/input.c ---------------------------------------------------------*/
 
-struct input_format **input_list(void);
+struct sr_input_format **sr_input_list(void);
 
 /*--- output/output.c -------------------------------------------------------*/
 
-struct output_format **output_list(void);
+struct sr_output_format **sr_output_list(void);
 
 /*--- output/common.c -------------------------------------------------------*/
 
-char *sigrok_samplerate_string(uint64_t samplerate);
-char *sigrok_period_string(uint64_t frequency);
+char *sr_samplerate_string(uint64_t samplerate);
+char *sr_period_string(uint64_t frequency);
 
 #endif