X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=sigrok-proto.h;h=df31b90d819223d8768cf310ad4955e3d8a03125;hb=bc79e906a0911b4218b42b63b2f27fb0016c59da;hp=cbd49a09a70844bf7149da64ab86a26009bb8e80;hpb=2566bd4884bf33518488504575ba62e99ef43a7b;p=libsigrok.git diff --git a/sigrok-proto.h b/sigrok-proto.h index cbd49a09..df31b90d 100644 --- 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 + * Copyright (C) 2010-2012 Bert Vermeulen * * 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 @@ -17,132 +17,119 @@ * along with this program. If not, see . */ - -#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 LIBSIGROK_SIGROK_PROTO_H +#define LIBSIGROK_SIGROK_PROTO_H /*--- backend.c -------------------------------------------------------------*/ -int sigrok_init(void); -void sigrok_cleanup(void); +SR_API int sr_init(void); +SR_API int sr_exit(void); -/*--- debug.c ---------------------------------------------------------------*/ +/*--- log.c -----------------------------------------------------------------*/ -void hexdump(unsigned char *address, int length); +typedef int (*sr_log_callback_t)(void *cb_data, int loglevel, + const char *format, va_list args); -struct input_format **input_list(void); -struct output_format **output_list(void); +SR_API int sr_log_loglevel_set(int loglevel); +SR_API int sr_log_loglevel_get(void); +SR_API int sr_log_callback_set(sr_log_callback_t cb, void *cb_data); +SR_API int sr_log_callback_set_default(void); +SR_API int sr_log_logdomain_set(const char *logdomain); +SR_API char *sr_log_logdomain_get(void); -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); - -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); +/*--- datastore.c -----------------------------------------------------------*/ -void device_trigger_clear(struct device *device); -void device_trigger_set(struct device *device, int probenum, char *trigger); +SR_API int sr_datastore_new(int unitsize, struct sr_datastore **ds); +SR_API int sr_datastore_destroy(struct sr_datastore *ds); +SR_API int sr_datastore_put(struct sr_datastore *ds, void *data, + unsigned int length, int in_unitsize, + const int *probelist); + +/*--- device.c --------------------------------------------------------------*/ + +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_driver *driver, + int driver_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_set(struct sr_dev *dev, int probenum, + const char *name); +SR_API int sr_dev_trigger_remove_all(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 --------------------------------------------------------------*/ + +SR_API int sr_filter_probes(int in_unitsize, int out_unitsize, + const int *probelist, const uint8_t *data_in, + uint64_t length_in, uint8_t **data_out, + uint64_t *length_out); + +/*--- hwdriver.c ------------------------------------------------------------*/ + +SR_API struct sr_dev_driver **sr_driver_list(void); +SR_API int sr_driver_init(struct sr_dev_driver *driver); +SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap); +SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap); -int load_hwplugins(void); -GSList *list_hwplugins(void); +/*--- session.c -------------------------------------------------------------*/ -/* Generic device instances */ -struct sigrok_device_instance *sigrok_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); +typedef void (*sr_datafeed_callback_t)(struct sr_dev *dev, + struct sr_datafeed_packet *packet); -/* USB-specific instances */ -struct usb_device_instance *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); +/* 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_dev_remove_all(void); +SR_API int sr_session_dev_add(struct sr_dev *dev); -/* Serial-specific instances */ -struct serial_device_instance *serial_device_instance_new( - const char *port, int fd); -void serial_device_instance_free(struct serial_device_instance *serial); +/* Datafeed setup */ +SR_API int sr_session_datafeed_callback_remove_all(void); +SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb); -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); +/* Session control */ +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_save(const char *filename); +SR_API int sr_session_source_add(int fd, int events, int timeout, + sr_receive_data_callback_t cb, void *cb_data); +SR_API int sr_session_source_remove(int fd); -/*--- session.c -------------------------------------------------------------*/ +/*--- input/input.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); +SR_API struct sr_input_format **sr_input_list(void); -/* 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); +/*--- output/output.c -------------------------------------------------------*/ -/* Protocol analyzers setup */ -void session_pa_clear(void); -void session_pa_add(struct analyzer *pa); +SR_API struct sr_output_format **sr_output_list(void); -/* Datafeed setup */ -void session_datafeed_callback_clear(void); -void session_datafeed_callback_add(datafeed_callback callback); +/*--- strutil.c -------------------------------------------------------------*/ -/* 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); +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_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); +SR_API gboolean sr_parse_boolstring(const char *boolstring); -/*--- datastore.c -----------------------------------------------------------*/ +/*--- version.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); +SR_API int sr_package_version_major_get(void); +SR_API int sr_package_version_minor_get(void); +SR_API int sr_package_version_micro_get(void); +SR_API const char *sr_package_version_string_get(void); +SR_API int sr_lib_version_current_get(void); +SR_API int sr_lib_version_revision_get(void); +SR_API int sr_lib_version_age_get(void); +SR_API const char *sr_lib_version_string_get(void); -#endif /* SIGROK_PROTO_H_ */ +#endif