]> sigrok.org Git - libsigrok.git/blobdiff - sigrok-proto.h
Consistently use _exit prefix for functions.
[libsigrok.git] / sigrok-proto.h
index baa6ea12e74fe0c1840ea309e8ce102102b0d3d4..bba85b206239464a8c177699d0953ef7979125cd 100644 (file)
 #ifndef SIGROK_SIGROK_PROTO_H
 #define SIGROK_SIGROK_PROTO_H
 
-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);
-
-char *sigrok_samplerate_string(uint64_t samplerate);
-char *sigrok_period_string(uint64_t frequency);
-
 /*--- backend.c -------------------------------------------------------------*/
 
-int sigrok_init(void);
-void sigrok_cleanup(void);
+int sr_init(void);
+void sr_exit(void);
 
-/*--- debug.c ---------------------------------------------------------------*/
+/*--- datastore.c -----------------------------------------------------------*/
 
-void hexdump(unsigned char *address, int length);
+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);
 
-struct input_format **input_list(void);
-struct output_format **output_list(void);
+/*--- device.c --------------------------------------------------------------*/
 
 void device_scan(void);
+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 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_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_trigger_clear(struct sr_device *device);
+void device_trigger_set(struct sr_device *device, int probenum, char *trigger);
 
-void device_trigger_clear(struct device *device);
-void device_trigger_set(struct device *device, int probenum, char *trigger);
+/*--- 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);
+
+/*--- hwplugin.c ------------------------------------------------------------*/
 
 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);
@@ -85,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);
@@ -105,32 +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);
 
-/*--- hwcommon.c ------------------------------------------------------------*/
+/*--- input/input.c ---------------------------------------------------------*/
 
-int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
-int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
-int ezusb_upload_firmware(libusb_device *dev, int configuration,
-                          const char *filename);
+struct sr_input_format **sr_input_list(void);
 
-/* libsigrok/hardware/common/misc.c */
-/* TODO: Should not be public. */
-int opendev2(int device_index, struct sigrok_device_instance **sdi,
-            libusb_device *dev, struct libusb_device_descriptor *des,
-            int *skip, uint16_t vid, uint16_t pid, int interface);
-int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
-            struct libusb_device_descriptor *des,
-            uint16_t vid, uint16_t pid, int interface);
+/*--- output/output.c -------------------------------------------------------*/
 
-/*--- datastore.c -----------------------------------------------------------*/
+struct sr_output_format **sr_output_list(void);
 
-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);
+/*--- output/common.c -------------------------------------------------------*/
+
+char *sr_samplerate_string(uint64_t samplerate);
+char *sr_period_string(uint64_t frequency);
 
 #endif