X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=19fd6a14afba39af557889256e4b7182cae2bd8b;hb=7c1d391c8b33bf76f7c6617fe9d5174e16a04f95;hp=b18fcacd3f9cbef0eb287f39d9c918dd44d8f715;hpb=b7f09cf86dd57a59dc1bdece2cac9e4a176900b1;p=libsigrok.git

diff --git a/device.c b/device.c
index b18fcacd..19fd6a14 100644
--- 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();
@@ -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,26 +116,16 @@ 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.
  */
-struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
-				int plugin_index, int num_probes)
+SR_API struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
+				       int plugin_index)
 {
 	struct sr_device *device;
-	int i;
-
-	if (!plugin) {
-		sr_err("dev: %s: plugin was NULL", __func__);
-		return NULL; /* TODO: SR_ERR_ARG */
-	}
 
 	/* 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;
@@ -140,9 +135,6 @@ struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
 	device->plugin_index = plugin_index;
 	devices = g_slist_append(devices, device);
 
-	for (i = 0; i < num_probes; i++)
-		sr_device_probe_add(device, NULL); /* TODO: Check return value. */
-
 	return device;
 }
 
@@ -164,7 +156,7 @@ struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
  * @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)
+SR_API int sr_device_clear(struct sr_device *device)
 {
 	unsigned int pnum;
 
@@ -196,7 +188,7 @@ int sr_device_clear(struct sr_device *device)
  *         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)
+SR_API int sr_device_probe_clear(struct sr_device *device, int probenum)
 {
 	struct sr_probe *p;
 
@@ -213,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;
 }
@@ -249,10 +237,9 @@ 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;
-	char probename[16]; /* FIXME: Don't hardcode 16? #define? */
 	int probenum;
 
 	if (!device) {
@@ -276,12 +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);
-	} else {
-		snprintf(probename, 16, "%d", probenum);
-		p->name = g_strdup(probename);
-	}
+	p->name = g_strdup(name);
 	p->trigger = NULL;
 	device->probes = g_slist_append(device->probes, p);
 
@@ -303,8 +285,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;
@@ -346,8 +328,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;
 
@@ -365,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);
 
@@ -383,7 +364,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? */
@@ -401,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;
 		}
@@ -426,8 +407,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;
 
@@ -447,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);
 
@@ -469,7 +449,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;
 
@@ -501,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;
+}
+