X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=libsigrok.h;h=79a767717f4d12746c4ad97cbb1dd9aeeb76ec02;hb=9c178ffa50da5bd6978d26989b79936dc341f308;hp=d4dd7bb65fa598f0d5a0f7fc260511fcf3de978c;hpb=0b4b41eed84be29e21b0e65c8072b546b4fdd37e;p=libsigrok.git

diff --git a/libsigrok.h b/libsigrok.h
index d4dd7bb6..79a76771 100644
--- a/libsigrok.h
+++ b/libsigrok.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
@@ -36,7 +36,7 @@ extern "C" {
  * The public libsigrok header file to be used by frontends.
  *
  * This is the only file that libsigrok users (frontends) are supposed to
- * use and #include. There are other header files which get installed with
+ * use and \#include. There are other header files which get installed with
  * libsigrok, but those are not meant to be used directly by frontends.
  *
  * The correct way to get/use the libsigrok API functions is:
@@ -70,6 +70,13 @@ enum {
 	SR_ERR_ARG        = -3, /**< Function argument error. */
 	SR_ERR_BUG        = -4, /**< Errors hinting at internal bugs. */
 	SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
+	SR_ERR_NA         = -6, /**< Not applicable. */
+	SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
+
+	/*
+	 * Note: When adding entries here, don't forget to also update the
+	 * sr_strerror() and sr_strerror_name() functions in error.c.
+	 */
 };
 
 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
@@ -136,14 +143,6 @@ enum {
 	SR_T_KEYVALUE,
 };
 
-/** Rational number data type, containing numerator and denominator values. */
-struct sr_rational {
-	/** Numerator of the rational number. */
-	uint64_t p;
-	/** Denominator of the rational number. */
-	uint64_t q;
-};
-
 /** Value for sr_datafeed_packet.type. */
 enum {
 	SR_DF_HEADER = 10000,
@@ -522,7 +521,7 @@ struct sr_probe {
 
 struct sr_config {
 	int key;
-	const void *value;
+	GVariant *data;
 };
 
 struct sr_config_info {
@@ -594,7 +593,7 @@ enum {
 
 	/*--- Device configuration ------------------------------------------*/
 
-	/** The device supports setting/changing its samplerate. */
+	/** The device supports setting its samplerate, in Hz. */
 	SR_CONF_SAMPLERATE = 30000,
 
 	/** The device supports setting a pre/post-trigger capture ratio. */
@@ -633,6 +632,15 @@ enum {
 	/** Trigger types.  */
 	SR_CONF_TRIGGER_TYPE,
 
+	/** The device supports setting its sample interval, in ms. */
+	SR_CONF_SAMPLE_INTERVAL,
+
+	/** Number of timebases, as related to SR_CONF_TIMEBASE.  */
+	SR_CONF_NUM_TIMEBASE,
+
+	/** Number of vertical divisions, as related to SR_CONF_VDIV.  */
+	SR_CONF_NUM_VDIV,
+
 	/*--- Special stuff -------------------------------------------------*/
 
 	/** Scan options supported by the driver. */
@@ -679,6 +687,10 @@ enum {
 	 * samples continuously, until explicitly stopped by a certain command.
 	 */
 	SR_CONF_CONTINUOUS,
+
+	/** The device has internal storage, into which data is logged. This
+	 * starts or stops the internal logging. */
+	SR_CONF_DATALOG,
 };
 
 struct sr_dev_inst {
@@ -690,6 +702,7 @@ struct sr_dev_inst {
 	char *model;
 	char *version;
 	GSList *probes;
+	void *conn;
 	void *priv;
 };
 
@@ -715,18 +728,6 @@ enum {
 	SR_ST_STOPPING,
 };
 
-/*
- * A device supports either a range of samplerates with steps of a given
- * granularity, or is limited to a set of defined samplerates. Use either
- * step or list, but not both.
- */
-struct sr_samplerates {
-	uint64_t low;
-	uint64_t high;
-	uint64_t step;
-	const uint64_t *list;
-};
-
 struct sr_dev_driver {
 	/* Driver-specific */
 	char *name;
@@ -737,11 +738,11 @@ struct sr_dev_driver {
 	GSList *(*scan) (GSList *options);
 	GSList *(*dev_list) (void);
 	int (*dev_clear) (void);
-	int (*config_get) (int id, const void **value,
+	int (*config_get) (int id, GVariant **data,
 			const struct sr_dev_inst *sdi);
-	int (*config_set) (int id, const void *value,
+	int (*config_set) (int id, GVariant *data,
 			const struct sr_dev_inst *sdi);
-	int (*config_list) (int info_id, const void **data,
+	int (*config_list) (int info_id, GVariant **data,
 			const struct sr_dev_inst *sdi);
 
 	/* Device-specific */
@@ -759,7 +760,7 @@ struct sr_dev_driver {
 struct sr_session {
 	/** List of struct sr_dev pointers. */
 	GSList *devs;
-	/** List of sr_receive_data_callback_t items. */
+	/** List of struct datafeed_callback pointers. */
 	GSList *datafeed_callbacks;
 	GTimeVal starttime;
 
@@ -774,6 +775,14 @@ struct sr_session {
 	struct source *sources;
 	GPollFD *pollfds;
 	int source_timeout;
+
+	/*
+	 * These are our synchronization primitives for stopping the session in
+	 * an async fashion. We need to make sure the session is stopped from
+	 * within the session thread itself.
+	 */
+	GMutex stop_mutex;
+	gboolean abort_session;
 };
 
 #include "proto.h"