]> sigrok.org Git - libsigrok.git/blobdiff - device.c
sr: cleaned up session bus debug helper
[libsigrok.git] / device.c
index 72cba33873fba72fe74a112df3d05ec4aebfad99..886a5040eae277adde6ae64c2817cd818976d9d3 100644 (file)
--- a/device.c
+++ b/device.c
@@ -57,7 +57,7 @@ static GSList *devices = NULL;
  *
  * @return SR_OK upon success, SR_ERR upon errors.
  */
-int sr_device_scan(void)
+SR_API int sr_device_scan(void)
 {
        GSList *plugins, *l;
        struct sr_device_plugin *plugin;
@@ -91,7 +91,7 @@ int sr_device_scan(void)
  *
  * @return The list (GSList) of detected devices, or NULL if none were found.
  */
-GSList *sr_device_list(void)
+SR_API GSList *sr_device_list(void)
 {
        if (!devices)
                sr_device_scan();
@@ -119,8 +119,8 @@ GSList *sr_device_list(void)
  *
  * @return Pointer to the newly allocated device, or NULL upon errors.
  */
-struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
-                               int plugin_index)
+SR_API struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
+                                      int plugin_index)
 {
        struct sr_device *device;
 
@@ -138,87 +138,6 @@ struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
        return device;
 }
 
-/**
- * Clear all probes of the specified device.
- *
- * This removes/clears the 'name' and 'trigger' fields of all probes of
- * the device.
- *
- * The order in which the probes are cleared is not specified. The caller
- * should not assume or rely on a specific order.
- *
- * TODO: Rename to sr_device_clear_probes() or sr_device_probe_clear_all().
- *
- * @param device The device whose probes to clear. Must not be NULL.
- *               Note: device->probes is allowed to be NULL (in that case,
- *               there are no probes, thus none have to be cleared).
- *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
- *         If something other than SR_OK is returned, 'device' is unchanged.
- */
-int sr_device_clear(struct sr_device *device)
-{
-       unsigned int pnum;
-
-       if (!device) {
-               sr_err("dev: %s: device was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
-       /* Note: device->probes can be NULL, this is handled correctly. */
-
-       for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++)
-               sr_device_probe_clear(device, pnum);
-
-       return SR_OK;
-}
-
-/**
- * Clear the specified probe in the specified device.
- *
- * The probe itself still exists afterwards, but its 'name' and 'trigger'
- * fields are g_free()'d and set to NULL.
- *
- * @param device The device in which the specified (to be cleared) probe
- *               resides. Must not be NULL.
- * @param probenum The number of the probe to clear.
- *                 Note that the probe numbers start at 1 (not 0!).
- *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or SR_ERR
- *         upon other errors.
- *         If something other than SR_OK is returned, 'device' is unchanged.
- */
-int sr_device_probe_clear(struct sr_device *device, int probenum)
-{
-       struct sr_probe *p;
-
-       if (!device) {
-               sr_err("dev: %s: device was NULL", __func__);
-               return SR_ERR_ARG;
-       }
-
-       /* TODO: Sanity check on 'probenum'. */
-
-       if (!(p = sr_device_probe_find(device, probenum))) {
-               sr_err("dev: %s: probe %d not found", __func__, probenum);
-               return SR_ERR; /* TODO: More specific error? */
-       }
-
-       /* If the probe has a name, remove it. */
-       if (p->name) {
-               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;
-       }
-
-       return SR_OK;
-}
-
 /**
  * Add a probe with the specified name to the specified device.
  *
@@ -241,7 +160,7 @@ int sr_device_probe_clear(struct sr_device *device, int probenum)
  *         or SR_ERR_ARG upon invalid arguments.
  *         If something other than SR_OK is returned, 'device' is unchanged.
  */
-int sr_device_probe_add(struct sr_device *device, const char *name)
+SR_API int sr_device_probe_add(struct sr_device *device, const char *name)
 {
        struct sr_probe *p;
        int probenum;
@@ -289,8 +208,8 @@ int sr_device_probe_add(struct sr_device *device, const char *name)
  * @return A pointer to the requested probe's 'struct sr_probe', or NULL
  *         if the probe could not be found.
  */
-struct sr_probe *sr_device_probe_find(const struct sr_device *device,
-                                     int probenum)
+SR_API struct sr_probe *sr_device_probe_find(const struct sr_device *device,
+                                            int probenum)
 {
        GSList *l;
        struct sr_probe *p, *found_probe;
@@ -332,8 +251,8 @@ struct sr_probe *sr_device_probe_find(const struct sr_device *device,
  *         upon other errors.
  *         If something other than SR_OK is returned, 'device' is unchanged.
  */
-int sr_device_probe_name(struct sr_device *device, int probenum,
-                        const char *name)
+SR_API int sr_device_probe_name(struct sr_device *device, int probenum,
+                               const char *name)
 {
        struct sr_probe *p;
 
@@ -351,8 +270,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);
 
@@ -369,7 +287,7 @@ int sr_device_probe_name(struct sr_device *device, int probenum,
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
  *         If something other than SR_OK is returned, 'device' is unchanged.
  */
-int sr_device_trigger_clear(struct sr_device *device)
+SR_API int sr_device_trigger_clear(struct sr_device *device)
 {
        struct sr_probe *p;
        unsigned int pnum; /* TODO: uint16_t? */
@@ -387,7 +305,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;
                }
@@ -412,8 +330,8 @@ int sr_device_trigger_clear(struct sr_device *device)
  *         upon other errors.
  *         If something other than SR_OK is returned, 'device' is unchanged.
  */
-int sr_device_trigger_set(struct sr_device *device, int probenum,
-                         const char *trigger)
+SR_API int sr_device_trigger_set(struct sr_device *device, int probenum,
+                                const char *trigger)
 {
        struct sr_probe *p;
 
@@ -433,8 +351,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);
 
@@ -455,7 +372,7 @@ int sr_device_trigger_set(struct sr_device *device, int probenum,
  *         FALSE is also returned upon invalid input parameters or other
  *         error conditions.
  */
-gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
+SR_API gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
 {
        int *capabilities, i;
 
@@ -487,3 +404,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;
+}
+