/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <stdio.h>
#include <glib.h>
#include "sigrok.h"
+#include "sigrok-internal.h"
-extern struct sigrok_global *global;
+static GSList *devices = NULL;
-GSList *devices = NULL;
-
-
-void device_scan(void)
+/**
+ * Scan the system for attached logic analyzers / devices.
+ *
+ * This will try to autodetect all supported logic analyzer devices:
+ *
+ * - Those attached via USB (can be reliably detected via USB VID/PID).
+ *
+ * - Those using a (real or virtual) serial port (detected by sending
+ * device-specific commands to all OS-specific serial port devices such
+ * as /dev/ttyS*, /dev/ttyUSB*, /dev/ttyACM*, and others).
+ * The autodetection for this kind of devices can potentially be unreliable.
+ *
+ * Also, sending various bytes/commands to (all!) devices which happen to
+ * be attached to the system via a (real or virtual) serial port can be
+ * problematic. There is no way for libsigrok to know how unknown devices
+ * react to the bytes libsigrok sends. Potentially they could lead to the
+ * device getting into invalid/error states, losing/overwriting data, or...
+ *
+ * In addition to the detection, the devices that are found are also
+ * initialized automatically. On some devices, this involves a firmware upload,
+ * or other such measures.
+ *
+ * The order in which the system is scanned for devices is not specified. The
+ * caller should not assume or rely on any specific order.
+ *
+ * After the system has been scanned for devices, the list of detected (and
+ * supported) devices can be acquired via sr_dev_list().
+ *
+ * TODO: Error checks?
+ * TODO: Option to only scan for specific devices or device classes.
+ *
+ * @return SR_OK upon success, SR_ERR upon errors.
+ */
+SR_API int sr_dev_scan(void)
{
GSList *plugins, *l;
- struct device_plugin *plugin;
- int num_devices, i;
+ struct sr_device_plugin *plugin;
- plugins = list_hwplugins();
+ if (!(plugins = sr_list_hwplugins())) {
+ sr_err("dev: %s: no supported devices/hwplugins", __func__);
+ return SR_ERR; /* TODO: More specific error? */
+ }
- /* initialize all plugins first. Since the init() call may involve
+ /*
+ * Initialize all plugins first. Since the init() call may involve
* a firmware upload and associated delay, we may as well get all
* of these out of the way first.
*/
- for(l = plugins; l; l = l->next)
- {
+ for (l = plugins; l; l = l->next) {
plugin = l->data;
- g_message("initializing %s plugin", plugin->name);
- num_devices = plugin->init(NULL);
- for(i = 0; i < num_devices; i++)
- {
- device_new(plugin, i);
- }
+ /* TODO: Handle 'plugin' being NULL. */
+ sr_init_hwplugin(plugin);
}
+ return SR_OK;
}
-
-void device_close_all(void)
+/**
+ * Return the list of logic analyzer devices libsigrok has detected.
+ *
+ * If the libsigrok-internal device list is empty, a scan for attached
+ * devices -- via a call to sr_dev_scan() -- is performed first.
+ *
+ * TODO: Error handling?
+ *
+ * @return The list (GSList) of detected devices, or NULL if none were found.
+ */
+SR_API GSList *sr_dev_list(void)
{
- struct device *device;
-
- while(devices)
- {
- device = devices->data;
- device->plugin->close(device->plugin_index);
- device_destroy(device);
- }
+ if (!devices)
+ sr_dev_scan();
+ return devices;
}
-
-GSList *device_list(void)
+/**
+ * Create a new device.
+ *
+ * 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_dev_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
+ * no longer needed. TODO: Using which API function?
+ *
+ * @param plugin TODO.
+ * If 'plugin' is NULL, the created device is a "virtual" one.
+ * @param plugin_index TODO
+ *
+ * @return Pointer to the newly allocated device, or NULL upon errors.
+ */
+SR_API struct sr_device *sr_dev_new(const struct sr_device_plugin *plugin,
+ int plugin_index)
{
+ struct sr_device *device;
- return devices;
-}
-
+ /* TODO: Check if plugin_index valid? */
-struct device *device_new(struct device_plugin *plugin, int plugin_index)
-{
- struct device *device;
- int num_probes, i;
- char probename[16];
+ if (!(device = g_try_malloc0(sizeof(struct sr_device)))) {
+ sr_err("dev: %s: device malloc failed", __func__);
+ return NULL;
+ }
- device = g_malloc0(sizeof(struct device));
- device->plugin = plugin;
+ device->plugin = (struct sr_device_plugin *)plugin;
device->plugin_index = plugin_index;
devices = g_slist_append(devices, device);
- num_probes = (int) device->plugin->get_device_info(device->plugin_index, DI_NUM_PROBES);
- for(i = 0; i < num_probes; i++)
- {
- snprintf(probename, 16, "%d", i+1);
- device_probe_add(device, probename);
- }
-
return device;
}
-
-void device_clear(struct device *device)
-{
- unsigned int probenum;
-
- /* TODO: plugin-specific clear call? */
-
- if(device->probes)
- for(probenum = 1; probenum <= g_slist_length(device->probes); probenum++)
- device_probe_clear(device, probenum);
-
-}
-
-
-void device_destroy(struct device *device)
-{
- unsigned int probenum;
-
- /* TODO: plugin-specific destroy call, need to decrease refcount in plugin */
-
- devices = g_slist_remove(devices, device);
- if(device->probes)
- {
- for(probenum = 1; probenum <= g_slist_length(device->probes); probenum++)
- device_probe_clear(device, probenum);
- g_slist_free(device->probes);
- }
- g_free(device);
-
-}
-
-
-void device_probe_clear(struct device *device, int probenum)
+/**
+ * Add a probe with the specified name to the specified device.
+ *
+ * The added probe is automatically enabled (the 'enabled' field is TRUE).
+ *
+ * The 'trigger' field of the added probe is set to NULL. A trigger can be
+ * added via sr_dev_trigger_set().
+ *
+ * TODO: Are duplicate names allowed?
+ * TODO: Do we enforce a maximum probe number for a device?
+ * TODO: Error if the max. probe number for the specific LA is reached, e.g.
+ * if the caller tries to add more probes than the device actually has.
+ *
+ * @param device The device to which to add a probe with the specified name.
+ * Must not be NULL.
+ * @param name The name of the probe to add to this device. Must not be NULL.
+ * TODO: Maximum length, allowed characters, etc.
+ *
+ * @return SR_OK upon success, SR_ERR_MALLOC upon memory allocation errors,
+ * or SR_ERR_ARG upon invalid arguments.
+ * If something other than SR_OK is returned, 'device' is unchanged.
+ */
+SR_API int sr_dev_probe_add(struct sr_device *device, const char *name)
{
- struct probe *p;
-
- p = probe_find(device, probenum);
- if(!p)
- return;
+ struct sr_probe *p;
+ int probenum;
- if(p->name)
- {
- g_free(p->name);
- p->name = NULL;
+ if (!device) {
+ sr_err("dev: %s: device was NULL", __func__);
+ return SR_ERR_ARG;
}
- if(p->trigger)
- {
- g_free(p->trigger);
- p->trigger = NULL;
+ if (!name) {
+ sr_err("dev: %s: name was NULL", __func__);
+ return SR_ERR_ARG;
}
-}
+ /* TODO: Further checks to ensure name is valid. */
+ probenum = g_slist_length(device->probes) + 1;
-void device_probe_add(struct device *device, char *name)
-{
- struct probe *p;
+ if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) {
+ sr_err("dev: %s: p malloc failed", __func__);
+ return SR_ERR_MALLOC;
+ }
- p = g_malloc0(sizeof(struct probe));
- p->index = g_slist_length(device->probes) + 1;
+ p->index = probenum;
p->enabled = TRUE;
p->name = g_strdup(name);
p->trigger = NULL;
device->probes = g_slist_append(device->probes, p);
+ return SR_OK;
}
-
-struct probe *probe_find(struct device *device, int probenum)
+/**
+ * Find the probe with the specified number in the specified device.
+ *
+ * TODO
+ *
+ * @param device TODO. Must not be NULL.
+ * @param probenum The number of the probe whose 'struct sr_probe' we want.
+ * Note that the probe numbers start at 1 (not 0!).
+ *
+ * TODO: Should return int.
+ * TODO: probenum should be unsigned.
+ *
+ * @return A pointer to the requested probe's 'struct sr_probe', or NULL
+ * if the probe could not be found.
+ */
+SR_API struct sr_probe *sr_dev_probe_find(const struct sr_device *device,
+ int probenum)
{
GSList *l;
- struct probe *p, *found_probe;
+ struct sr_probe *p, *found_probe;
+
+ if (!device) {
+ sr_err("dev: %s: device was NULL", __func__);
+ return NULL; /* TODO: SR_ERR_ARG */
+ }
+
+ /* TODO: Sanity check on probenum. */
found_probe = NULL;
- for(l = device->probes; l; l = l->next)
- {
+ for (l = device->probes; l; l = l->next) {
p = l->data;
- if(p->index == probenum)
- {
+ /* TODO: Check for p != NULL. */
+ if (p->index == probenum) {
found_probe = p;
break;
}
return found_probe;
}
-
-void device_probe_name(struct device *device, int probenum, char *name)
+/**
+ * Set the name of the specified probe in the specified device.
+ *
+ * If the probe already has a different name assigned to it, it will be
+ * removed, and the new name will be saved instead.
+ *
+ * TODO: Rename to sr_device_set_probe_name().
+ *
+ * @param device TODO
+ * @param probenum The number of the probe whose name to set.
+ * Note that the probe numbers start at 1 (not 0!).
+ * @param name The new name that the specified probe should get.
+ *
+ * @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.
+ */
+SR_API int sr_dev_probe_name(struct sr_device *device, int probenum,
+ const char *name)
{
- struct probe *p;
+ struct sr_probe *p;
+
+ if (!device) {
+ sr_err("dev: %s: device was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ p = sr_dev_probe_find(device, probenum);
+ if (!p) {
+ sr_err("dev: %s: probe %d not found", __func__, probenum);
+ return SR_ERR; /* TODO: More specific error? */
+ }
+
+ /* TODO: Sanity check on 'name'. */
- p = probe_find(device, probenum);
- if(!p)
- return;
+ /* If the probe already has a name, kill it first. */
+ g_free(p->name);
- if(p->name)
- g_free(p->name);
p->name = g_strdup(name);
+ return SR_OK;
}
-
-void device_trigger_clear(struct device *device)
+/**
+ * Remove all triggers set up for the specified device.
+ *
+ * TODO: Better description.
+ *
+ * @param device TODO
+ *
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ * If something other than SR_OK is returned, 'device' is unchanged.
+ */
+SR_API int sr_dev_trigger_clear(struct sr_device *device)
{
- struct probe *p;
- unsigned int probenum;
-
- if(device->probes)
- for(probenum = 1; probenum <= g_slist_length(device->probes); probenum++)
- {
- p = probe_find(device, probenum);
- if(p && p->trigger)
- {
- g_free(p->trigger);
- p->trigger = NULL;
- }
+ struct sr_probe *p;
+ unsigned int pnum; /* TODO: uint16_t? */
+
+ if (!device) {
+ sr_err("dev: %s: device was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ if (!device->probes) {
+ sr_err("dev: %s: device->probes was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) {
+ p = sr_dev_probe_find(device, pnum);
+ /* TODO: Silently ignore probes which cannot be found? */
+ if (p) {
+ g_free(p->trigger);
+ p->trigger = NULL;
}
+ }
+ return SR_OK;
}
-
-void device_trigger_set(struct device *device, int probenum, char *trigger)
+/**
+ * Add a trigger to the specified device.
+ *
+ * TODO: Better description.
+ * TODO: Describe valid format of the 'trigger' string.
+ *
+ * @param device TODO. Must not be NULL.
+ * @param probenum The number of the probe. TODO.
+ * Note that the probe numbers start at 1 (not 0!).
+ * @param trigger TODO.
+ * TODO: Is NULL allowed?
+ *
+ * @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.
+ */
+SR_API int sr_dev_trigger_set(struct sr_device *device, int probenum,
+ const char *trigger)
{
- struct probe *p;
+ struct sr_probe *p;
- p = probe_find(device, probenum);
- if(!p)
- return;
+ if (!device) {
+ sr_err("dev: %s: device was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ /* TODO: Sanity check on 'probenum'. */
+
+ /* TODO: Sanity check on 'trigger'. */
+
+ p = sr_dev_probe_find(device, probenum);
+ if (!p) {
+ sr_err("dev: %s: probe %d not found", __func__, probenum);
+ return SR_ERR; /* TODO: More specific error? */
+ }
- if(p->trigger)
- g_free(p->trigger);
+ /* If the probe already has a trigger, kill it first. */
+ g_free(p->trigger);
p->trigger = g_strdup(trigger);
+ return SR_OK;
+}
+
+/**
+ * Determine whether the specified device has the specified capability.
+ *
+ * TODO: Should return int?
+ *
+ * @param device Pointer to the device to be checked. Must not be NULL.
+ * The device's 'plugin' field must not be NULL either.
+ * @param hwcap The capability that should be checked (whether it's supported
+ * by the specified device).
+ *
+ * @return TRUE, if the device has the specified capability, FALSE otherwise.
+ * FALSE is also returned upon invalid input parameters or other
+ * error conditions.
+ */
+SR_API gboolean sr_dev_has_hwcap(const struct sr_device *device, int hwcap)
+{
+ int *capabilities, i;
+
+ if (!device) {
+ sr_err("dev: %s: device was NULL", __func__);
+ return FALSE; /* TODO: SR_ERR_ARG. */
+ }
+
+ if (!device->plugin) {
+ sr_err("dev: %s: device->plugin was NULL", __func__);
+ return FALSE; /* TODO: SR_ERR_ARG. */
+ }
+
+ /* TODO: Sanity check on 'hwcap'. */
+
+ if (!(capabilities = device->plugin->get_capabilities())) {
+ sr_err("dev: %s: device has no capabilities", __func__);
+ return FALSE; /* TODO: SR_ERR*. */
+ }
+
+ for (i = 0; capabilities[i]; i++) {
+ if (capabilities[i] != hwcap)
+ continue;
+ sr_spew("dev: %s: found hwcap %d", __func__, hwcap);
+ return TRUE;
+ }
+
+ sr_spew("dev: %s: hwcap %d not found", __func__, 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_dev_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