X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=device.c;h=434d1066aac692d7a8a6f732f80938cc02f7ff02;hp=e5411a45af69ff73efca16448b396bac52552001;hb=43cd4637285833706f8a404ca027bcf0ee75b9ae;hpb=2eb84c983584490153fe2bcbf10cc7ceaf46d033 diff --git a/device.c b/device.c index e5411a45..434d1066 100644 --- a/device.c +++ b/device.c @@ -23,14 +23,9 @@ #include "libsigrok.h" #include "libsigrok-internal.h" -/* Message logging helpers with subsystem-specific prefix string. */ -#define LOG_PREFIX "device: " -#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) -#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) -#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) -#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) -#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) -#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) +/** @cond PRIVATE */ +#define LOG_PREFIX "device" +/** @endcond */ /** * @file @@ -47,54 +42,54 @@ */ /** @private - * Allocate and initialize new struct sr_probe - * @param[in] index @copydoc sr_probe::index - * @param[in] type @copydoc sr_probe::type - * @param[in] enabled @copydoc sr_probe::enabled - * @param[in] name @copydoc sr_probe::name + * Allocate and initialize new struct sr_channel + * @param[in] index @copydoc sr_channel::index + * @param[in] type @copydoc sr_channel::type + * @param[in] enabled @copydoc sr_channel::enabled + * @param[in] name @copydoc sr_channel::name * - * @return NULL (failure) or new struct sr_probe*. + * @return NULL (failure) or new struct sr_channel*. */ -SR_PRIV struct sr_probe *sr_probe_new(int index, int type, +SR_PRIV struct sr_channel *sr_channel_new(int index, int type, gboolean enabled, const char *name) { - struct sr_probe *probe; + struct sr_channel *ch; - if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) { - sr_err("Probe malloc failed."); + if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) { + sr_err("Channel malloc failed."); return NULL; } - probe->index = index; - probe->type = type; - probe->enabled = enabled; + ch->index = index; + ch->type = type; + ch->enabled = enabled; if (name) - probe->name = g_strdup(name); + ch->name = g_strdup(name); - return probe; + return ch; } /** - * Set the name of the specified probe in the specified device. + * Set the name of the specified channel in the specified device. * - * If the probe already has a different name assigned to it, it will be + * If the channel already has a different name assigned to it, it will be * removed, and the new name will be saved instead. * - * @param sdi The device instance the probe is connected to. - * @param[in] probenum The number of the probe whose name to set. - * Note that the probe numbers start at 0. - * @param[in] name The new name that the specified probe should get. A copy + * @param sdi The device instance the channel is connected to. + * @param[in] channelnum The number of the channel whose name to set. + * Note that the channel numbers start at 0. + * @param[in] name The new name that the specified channel should get. A copy * of the string is made. * * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. * - * @since 0.2.0 + * @since 0.3.0 */ -SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, - int probenum, const char *name) +SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi, + int channelnum, const char *name) { GSList *l; - struct sr_probe *probe; + struct sr_channel *ch; int ret; if (!sdi) { @@ -103,11 +98,11 @@ SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, } ret = SR_ERR_ARG; - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - if (probe->index == probenum) { - g_free(probe->name); - probe->name = g_strdup(name); + for (l = sdi->channels; l; l = l->next) { + ch = l->data; + if (ch->index == channelnum) { + g_free(ch->name); + ch->name = g_strdup(name); ret = SR_OK; break; } @@ -117,71 +112,44 @@ SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, } /** - * Enable or disable a probe on the specified device. + * Enable or disable a channel on the specified device. * - * @param sdi The device instance the probe is connected to. - * @param probenum The probe number, starting from 0. - * @param state TRUE to enable the probe, FALSE to disable. + * @param sdi The device instance the channel is connected to. + * @param channelnum The channel number, starting from 0. + * @param state TRUE to enable the channel, FALSE to disable. * - * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. + * @return SR_OK on success or SR_ERR on failure. In case of invalid + * arguments, SR_ERR_ARG is returned and the channel enabled state + * remains unchanged. * - * @since 0.2.0 + * @since 0.3.0 */ -SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, +SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum, gboolean state) { GSList *l; - struct sr_probe *probe; - int ret; - - if (!sdi) - return SR_ERR_ARG; - - ret = SR_ERR_ARG; - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - if (probe->index == probenum) { - probe->enabled = state; - ret = SR_OK; - break; - } - } - - return ret; -} - -/** - * Add a trigger to the specified device (and the specified probe). - * - * If the specified probe of this device already has a trigger, it will - * be silently replaced. - * - * @param[in,out] sdi Pointer to the device instance; must not be NULL. - * @param[in] probenum Number of probe, starting at 0. - * @param[in] trigger Trigger string, in the format used by sigrok-cli - * - * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. - * - * @since 0.2.0 - */ -SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, - const char *trigger) -{ - GSList *l; - struct sr_probe *probe; + struct sr_channel *ch; int ret; + gboolean was_enabled; if (!sdi) return SR_ERR_ARG; ret = SR_ERR_ARG; - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - if (probe->index == probenum) { - /* If the probe already has a trigger, kill it first. */ - g_free(probe->trigger); - probe->trigger = g_strdup(trigger); + for (l = sdi->channels; l; l = l->next) { + ch = l->data; + if (ch->index == channelnum) { + was_enabled = ch->enabled; + ch->enabled = state; ret = SR_OK; + if (!state != !was_enabled && sdi->driver + && sdi->driver->config_channel_set) { + ret = sdi->driver->config_channel_set( + sdi, ch, SR_CHANNEL_SET_ENABLED); + /* Roll back change if it wasn't applicable. */ + if (ret == SR_ERR_ARG) + ch->enabled = was_enabled; + } break; } } @@ -217,7 +185,7 @@ SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) return FALSE; if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, - &gvar, NULL, NULL) != SR_OK) + &gvar, sdi, NULL) != SR_OK) return FALSE; ret = FALSE; @@ -262,8 +230,9 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, sdi->vendor = vendor ? g_strdup(vendor) : NULL; sdi->model = model ? g_strdup(model) : NULL; sdi->version = version ? g_strdup(version) : NULL; - sdi->probes = NULL; - sdi->probe_groups = NULL; + sdi->channels = NULL; + sdi->channel_groups = NULL; + sdi->session = NULL; sdi->conn = NULL; sdi->priv = NULL; @@ -276,19 +245,18 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, */ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) { - struct sr_probe *probe; + struct sr_channel *ch; GSList *l; - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - g_free(probe->name); - g_free(probe->trigger); - g_free(probe); + for (l = sdi->channels; l; l = l->next) { + ch = l->data; + g_free(ch->name); + g_free(ch); } - g_slist_free(sdi->probes); + g_slist_free(sdi->channels); - if (sdi->probe_groups) - g_slist_free(sdi->probe_groups); + if (sdi->channel_groups) + g_slist_free(sdi->channel_groups); g_free(sdi->vendor); g_free(sdi->model); @@ -387,6 +355,7 @@ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) } #endif +/** @private */ SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) { struct sr_usbtmc_dev_inst *usbtmc; @@ -407,6 +376,7 @@ SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) return usbtmc; } +/** @private */ SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc) { g_free(usbtmc->device); @@ -432,20 +402,31 @@ SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) } /** - * Clear all devices/instances of the specified driver. + * Clear the list of device instances a driver knows about. * - * @param driver The driver to use. Must not be NULL. + * @param driver The driver to use. This must be a pointer to one of + * the entries returned by sr_driver_list(). Must not be NULL. * - * @return SR_OK upon success, a negative error code upon errors. + * @retval SR_OK Success + * @retval SR_ERR_ARG Invalid driver * * @since 0.2.0 */ SR_API int sr_dev_clear(const struct sr_dev_driver *driver) { - if (driver && driver->dev_clear) - return driver->dev_clear(); + int ret; + + if (!driver) { + sr_err("Invalid driver."); + return SR_ERR_ARG; + } + + if (driver->dev_clear) + ret = driver->dev_clear(); else - return SR_OK; + ret = std_dev_clear(driver, NULL); + + return ret; } /**