/*
* 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 sigrok_init(void);
-void sigrok_cleanup(void);
+SR_API int sr_init(void);
+SR_API int sr_exit(void);
-/*--- datastore.c -----------------------------------------------------------*/
+/*--- log.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);
+typedef int (*sr_log_handler_t)(void *data, int loglevel, const char *format,
+ va_list args);
-/*--- device.c --------------------------------------------------------------*/
+SR_API int sr_log_loglevel_set(int loglevel);
+SR_API int sr_log_loglevel_get(void);
+SR_API int sr_log_handler_set(sr_log_handler_t handler, void *data);
+SR_API int sr_log_handler_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);
+/*--- datastore.c -----------------------------------------------------------*/
-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);
+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,
+ int *probelist);
-void device_trigger_clear(struct device *device);
-void device_trigger_set(struct device *device, int probenum, char *trigger);
+/*--- device.c --------------------------------------------------------------*/
+
+SR_API int sr_dev_scan(void);
+SR_API GSList *sr_dev_list(void);
+SR_API struct sr_device *sr_dev_new(const struct sr_device_plugin *plugin,
+ int plugin_index);
+SR_API int sr_dev_probe_add(struct sr_device *device, const char *name);
+SR_API struct sr_probe *sr_dev_probe_find(const struct sr_device *device,
+ int probenum);
+SR_API int sr_dev_probe_name(struct sr_device *device, int probenum,
+ const char *name);
+SR_API int sr_dev_trigger_clear(struct sr_device *device);
+SR_API int sr_dev_trigger_set(struct sr_device *device, int probenum,
+ const char *trigger);
+SR_API gboolean sr_dev_has_hwcap(const struct sr_device *device, int hwcap);
+SR_API int sr_dev_get_info(const struct sr_device *device, int id,
+ const void **data);
/*--- 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);
+SR_API 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 ------------------------------------------------------------*/
-int load_hwplugins(void);
-GSList *list_hwplugins(void);
-
-/* 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);
-
-/* 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);
-
-/* 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);
-
-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 GSList *sr_list_hwplugins(void);
+SR_API int sr_init_hwplugin(struct sr_device_plugin *plugin);
+SR_API gboolean sr_has_hwcap(int *capabilities, int hwcap);
+SR_API struct sr_hwcap_option *sr_find_hwcap_option(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 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);
-
-/* 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_device_clear(void);
+SR_API int sr_session_device_add(struct sr_device *device);
/* Datafeed setup */
-void session_datafeed_callback_clear(void);
-void session_datafeed_callback_add(datafeed_callback callback);
+SR_API int sr_session_datafeed_callback_clear(void);
+SR_API int 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);
-
-/*--- hardware/common/ezusb.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);
-
-/*--- 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 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 callback, void *user_data);
+SR_API int sr_session_source_remove(int fd);
/*--- input/input.c ---------------------------------------------------------*/
-struct input_format **input_list(void);
+SR_API struct sr_input_format **sr_input_list(void);
/*--- output/output.c -------------------------------------------------------*/
-struct output_format **output_list(void);
+SR_API struct sr_output_format **sr_output_list(void);
-/*--- output/common.c -------------------------------------------------------*/
+/*--- strutil.c -------------------------------------------------------*/
-char *sigrok_samplerate_string(uint64_t samplerate);
-char *sigrok_period_string(uint64_t frequency);
+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_device *device,
+ 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);
#endif
projects / libsigrok.git / blobdiff