README.devices: Document how to make some DMMs log.

[libsigrok.git] / proto.h

diff --git a/proto.h b/proto.h
index 667b6ecc6ed9f4dbf7d57a39ce1a164ba7f45be9..821846f223abb66e91fc0e29049245a49572feb6 100644 (file)
--- a/proto.h
+++ b/proto.h
@@ -1,7 +1,7 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 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
@@ -51,11 +51,11 @@ SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
                gboolean state);
 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
                const char *trigger);
-SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap);
-SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-               const void *value);
-SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver);
-SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver);
+SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
+SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
+SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
+SR_API int sr_dev_open(struct sr_dev_inst *sdi);
+SR_API int sr_dev_close(struct sr_dev_inst *sdi);
 
 /*--- filter.c --------------------------------------------------------------*/
 
@@ -70,18 +70,19 @@ SR_API struct sr_dev_driver **sr_driver_list(void);
 SR_API int sr_driver_init(struct sr_context *ctx,
                struct sr_dev_driver *driver);
 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
-SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
-               const void **data, const struct sr_dev_inst *sdi);
-SR_API int sr_config_list(struct sr_dev_driver *driver, int id,
-               const void **data, const struct sr_dev_inst *sdi);
-SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap);
+SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
+               GVariant **data, const struct sr_dev_inst *sdi);
+SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
+               GVariant *data);
+SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
+               GVariant **data, const struct sr_dev_inst *sdi);
 SR_API const struct sr_config_info *sr_config_info_get(int key);
 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
 
 /*--- session.c -------------------------------------------------------------*/
 
 typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi,
-               const struct sr_datafeed_packet *packet);
+               const struct sr_datafeed_packet *packet, void *cb_data);
 
 /* Session setup */
 SR_API int sr_session_load(const char *filename);
@@ -92,12 +93,12 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
 
 /* 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);
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb,
+               void *cb_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, const struct sr_dev_inst *sdi,
                unsigned char *buf, int unitsize, int units);
@@ -124,14 +125,14 @@ SR_API struct sr_output_format **sr_output_list(void);
 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
 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_voltage_string(uint64_t v_p, uint64_t v_q);
 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
                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);
+SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
+SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
 
 /*--- version.c -------------------------------------------------------------*/