X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=21468c875a2dac2828dc59a28e128d8ce0d63e7a;hb=1656e47def5422a5273f023d542d4d6a72668b42;hp=e43338e52dc0561985e5fb3ccc6a93643c55d472;hpb=471607f0244e93cd67097760431a0dd3d39152eb;p=libsigrok.git

diff --git a/libsigrok.h b/libsigrok.h
index e43338e5..21468c87 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -607,8 +607,7 @@ enum {
 
 /** 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. */
+	/** Number of probes, starting at 0. */
 	int index;
 	/** Probe type (SR_PROBE_LOGIC, ...) */
 	int type;
@@ -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. */
@@ -868,18 +870,6 @@ enum {
 	 */
 	SR_CONF_DATA_SOURCE,
 
-	/**
-	 * On devices without sample compression (or compression turned off),
-	 * this returns the maximum number of samples that can be stored. This
-	 * can change as probes are disabled, depending on the hardware, so
-	 * should be queried after such changes are made. If not applicable,
-	 * fetching this value with sr_config_get() will return SR_ERR_NA.
-	 *
-	 * SR_CONF_LIMIT_SAMPLES should not be set to a higher value than
-	 * this value, if applicable.
-	 */
-	SR_CONF_MAX_UNCOMPRESSED_SAMPLES,
-
 	/*--- Acquisition modes ---------------------------------------------*/
 
 	/**
@@ -963,30 +953,55 @@ 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);
+	/** 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);
+	/** Probe status change.
+	 *  @see sr_dev_probe_enable(), sr_dev_trigger_set(). */
+	int (*config_probe_set) (const struct sr_dev_inst *sdi,
+			struct sr_probe *probe, 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);
@@ -996,15 +1011,15 @@ struct sr_dev_driver {
 	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;
 };