* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include <config.h>
#include <stdio.h>
#include <glib.h>
-#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
* @{
*/
-/** @private
- * Allocate and initialize new struct sr_channel and add to sdi.
- * @param[in] sdi The device instance the channel is connected to.
- * @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
+/**
+ * Allocate and initialize a new struct sr_channel and add it to sdi.
+ *
+ * @param[in] sdi The device instance the channel is connected to.
+ * Must not be NULL.
+ * @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 A new struct sr_channel*.
+ * @return A new struct sr_channel*.
+ *
+ * @private
*/
SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
int index, int type, gboolean enabled, const char *name)
* If the channel already has a different name assigned to it, it will be
* removed, and the new name will be saved instead.
*
- * @param[in] channel The channel whose name to set.
- * @param[in] name The new name that the specified channel should get. A
- * copy of the string is made.
+ * @param[in] channel The channel whose name to set. Must not be NULL.
+ * @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.
*
SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
const char *name)
{
- if (!channel) {
- sr_err("%s: channel was NULL", __func__);
+ if (!channel)
return SR_ERR_ARG;
- }
g_free(channel->name);
channel->name = g_strdup(name);
+
return SR_OK;
}
/**
* Enable or disable a channel.
*
- * @param[in] channel The channel to enable or disable.
- * @param[in] state TRUE to enable the channel, FALSE to disable.
+ * @param[in] channel The channel to enable or disable. Must not be NULL.
+ * @param[in] state TRUE to enable the channel, FALSE to disable.
*
- * @return SR_OK on success or SR_ERR on failure. In case of invalid
+ * @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.3.0
*/
-SR_API int sr_dev_channel_enable(struct sr_channel *channel,
- gboolean state)
+SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
{
int ret;
gboolean was_enabled;
return SR_OK;
}
+/* Returns the next enabled channel, wrapping around if necessary. */
+/** @private */
+SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
+
+ struct sr_channel *cur_channel)
+{
+ struct sr_channel *next_channel;
+ GSList *l;
+
+ next_channel = cur_channel;
+ do {
+ l = g_slist_find(sdi->channels, next_channel);
+ if (l && l->next)
+ next_channel = l->next->data;
+ else
+ next_channel = sdi->channels->data;
+ } while (!next_channel->enabled);
+
+ return next_channel;
+}
+
/**
* Determine whether the specified device instance has the specified
* capability.
* @param[in] key The option that should be checked for is supported by the
* specified device.
*
- * @retval TRUE Device has the specified option
+ * @retval TRUE Device has the specified option.
* @retval FALSE Device does not have the specified option, invalid input
* parameters or other error conditions.
*
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.
+ *
+ * @param sdi Pointer to the device instance to be checked. Must not be NULL.
+ * If the device's 'driver' field is NULL (virtual device), this
+ * function will always return FALSE (virtual devices don't have
+ * a hardware capabilities list).
+ * @param cg Pointer to a channel group, if a specific channel group is to
+ * be checked. Must be NULL to check device-wide options.
+ * @param[in] key The option that should be checked for is supported by the
+ * specified device.
+ *
+ * @retval A bitmask of enum sr_configcap values, which will be zero for
+ * invalid inputs or if the key is unsupported.
+ *
+ * @since 0.4.0
+ */
+SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
+ const struct sr_channel_group *cg, const int key)
+{
+ GVariant *gvar;
+ const int *devopts;
+ gsize num_opts, i;
+ int ret;
+
+ if (!sdi || !sdi->driver || !sdi->driver->config_list)
+ return 0;
+
+ if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
+ &gvar, sdi, cg) != SR_OK)
+ return 0;
+
+ ret = 0;
+ devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
+ for (i = 0; i < num_opts; i++) {
+ if ((devopts[i] & SR_CONF_MASK) == key) {
+ ret = devopts[i] & ~SR_CONF_MASK;
+ break;
+ }
+ }
+ g_variant_unref(gvar);
+
+ return ret;
+}
+
/**
* Allocate and init a new user-generated device instance.
*
- * @param vendor Device vendor
- * @param model Device model
- * @param version Device version
+ * @param vendor Device vendor.
+ * @param model Device model.
+ * @param version Device version.
*
* @retval struct sr_dev_inst *. Dynamically allocated, free using
* sr_dev_inst_free().
/**
* Add a new channel to the specified device instance.
+ *
+ * @param[in] index @copydoc sr_channel::index
+ * @param[in] type @copydoc sr_channel::type
+ * @param[in] name @copydoc sr_channel::name
+ *
+ * @return SR_OK Success.
+ * @return SR_OK Invalid argument.
*/
SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
{
return SR_OK;
}
-/** @private
- * Free device instance struct created by sr_dev_inst().
- * @param sdi device instance to free.
+/**
+ * Free device instance struct created by sr_dev_inst().
+ *
+ * @param sdi Device instance to free. If NULL, the function will do nothing.
+ *
+ * @private
*/
SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
{
struct sr_channel_group *cg;
GSList *l;
+ if (!sdi)
+ return;
+
for (l = sdi->channels; l; l = l->next) {
ch = l->data;
g_free(ch->name);
}
g_slist_free(sdi->channel_groups);
+ if (sdi->session)
+ sr_session_dev_remove(sdi->session, sdi);
+
g_free(sdi->vendor);
g_free(sdi->model);
g_free(sdi->version);
#ifdef HAVE_LIBUSB_1_0
-/** @private
- * Allocate and init struct for USB device instance.
- * @param[in] bus @copydoc sr_usb_dev_inst::bus
- * @param[in] address @copydoc sr_usb_dev_inst::address
- * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
+/**
+ * Allocate and init a struct for a USB device instance.
+ *
+ * @param[in] bus @copydoc sr_usb_dev_inst::bus
+ * @param[in] address @copydoc sr_usb_dev_inst::address
+ * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
+ *
+ * @return The struct sr_usb_dev_inst * for USB device instance.
*
- * @retval other struct sr_usb_dev_inst * for USB device instance.
+ * @private
*/
SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
uint8_t address, struct libusb_device_handle *hdl)
return udi;
}
-/** @private
- * Free struct * allocated by sr_usb_dev_inst().
- * @param usb struct* to free. Must not be NULL.
+/**
+ * Free struct sr_usb_dev_inst * allocated by sr_usb_dev_inst().
+ *
+ * @param usb The struct sr_usb_dev_inst * to free. If NULL, this
+ * function does nothing.
+ *
+ * @private
*/
SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
{
#ifdef HAVE_LIBSERIALPORT
/**
- * @private
+ * Allocate and init a struct for a serial device instance.
*
* Both parameters are copied to newly allocated strings, and freed
* automatically by sr_serial_dev_inst_free().
*
* @return A pointer to a newly initialized struct sr_serial_dev_inst,
* or NULL on error.
+ *
+ * @private
*/
SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
const char *serialcomm)
return serial;
}
-/** @private
- * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
- * @param serial struct sr_serial_dev_inst * to free. Must not be NULL.
+/**
+ * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
+ *
+ * @param serial The struct sr_serial_dev_inst * to free. If NULL, this
+ * function will do nothing.
+ *
+ * @private
*/
SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
{
+ if (!serial)
+ return;
+
g_free(serial->port);
g_free(serial->serialcomm);
g_free(serial);
/** @private */
SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
{
+ if (!usbtmc)
+ return;
+
g_free(usbtmc->device);
g_free(usbtmc);
}
* @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.
*
- * @retval SR_OK Success
- * @retval SR_ERR_ARG Invalid driver
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid driver.
*
* @since 0.2.0
*/
}
/**
- * Open the specified device.
+ * Open the specified device instance.
+ *
+ * If the device instance is already open (sdi->status == SR_ST_ACTIVE),
+ * SR_ERR will be returned and no re-opening of the device will be attempted.
+ *
+ * If opening was successful, sdi->status is set to SR_ST_ACTIVE, otherwise
+ * it will be left unchanged.
*
* @param sdi Device instance to use. Must not be NULL.
*
- * @return SR_OK upon success, a negative error code upon errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
+ * @retval SR_ERR Device instance was already active, or other error.
*
* @since 0.2.0
*/
int ret;
if (!sdi || !sdi->driver || !sdi->driver->dev_open)
+ return SR_ERR_ARG;
+
+ if (sdi->status == SR_ST_ACTIVE) {
+ sr_err("%s: Device instance already active, can't re-open.",
+ sdi->driver->name);
return SR_ERR;
+ }
+
+ sr_dbg("%s: Opening device instance.", sdi->driver->name);
ret = sdi->driver->dev_open(sdi);
+ if (ret == SR_OK)
+ sdi->status = SR_ST_ACTIVE;
+
return ret;
}
/**
- * Close the specified device.
+ * Close the specified device instance.
+ *
+ * If the device instance is not open (sdi->status != SR_ST_ACTIVE),
+ * SR_ERR_DEV_CLOSED will be returned and no closing will be attempted.
+ *
+ * Note: sdi->status will be set to SR_ST_INACTIVE, regardless of whether
+ * there are any errors during closing of the device instance (any errors
+ * will be reported via error code and log message, though).
*
* @param sdi Device instance to use. Must not be NULL.
*
- * @return SR_OK upon success, a negative error code upon errors.
+ * @retval SR_OK Success.
+ * @retval SR_ERR_ARG Invalid arguments.
+ * @retval SR_ERR_DEV_CLOSED Device instance was not active.
+ * @retval SR_ERR Other error.
*
* @since 0.2.0
*/
int ret;
if (!sdi || !sdi->driver || !sdi->driver->dev_close)
- return SR_ERR;
+ return SR_ERR_ARG;
+
+ if (sdi->status != SR_ST_ACTIVE) {
+ sr_err("%s: Device instance not active, can't close.",
+ sdi->driver->name);
+ return SR_ERR_DEV_CLOSED;
+ }
+
+ sdi->status = SR_ST_INACTIVE;
+
+ sr_dbg("%s: Closing device instance.", sdi->driver->name);
ret = sdi->driver->dev_close(sdi);
*
* @param sdi Device instance to use. Must not be NULL.
*
- * @return A copy of the connection id string or NULL. The caller is responsible
+ * @return A copy of the connection ID string or NULL. The caller is responsible
* for g_free()ing the string when it is no longer needed.
*/
SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
{
#ifdef HAVE_LIBUSB_1_0
struct drv_context *drvc;
- int r, cnt, i, a, b;
+ int cnt, i, a, b;
char connection_id[64];
struct sr_usb_dev_inst *usb;
struct libusb_device **devlist;
- struct libusb_device_descriptor des;
#endif
if (!sdi)
}
for (i = 0; i < cnt; i++) {
- if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
- sr_err("Failed to get device descriptor: %s.",
- libusb_error_name(r));
- continue;
- }
-
/* Find the USB device by the logical address we know. */
b = libusb_get_bus_number(devlist[i]);
a = libusb_get_device_address(devlist[i]);
projects / libsigrok.git / blobdiff