*
* @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;
*
* @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();
/**
* 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
* @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)
+SR_API struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
+ int plugin_index)
{
struct sr_device *device;
/* 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;
* @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;
* 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;
}
/* 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;
}
* 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;
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);
* @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;
* 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;
/* 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);
* @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? */
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;
}
* 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;
}
/* 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);
* 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;
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;
+}
+
projects / libsigrok.git / blobdiff