]> sigrok.org Git - libsigrok.git/blobdiff - sigrok-proto.h
probe names: Fix cosmetics, add docs, fix off-by-one.
[libsigrok.git] / sigrok-proto.h
index cbd49a09a70844bf7149da64ab86a26009bb8e80..557730174aa8d46068f987b5133f60c69f4f300d 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-
-#ifndef SIGROK_PROTO_H_
-#define 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);
-
+#ifndef SIGROK_SIGROK_PROTO_H
+#define SIGROK_SIGROK_PROTO_H
 
 /*--- backend.c -------------------------------------------------------------*/
 
-int sigrok_init(void);
-void sigrok_cleanup(void);
-
-/*--- debug.c ---------------------------------------------------------------*/
-
-void hexdump(unsigned char *address, int length);
+int sr_init(void);
+int sr_exit(void);
 
-struct input_format **input_list(void);
-struct output_format **output_list(void);
+/*--- log.c -----------------------------------------------------------------*/
 
-void device_scan(void);
-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);
+int sr_set_loglevel(int loglevel);
+int sr_get_loglevel(void);
 
-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 device *device);
-void device_trigger_set(struct device *device, int probenum, char *trigger);
+/*--- datastore.c -----------------------------------------------------------*/
 
-int load_hwplugins(void);
-GSList *list_hwplugins(void);
+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);
+
+/*--- device.c --------------------------------------------------------------*/
+
+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 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 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,
+#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 device *device,
-                                struct 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 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_stop(void);
-void session_bus(struct device *device, struct datafeed_packet *packet);
-void make_metadata(char *filename);
-int session_save(char *filename);
-
-/*--- hwcommon.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);
-
-GSList *list_serial_ports(void);
-int serial_open(const char *pathname, int flags);
-int serial_close(int fd);
-int serial_flush(int fd);
-void *serial_backup_params(int fd);
-void serial_restore_params(int fd, void *backup);
-int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
-                     int flowcontrol);
-
-/* 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);
+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);
 
-/*--- datastore.c -----------------------------------------------------------*/
+/*--- input/input.c ---------------------------------------------------------*/
+
+struct sr_input_format **sr_input_list(void);
+
+/*--- output/output.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);
+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 /* SIGROK_PROTO_H_ */
+#endif