/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef SIGROK_SIGROK_PROTO_H
-#define SIGROK_SIGROK_PROTO_H
+#ifndef LIBSIGROK_SIGROK_PROTO_H
+#define LIBSIGROK_SIGROK_PROTO_H
/*--- backend.c -------------------------------------------------------------*/
-int sr_init(void);
-void sr_cleanup(void);
+SR_API int sr_init(void);
+SR_API int sr_exit(void);
-/*--- datastore.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);
-
-/*--- device.c --------------------------------------------------------------*/
+/*--- log.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);
+typedef int (*sr_log_callback_t)(void *cb_data, int loglevel,
+ const char *format, va_list args);
-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);
+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_trigger_clear(struct sr_device *device);
-void device_trigger_set(struct sr_device *device, int probenum, char *trigger);
-
-/*--- filter.c --------------------------------------------------------------*/
+/*--- datastore.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);
+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);
-/*--- hwplugin.c ------------------------------------------------------------*/
+/*--- device.c --------------------------------------------------------------*/
-int load_hwplugins(void);
-GSList *list_hwplugins(void);
+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);
-/* Generic device instances */
-struct sr_device_instance *sr_device_instance_new(int index,
- int status, const char *vendor, const char *model, const char *version);
-struct sr_device_instance *sr_get_device_instance(GSList *device_instances,
- int device_index);
-void sr_device_instance_free(struct sr_device_instance *sdi);
+/*--- filter.c --------------------------------------------------------------*/
-/* USB-specific instances */
-struct sr_usb_device_instance *sr_usb_device_instance_new(uint8_t bus,
- uint8_t address, struct libusb_device_handle *hdl);
-void sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
+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);
-/* Serial-specific instances */
-struct sr_serial_device_instance *sr_serial_device_instance_new(
- const char *port, int fd);
-void sr_serial_device_instance_free(struct sr_serial_device_instance *serial);
+/*--- hwdriver.c ------------------------------------------------------------*/
-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);
+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 const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap);
/*--- 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_t)(struct sr_dev *dev,
+ 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);
-
-/* Protocol analyzers setup */
-void session_pa_clear(void);
-void session_pa_add(struct analyzer *pa);
+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);
/* Datafeed setup */
-void session_datafeed_callback_clear(void);
-void session_datafeed_callback_add(datafeed_callback callback);
+SR_API int sr_session_datafeed_callback_remove_all(void);
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
/* 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);
+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);
/*--- input/input.c ---------------------------------------------------------*/
-struct sr_input_format **sr_input_list(void);
+SR_API struct sr_input_format **sr_input_list(void);
/*--- output/output.c -------------------------------------------------------*/
-struct sr_output_format **sr_output_list(void);
+SR_API struct sr_output_format **sr_output_list(void);
+
+/*--- strutil.c -------------------------------------------------------------*/
+
+SR_API char *sr_samplerate_string(uint64_t samplerate);
+SR_API char *sr_period_string(uint64_t frequency);
+SR_API char *sr_voltage_string(struct sr_rational *voltage);
+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);
+SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r);
+SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r);
+
+/*--- version.c -------------------------------------------------------------*/
-/*--- output/common.c -------------------------------------------------------*/
+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);
-char *sr_samplerate_string(uint64_t samplerate);
-char *sr_period_string(uint64_t frequency);
+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
projects / libsigrok.git / blobdiff