]> sigrok.org Git - libsigrok.git/blobdiff - sigrok-proto.h
sr: adjust copyright year
[libsigrok.git] / sigrok-proto.h
index e007fd323ff58fcb4b467cad2bf4501ea42c8af4..bb32fc7e15865010cda2456f47950afb370158ca 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * 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_exit(void);
+SR_API int sr_init(void);
+SR_API int sr_exit(void);
+
+/*--- log.c -----------------------------------------------------------------*/
+
+typedef int (*sr_log_handler_t)(void *data, int loglevel, const char *format,
+                                va_list args);
+
+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);
 
 /*--- datastore.c -----------------------------------------------------------*/
 
-int sr_datastore_new(int unitsize, struct sr_datastore **ds);
-int sr_datastore_destroy(struct sr_datastore *ds);
-void sr_datastore_put(struct sr_datastore *ds, void *data, unsigned int length,
-                     int in_unitsize, int *probelist);
+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);
 
 /*--- device.c --------------------------------------------------------------*/
 
-void sr_device_scan(void);
-int sr_device_plugin_init(struct sr_device_plugin *plugin);
-void sr_device_close_all(void);
-GSList *sr_device_list(void);
-struct sr_device *sr_device_new(struct sr_device_plugin *plugin,
-                               int plugin_index, int num_probes);
-void sr_device_clear(struct sr_device *device);
-void sr_device_destroy(struct sr_device *dev);
-
-void sr_device_probe_clear(struct sr_device *device, int probenum);
-void sr_device_probe_add(struct sr_device *device, const char *name);
-struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum);
-void sr_device_probe_name(struct sr_device *device, int probenum,
-                         const char *name);
-
-void sr_device_trigger_clear(struct sr_device *device);
-void sr_device_trigger_set(struct sr_device *device, int probenum,
-                          const char *trigger);
-gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap);
+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 sr_filter_probes(int in_unitsize, int out_unitsize, int *probelist,
-                    const 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 ------------------------------------------------------------*/
 
-GSList *sr_list_hwplugins(void);
-
-/* 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);
-
-/* USB-specific instances */
-#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 sr_usb_device_instance_free(struct sr_usb_device_instance *usb);
-#endif
-
-/* 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);
-
-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,
-                  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 sr_device *device,
-                                struct sr_datafeed_packet *packet);
+typedef void (*sr_datafeed_callback) (struct sr_device *device,
+                                     struct sr_datafeed_packet *packet);
 
 /* Session setup */
-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);
-
-/* Protocol analyzers setup */
-void sr_session_pa_clear(void);
-void sr_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 sr_session_datafeed_callback_clear(void);
-void sr_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 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,
-               receive_data_callback callback, void *user_data);
-void sr_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 callback, void *user_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);
 
-/*--- output/common.c -------------------------------------------------------*/
+/*--- strutil.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);
-uint64_t sr_parse_sizestring(const char *sizestring);
-uint64_t sr_parse_timestring(const char *timestring);
+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