X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=49703757d264b56bfd0c8ff8aba20be2c6b5435b;hb=71e16f47e3b02a4d2a8208ab02ee183ac6162137;hp=7fc48cfdede3a1e8f46e5282b463048f44d20470;hpb=f0de2dd0fa67b61e755b04657b132282acc1c9a0;p=libsigrok.git

diff --git a/libsigrok.h b/libsigrok.h
index 7fc48cfd..49703757 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -64,16 +64,16 @@ extern "C" {
 
 /** Status/error codes returned by libsigrok functions. */
 enum {
-	SR_OK             =  0, /**< No error. */
-	SR_ERR            = -1, /**< Generic/unspecified error. */
-	SR_ERR_MALLOC     = -2, /**< Malloc/calloc/realloc error. */
-	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. */
-	SR_ERR_TIMEOUT    = -8, /**< A timeout occurred. */
-	SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
+	SR_OK                =  0, /**< No error. */
+	SR_ERR               = -1, /**< Generic/unspecified error. */
+	SR_ERR_MALLOC        = -2, /**< Malloc/calloc/realloc error. */
+	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 must be open. */
+	SR_ERR_TIMEOUT       = -8, /**< A timeout occurred. */
+	SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
 
 	/*
 	 * Note: When adding entries here, don't forget to also update the
@@ -81,7 +81,7 @@ enum {
 	 */
 };
 
-#define SR_MAX_PROBENAME_LEN 32
+#define SR_MAX_CHANNELNAME_LEN 32
 
 /* Handy little macros */
 #define SR_HZ(n)  (n)
@@ -340,8 +340,8 @@ struct sr_datafeed_logic {
 
 /** Analog datafeed payload for type SR_DF_ANALOG. */
 struct sr_datafeed_analog {
-	/** The probes for which data is included in this packet. */
-	GSList *probes;
+	/** The channels for which data is included in this packet. */
+	GSList *channels;
 	/** Number of samples in data */
 	int num_samples;
 	/** Measured quantity (voltage, current, temperature, and so on).
@@ -352,7 +352,7 @@ struct sr_datafeed_analog {
 	/** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
 	uint64_t mqflags;
 	/** The analog value(s). The data is interleaved according to
-	 * the probes list. */
+	 * the channels list. */
 	float *data;
 };
 
@@ -438,7 +438,7 @@ struct sr_output {
 
 	/**
 	 * The device for which this output module is creating output. This
-	 * can be used by the module to find out probe names and numbers.
+	 * can be used by the module to find out channel names and numbers.
 	 */
 	struct sr_dev_inst *sdi;
 
@@ -597,35 +597,34 @@ struct sr_output_format {
 	int (*cleanup) (struct sr_output *o);
 };
 
-/** Constants for probe type. */
+/** Constants for channel type. */
 enum {
-	/** Probe type is logic probe. */
-    SR_PROBE_LOGIC = 10000,
-	/** Probe type is analog probe. */
-    SR_PROBE_ANALOG,
+	/** Channel type is logic channel. */
+	SR_CHANNEL_LOGIC = 10000,
+	/** Channel type is analog channel. */
+	SR_CHANNEL_ANALOG,
 };
 
-/** Information on single probe. */
-struct sr_probe {
-	/** Number of probes, starting at 0. @deprecated The index field
-	 * will go: use g_slist_length(sdi->probes) instead. */
+/** Information on single channel. */
+struct sr_channel {
+	/** Number of channels, starting at 0. */
 	int index;
-	/** Probe type (SR_PROBE_LOGIC, ...) */
+	/** Channel type (SR_CHANNEL_LOGIC, ...) */
 	int type;
-	/** Is this probe enabled? */
+	/** Is this channel enabled? */
 	gboolean enabled;
-	/** Name of probe. */
+	/** Name of channel. */
 	char *name;
 	/** Trigger string, format like used by sigrok-cli */
 	char *trigger;
 };
 
-/** Structure for groups of probes that have common properties. */
-struct sr_probe_group {
-	/** Name of the probe group. */
+/** Structure for groups of channels that have common properties. */
+struct sr_channel_group {
+	/** Name of the channel group. */
 	char *name;
-	/** List of sr_probe structs of the probes belonging to this group. */
-	GSList *probes;
+	/** List of sr_channel structs of the channels belonging to this group. */
+	GSList *channels;
 	/** Private data for driver use. */
 	void *priv;
 };
@@ -804,11 +803,11 @@ enum {
 	 */
 	SR_CONF_CENTER_FREQUENCY,
 
-	/** The device supports setting the number of logic probes. */
-	SR_CONF_NUM_LOGIC_PROBES,
+	/** The device supports setting the number of logic channels. */
+	SR_CONF_NUM_LOGIC_CHANNELS,
 
-	/** The device supports setting the number of analog probes. */
-	SR_CONF_NUM_ANALOG_PROBES,
+	/** The device supports setting the number of analog channels. */
+	SR_CONF_NUM_ANALOG_CHANNELS,
 
 	/** Output voltage. */
 	SR_CONF_OUTPUT_VOLTAGE,
@@ -834,6 +833,9 @@ enum {
 	/** Over-current protection (OCP) */
 	SR_CONF_OVER_CURRENT_PROTECTION,
 
+	/** Choice of clock edge for external clock ("r" or "f"). */
+	SR_CONF_CLOCK_EDGE,
+
 	/*--- Special stuff -------------------------------------------------*/
 
 	/** Scan options supported by the driver. */
@@ -917,10 +919,10 @@ struct sr_dev_inst {
 	char *model;
 	/** Device version. */
 	char *version;
-	/** List of probes. */
-	GSList *probes;
-	/** List of sr_probe_group structs */
-	GSList *probe_groups;
+	/** List of channels. */
+	GSList *channels;
+	/** List of sr_channel_group structs */
+	GSList *channel_groups;
 	/** Device instance connection data (used?) */
 	void *conn;
 	/** Device instance private data (used?) */
@@ -951,48 +953,73 @@ enum {
 	SR_ST_STOPPING,
 };
 
-/** Device driver data */
+/** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
 struct sr_dev_driver {
 	/* Driver-specific */
-	/** Driver name */
+	/** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
 	char *name;
-	/** Long name, e.g. device name. */
+	/** Long name. Verbose driver name shown to user. */
 	char *longname;
 	/** API version (currently 1).	*/
 	int api_version;
-	/** Init driver */
+	/** Called when driver is loaded, e.g. program startup. */
 	int (*init) (struct sr_context *sr_ctx);
-	/** Free driver */
+	/** Called before driver is unloaded.
+	 *  Driver must free all resouces held by it. */
 	int (*cleanup) (void);
-	/** Scan for devices */
+	/** Scan for devices. Driver should do all initialisation required.
+	 *  Can be called several times, e.g. with different port options.
+	 *  \retval NULL Error or no devices found.
+	 *  \retval other GSList of a struct sr_dev_inst for each device.
+	 *                Must be freed by caller!
+	 */
 	GSList *(*scan) (GSList *options);
-	/** Get device list */
+	/** Get list of device instances the driver knows about.
+	 *  \returns NULL or GSList of a struct sr_dev_inst for each device.
+	 *           Must not be freed by caller!
+	 */
 	GSList *(*dev_list) (void);
+	/** Clear list of devices the driver knows about. */
 	int (*dev_clear) (void);
+	/** Query value of a configuration key in driver or given device instance.
+	 *  @see sr_config_get().
+	 */
 	int (*config_get) (int id, GVariant **data,
 			const struct sr_dev_inst *sdi,
-			const struct sr_probe_group *probe_group);
+			const struct sr_channel_group *cg);
+	/** Set value of a configuration key in driver or a given device instance.
+	 *  @see sr_config_set(). */
 	int (*config_set) (int id, GVariant *data,
 			const struct sr_dev_inst *sdi,
-			const struct sr_probe_group *probe_group);
+			const struct sr_channel_group *cg);
+	/** Channel status change.
+	 *  @see sr_dev_channel_enable(), sr_dev_trigger_set(). */
+	int (*config_channel_set) (const struct sr_dev_inst *sdi,
+			struct sr_channel *ch, unsigned int changes);
+	/** Apply configuration settings to the device hardware.
+	 *  @see sr_config_commit().*/
+	int (*config_commit) (const struct sr_dev_inst *sdi);
+	/** List all possible values for a configuration key in a device instance.
+	 *  @see sr_config_list().
+	 */
 	int (*config_list) (int info_id, GVariant **data,
 			const struct sr_dev_inst *sdi,
-			const struct sr_probe_group *probe_group);
+			const struct sr_channel_group *cg);
 
 	/* Device-specific */
 	/** Open device */
 	int (*dev_open) (struct sr_dev_inst *sdi);
 	/** Close device */
 	int (*dev_close) (struct sr_dev_inst *sdi);
-	/** Start data aquisition. */
+	/** Begin data acquisition on the specified device. */
 	int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
 			void *cb_data);
-	/** Stop data aquisition. */
+	/** End data acquisition on the specified device. */
 	int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
 			void *cb_data);
 
 	/* Dynamic */
-	/** Device driver private data */
+	/** Device driver private data. Initialized by init(). */
 	void *priv;
 };