X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=382f502b470a3a992c868a10b4730344133f864b;hb=53b4680fceab9351fc87b8c5b34854733f5fdac0;hp=af5b18ce8b4ee206463e719e4a783992666398fc;hpb=860bc59b0ff598f37f23a1882bf5822ef7c86382;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index af5b18ce..382f502b 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 @@ -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; @@ -620,12 +619,12 @@ struct sr_probe { 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_probe structs of the channels belonging to this group. */ + GSList *channels; /** Private data for driver use. */ void *priv; }; @@ -922,8 +921,8 @@ struct sr_dev_inst { char *version; /** List of probes. */ GSList *probes; - /** List of sr_probe_group structs */ - GSList *probe_groups; + /** List of sr_channel_group structs */ + GSList *channel_groups; /** Device instance connection data (used?) */ void *conn; /** Device instance private data (used?) */ @@ -954,51 +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); + /** 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); + 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; };