X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fdevice.c;h=aa499c8d74252ad07a37cf54afbec3b1233196ce;hb=6ad2fbaad2722f0aa18c3600cdbdddf812784b2d;hp=969faa4de5bd4d3e7f7e7d38179170b9a1c8458c;hpb=2f5f97056a57d0cdf6fa0e6fc51b1a406d33452f;p=libsigrok.git
diff --git a/src/device.c b/src/device.c
index 969faa4d..aa499c8d 100644
--- a/src/device.c
+++ b/src/device.c
@@ -17,10 +17,10 @@
* along with this program. If not, see .
*/
+#include
#include
#include
-#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
-#include "libsigrok.h"
+#include
#include "libsigrok-internal.h"
/** @cond PRIVATE */
@@ -41,120 +41,119 @@
* @{
*/
-/** @private
- * 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
+/**
+ * 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 NULL (failure) or new struct sr_channel*.
+ * @private
*/
-SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
- gboolean enabled, const char *name)
+SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
+ int index, int type, gboolean enabled, const char *name)
{
struct sr_channel *ch;
- if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
- sr_err("Channel malloc failed.");
- return NULL;
- }
-
+ ch = g_malloc0(sizeof(struct sr_channel));
+ ch->sdi = sdi;
ch->index = index;
ch->type = type;
ch->enabled = enabled;
if (name)
ch->name = g_strdup(name);
+ sdi->channels = g_slist_append(sdi->channels, ch);
+
return ch;
}
/**
- * Set the name of the specified channel in the specified device.
+ * Set the name of the specified channel.
*
* 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 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.
+ * @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.
*
* @since 0.3.0
*/
-SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
- int channelnum, const char *name)
+SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
+ const char *name)
{
- GSList *l;
- struct sr_channel *ch;
- int ret;
-
- if (!sdi) {
- sr_err("%s: sdi was NULL", __func__);
+ if (!channel)
return SR_ERR_ARG;
- }
- ret = SR_ERR_ARG;
- 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;
- }
- }
+ g_free(channel->name);
+ channel->name = g_strdup(name);
- return ret;
+ return SR_OK;
}
/**
- * Enable or disable a channel on the specified device.
+ * Enable or disable a channel.
*
- * @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.
+ * @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(const struct sr_dev_inst *sdi, int channelnum,
- gboolean state)
+SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
{
- GSList *l;
- struct sr_channel *ch;
int ret;
gboolean was_enabled;
+ struct sr_dev_inst *sdi;
- if (!sdi)
+ if (!channel)
return SR_ERR_ARG;
- ret = SR_ERR_ARG;
- 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;
- }
+ sdi = channel->sdi;
+ was_enabled = channel->enabled;
+ channel->enabled = state;
+ if (!state != !was_enabled && sdi->driver
+ && sdi->driver->config_channel_set) {
+ ret = sdi->driver->config_channel_set(
+ sdi, channel, SR_CHANNEL_SET_ENABLED);
+ /* Roll back change if it wasn't applicable. */
+ if (ret != SR_OK)
+ return ret;
}
- return ret;
+ 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;
}
/**
@@ -168,7 +167,7 @@ SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
* @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.
*
@@ -201,48 +200,150 @@ SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
return ret;
}
-/** @private
- * Allocate and init new device instance struct.
- * @param[in] index @copydoc sr_dev_inst::index
- * @param[in] status @copydoc sr_dev_inst::status
- * @param[in] vendor @copydoc sr_dev_inst::vendor
- * @param[in] model @copydoc sr_dev_inst::model
- * @param[in] version @copydoc sr_dev_inst::version
- *
- * @retval NULL Error
- * @retval struct sr_dev_inst *. Dynamically allocated, free using
- * sr_dev_inst_free().
+/**
+ * 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_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
- const char *vendor, const char *model, const char *version)
+SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
+ const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
- struct sr_dev_inst *sdi;
+ GVariant *gvar;
+ const uint32_t *opts;
+ uint32_t opt;
+ gsize num_opts, i;
+ GArray *result;
- if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
- sr_err("Device instance malloc failed.");
+ 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.
+ *
+ * @retval struct sr_dev_inst *. Dynamically allocated, free using
+ * sr_dev_inst_free().
+ */
+SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
+ const char *model, const char *version)
+{
+ struct sr_dev_inst *sdi;
- sdi->driver = NULL;
- sdi->status = status;
- sdi->inst_type = -1;
- sdi->vendor = vendor ? g_strdup(vendor) : NULL;
- sdi->model = model ? g_strdup(model) : NULL;
- sdi->version = version ? g_strdup(version) : NULL;
- sdi->serial_num = NULL;
- sdi->connection_id = NULL;
- sdi->channels = NULL;
- sdi->channel_groups = NULL;
- sdi->session = NULL;
- sdi->conn = NULL;
- sdi->priv = NULL;
+ sdi = g_malloc0(sizeof(struct sr_dev_inst));
+
+ sdi->vendor = g_strdup(vendor);
+ sdi->model = g_strdup(model);
+ sdi->version = g_strdup(version);
+ sdi->inst_type = SR_INST_USER;
return sdi;
}
-/** @private
- * Free device instance struct created by sr_dev_inst().
- * @param sdi device instance to 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)
+{
+ if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
+ return SR_ERR_ARG;
+
+ sr_channel_new(sdi, index, type, TRUE, name);
+
+ return SR_OK;
+}
+
+/**
+ * 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)
{
@@ -250,6 +351,9 @@ 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);
@@ -267,6 +371,9 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
}
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);
@@ -277,25 +384,23 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
#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.
*
- * @retval NULL Error
- * @retval other struct sr_usb_dev_inst * 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
+ *
+ * @return The 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)
{
struct sr_usb_dev_inst *udi;
- if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
- sr_err("USB device instance malloc failed.");
- return NULL;
- }
-
+ udi = g_malloc0(sizeof(struct sr_usb_dev_inst));
udi->bus = bus;
udi->address = address;
udi->devhdl = hdl;
@@ -303,9 +408,13 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
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)
{
@@ -317,36 +426,30 @@ 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().
*
* @param[in] port OS-specific serial port specification. Examples:
* "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
+ * Must not be NULL.
* @param[in] serialcomm A serial communication parameters string, in the form
* of \/\\\, for example
* "9600/8n1" or "600/7o2". This is an optional parameter;
- * it may be filled in later.
+ * it may be filled in later. Can be NULL.
*
* @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)
{
struct sr_serial_dev_inst *serial;
- if (!port) {
- sr_err("Serial port required.");
- return NULL;
- }
-
- if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
- sr_err("Serial device instance malloc failed.");
- return NULL;
- }
-
+ serial = g_malloc0(sizeof(struct sr_serial_dev_inst));
serial->port = g_strdup(port);
if (serialcomm)
serial->serialcomm = g_strdup(serialcomm);
@@ -354,12 +457,19 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
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);
@@ -371,16 +481,7 @@ SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
{
struct sr_usbtmc_dev_inst *usbtmc;
- if (!device) {
- sr_err("Device name required.");
- return NULL;
- }
-
- if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
- sr_err("USBTMC device instance malloc failed.");
- return NULL;
- }
-
+ usbtmc = g_malloc0(sizeof(struct sr_usbtmc_dev_inst));
usbtmc->device = g_strdup(device);
usbtmc->fd = -1;
@@ -390,6 +491,9 @@ SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
/** @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);
}
@@ -407,7 +511,7 @@ SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
{
if (driver && driver->dev_list)
- return driver->dev_list();
+ return driver->dev_list(driver);
else
return NULL;
}
@@ -418,8 +522,8 @@ SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
* @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
*/
@@ -433,7 +537,7 @@ SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
}
if (driver->dev_clear)
- ret = driver->dev_clear();
+ ret = driver->dev_clear(driver);
else
ret = std_dev_clear(driver, NULL);
@@ -562,19 +666,17 @@ SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *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];
-
-#ifdef HAVE_LIBUSB_1_0
struct sr_usb_dev_inst *usb;
struct libusb_device **devlist;
- struct libusb_device_descriptor des;
#endif
if (!sdi)
@@ -591,12 +693,11 @@ SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
}
#endif
-
#ifdef HAVE_LIBUSB_1_0
if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
/* connection_id isn't populated, let's do that here. */
- drvc = sdi->driver->priv;
+ drvc = sdi->driver->context;
usb = sdi->conn;
if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
@@ -606,12 +707,6 @@ SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *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]);