Add sr_device_get_info

[libsigrok.git] / device.c

diff --git a/device.c b/device.c
index ac170ac33c3b3a0bd8cfa2821294843439548986..30649cd4f64b0ac8165b452a599f1544c867c6a9 100644 (file)
--- a/device.c
+++ b/device.c
@@ -102,7 +102,12 @@ GSList *sr_device_list(void)
 /**
  * Create a new device.
  *
- * TODO: num_probes should be uint16_t.
+ * The device is added to the (libsigrok-internal) list of devices, but
+ * additionally a pointer to the newly created device is also returned.
+ *
+ * The device has no probes attached to it yet after this call. You can
+ * use sr_device_probe_add() to add one or more probes.
+ *
  * TODO: Should return int, so that we can return SR_OK, SR_ERR_* etc.
  *
  * It is the caller's responsibility to g_free() the allocated memory when
@@ -111,8 +116,6 @@ GSList *sr_device_list(void)
  * @param plugin TODO.
  *               If 'plugin' is NULL, the created device is a "virtual" one.
  * @param plugin_index TODO
- * @param num_probes The number of probes (>= 1) this device has.
- *                   TODO: 0 allowed?
  *
  * @return Pointer to the newly allocated device, or NULL upon errors.
  */
@@ -123,8 +126,6 @@ struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
 
        /* TODO: Check if plugin_index valid? */
 
-       /* TODO: Check if num_probes valid? */
-
        if (!(device = g_try_malloc0(sizeof(struct sr_device)))) {
                sr_err("dev: %s: device malloc failed", __func__);
                return NULL;
@@ -204,16 +205,12 @@ int sr_device_probe_clear(struct sr_device *device, int probenum)
        }
 
        /* If the probe has a name, remove it. */
-       if (p->name) {
-               g_free(p->name);
-               p->name = NULL;
-       }
+       g_free(p->name);
+       p->name = NULL;
 
        /* If the probe has a trigger, remove it. */
-       if (p->trigger) {
-               g_free(p->trigger);
-               p->trigger = NULL;
-       }
+       g_free(p->trigger);
+       p->trigger = NULL;
 
        return SR_OK;
 }
@@ -266,9 +263,7 @@ int sr_device_probe_add(struct sr_device *device, const char *name)
 
        p->index = probenum;
        p->enabled = TRUE;
-       if (name) {
-               p->name = g_strdup(name);
-       }
+       p->name = g_strdup(name);
        p->trigger = NULL;
        device->probes = g_slist_append(device->probes, p);
 
@@ -352,8 +347,7 @@ int sr_device_probe_name(struct sr_device *device, int probenum,
        /* TODO: Sanity check on 'name'. */
 
        /* If the probe already has a name, kill it first. */
-       if (p->name)
-               g_free(p->name);
+       g_free(p->name);
 
        p->name = g_strdup(name);
 
@@ -388,7 +382,7 @@ int sr_device_trigger_clear(struct sr_device *device)
        for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) {
                p = sr_device_probe_find(device, pnum);
                /* TODO: Silently ignore probes which cannot be found? */
-               if (p && p->trigger) {
+               if (p) {
                        g_free(p->trigger);
                        p->trigger = NULL;
                }
@@ -434,8 +428,7 @@ int sr_device_trigger_set(struct sr_device *device, int probenum,
        }
 
        /* If the probe already has a trigger, kill it first. */
-       if (p->trigger)
-               g_free(p->trigger);
+       g_free(p->trigger);
 
        p->trigger = g_strdup(trigger);
 
@@ -488,3 +481,32 @@ gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
 
        return FALSE;
 }
+
+/**
+ * Returns information about the given device.
+ *
+ * @param device Pointer to the device to be checked. Must not be NULL.
+ *               The device's 'plugin' field must not be NULL either.
+ * @param id     The type of information.
+ * @param data   The return value. Must not be NULL.
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
+ *         upon other errors.
+ */
+int sr_device_get_info(const struct sr_device *device, int id,
+                                          const void **data)
+{
+       if ((device == NULL) || (device->plugin == NULL))
+               return SR_ERR_ARG;
+
+       if (data == NULL)
+               return SR_ERR_ARG;
+
+       *data = device->plugin->get_device_info(device->plugin_index, id);
+
+       if (*data == NULL)
+               return SR_ERR;
+
+       return SR_OK;
+}
+