Add new sr_dev_options() helper function.

This function replaces the pattern of calling config_list() with
SR_CONF_DEVICE_OPTIONS to obtain a list of device options. Note
that this does not include the SR_CONF_{GET,SET,LIST} bitmask,
which is now retrieved for a specific key by calling
sr_dev_config_capabilties().
This commit is contained in:
Martin Ling 2015-11-02 00:40:40 +00:00 committed by Uwe Hermann
parent 71e9c54dab
commit e7136c626f
2 changed files with 49 additions and 0 deletions

View File

@ -58,6 +58,8 @@ SR_API int sr_dev_channel_enable(struct sr_channel *channel,
SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
SR_API int sr_dev_config_capabilities(const struct sr_dev_inst *sdi,
const struct sr_channel_group *cg, int key);
SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
SR_API int sr_dev_open(struct sr_dev_inst *sdi);

View File

@ -196,6 +196,53 @@ SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
return ret;
}
/**
* Enumerate the configuration options of the specified item.
*
* @param driver Pointer to the driver to be checked. Must not be NULL.
* @param sdi Pointer to the device instance to be checked. May be NULL to
* check driver options.
* @param cg Pointer to a channel group, if a specific channel group is to
* be checked. Must be NULL to check device-wide options.
* @return A GArray * of enum sr_configkey values, or NULL on invalid
* arguments. The array must be freed by the caller using
* g_array_free().
*
* @since 0.4.0
*/
SR_API GArray *sr_dev_options(
const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi,
const struct sr_channel_group *cg)
{
GVariant *gvar;
const uint32_t *opts;
uint32_t opt;
gsize num_opts, i;
GArray *result;
if (!driver || !driver->config_list)
return NULL;
if (sdi && sdi->driver != driver)
return NULL;
if (driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, sdi, cg) != SR_OK)
return NULL;
opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
for (i = 0; i < num_opts; i++) {
opt = opts[i] & SR_CONF_MASK;
g_array_insert_val(result, i, opt);
}
g_variant_unref(gvar);
return result;
}
/**
* Enumerate the configuration capabilities supported by a device instance
* for a given configuration key.