/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 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"
+#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
-static GSList *devices = NULL;
+/** @cond PRIVATE */
+#define LOG_PREFIX "device"
+/** @endcond */
/**
- * Scan the system for attached logic analyzers / devices.
+ * @file
*
- * 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.
+ * Device handling in libsigrok.
+ */
+
+/**
+ * @defgroup grp_devices Devices
*
- * After the system has been scanned for devices, the list of detected (and
- * supported) devices can be acquired via sr_device_list().
+ * Device handling in libsigrok.
*
- * TODO: Error checks?
- * TODO: Option to only scan for specific devices or device classes.
+ * @{
+ */
+
+/** @private
+ * Allocate and initialize new struct sr_channel
+ * @param[in] index @copydoc sr_channel::index
+ * @param[in] type @copydoc sr_channel::type
+ * @param[in] enabled @copydoc sr_channel::enabled
+ * @param[in] name @copydoc sr_channel::name
*
- * @return SR_OK upon success, SR_ERR upon errors.
+ * @return NULL (failure) or new struct sr_channel*.
*/
-int sr_device_scan(void)
+SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
+ gboolean enabled, const char *name)
{
- GSList *plugins, *l;
- struct sr_device_plugin *plugin;
+ struct sr_channel *ch;
- if (!(plugins = sr_list_hwplugins())) {
- sr_err("dev: %s: no supported devices/hwplugins", __func__);
- return SR_ERR; /* TODO: More specific error? */
+ if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
+ sr_err("Channel malloc failed.");
+ return NULL;
}
- /*
- * 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) {
- plugin = l->data;
- /* TODO: Handle 'plugin' being NULL. */
- sr_init_hwplugins(plugin);
- }
+ ch->index = index;
+ ch->type = type;
+ ch->enabled = enabled;
+ if (name)
+ ch->name = g_strdup(name);
- return SR_OK;
+ return ch;
}
/**
- * Return the list of logic analyzer devices libsigrok has detected.
+ * Set the name of the specified channel in the specified device.
+ *
+ * If the channel already has a different name assigned to it, it will be
+ * removed, and the new name will be saved instead.
*
- * If the libsigrok-internal device list is empty, a scan for attached
- * devices -- via a call to sr_device_scan() -- is performed first.
+ * @param sdi The device instance the channel is connected to.
+ * @param[in] channelnum The number of the channel whose name to set.
+ * Note that the channel numbers start at 0.
+ * @param[in] name The new name that the specified channel should get. A copy
+ * of the string is made.
*
- * TODO: Error handling?
+ * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
*
- * @return The list (GSList) of detected devices, or NULL if none were found.
+ * @since 0.3.0
*/
-GSList *sr_device_list(void)
+SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
+ int channelnum, const char *name)
{
- if (!devices)
- sr_device_scan();
+ GSList *l;
+ struct sr_channel *ch;
+ int ret;
- return devices;
+ if (!sdi) {
+ sr_err("%s: sdi was NULL", __func__);
+ return SR_ERR_ARG;
+ }
+
+ ret = SR_ERR_ARG;
+ for (l = sdi->channels; l; l = l->next) {
+ ch = l->data;
+ if (ch->index == channelnum) {
+ g_free(ch->name);
+ ch->name = g_strdup(name);
+ ret = SR_OK;
+ break;
+ }
+ }
+
+ return ret;
}
/**
- * Create a new device.
- *
- * TODO: num_probes should be uint16_t.
- * TODO: Should return int, so that we can return SR_OK, SR_ERR_* etc.
+ * Enable or disable a channel on the specified device.
*
- * It is the caller's responsibility to g_free() the allocated memory when
- * no longer needed. TODO: Using which API function?
+ * @param sdi The device instance the channel is connected to.
+ * @param channelnum The channel number, starting from 0.
+ * @param state TRUE to enable the channel, FALSE to disable.
*
- * @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 SR_OK on success or SR_ERR on failure. In case of invalid
+ * arguments, SR_ERR_ARG is returned and the channel enabled state
+ * remains unchanged.
*
- * @return Pointer to the newly allocated device, or NULL upon errors.
+ * @since 0.3.0
*/
-struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
- int plugin_index, int num_probes)
+SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
+ gboolean state)
{
- 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? */
+ GSList *l;
+ struct sr_channel *ch;
+ int ret;
+ gboolean was_enabled;
- /* TODO: Check if num_probes valid? */
+ if (!sdi)
+ return SR_ERR_ARG;
- if (!(device = g_try_malloc0(sizeof(struct sr_device)))) {
- sr_err("dev: %s: device malloc failed", __func__);
- return NULL;
+ ret = SR_ERR_ARG;
+ for (l = sdi->channels; l; l = l->next) {
+ ch = l->data;
+ if (ch->index == channelnum) {
+ was_enabled = ch->enabled;
+ ch->enabled = state;
+ ret = SR_OK;
+ if (!state != !was_enabled && sdi->driver
+ && sdi->driver->config_channel_set) {
+ ret = sdi->driver->config_channel_set(
+ sdi, ch, SR_CHANNEL_SET_ENABLED);
+ /* Roll back change if it wasn't applicable. */
+ if (ret == SR_ERR_ARG)
+ ch->enabled = was_enabled;
+ }
+ break;
+ }
}
- device->plugin = (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;
+ return ret;
}
/**
- * Clear all probes of the specified device.
+ * Determine whether the specified device instance has the specified
+ * capability.
*
- * This removes/clears the 'name' and 'trigger' fields of all probes of
- * the device.
+ * @param sdi Pointer to the device instance to be checked. Must not be NULL.
+ * If the device's 'driver' field is NULL (virtual device), this
+ * function will always return FALSE (virtual devices don't have
+ * a hardware capabilities list).
+ * @param[in] key The option that should be checked for is supported by the
+ * specified device.
*
- * The order in which the probes are cleared is not specified. The caller
- * should not assume or rely on a specific order.
+ * @retval TRUE Device has the specified option
+ * @retval FALSE Device does not have the specified option, invalid input
+ * parameters or other error conditions.
*
- * 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.
+ * @since 0.2.0
*/
-int sr_device_clear(struct sr_device *device)
+SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
{
- unsigned int pnum;
-
- if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
- return SR_ERR_ARG;
+ GVariant *gvar;
+ const int *devopts;
+ gsize num_opts, i;
+ int ret;
+
+ if (!sdi || !sdi->driver || !sdi->driver->config_list)
+ return FALSE;
+
+ if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
+ &gvar, sdi, NULL) != SR_OK)
+ return FALSE;
+
+ ret = FALSE;
+ devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
+ for (i = 0; i < num_opts; i++) {
+ if (devopts[i] == key) {
+ ret = TRUE;
+ break;
+ }
}
+ g_variant_unref(gvar);
- /* 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;
+ return ret;
}
-/**
- * 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.
+/** @private
+ * Allocate and init new device instance struct.
+ * @param[in] index @copydoc sr_dev_inst::index
+ * @param[in] status @copydoc sr_dev_inst::status
+ * @param[in] vendor @copydoc sr_dev_inst::vendor
+ * @param[in] model @copydoc sr_dev_inst::model
+ * @param[in] version @copydoc sr_dev_inst::version
+ *
+ * @retval NULL Error
+ * @retval struct sr_dev_inst *. Dynamically allocated, free using
+ * sr_dev_inst_free().
*/
-int sr_device_probe_clear(struct sr_device *device, int probenum)
+SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
+ const char *vendor, const char *model, const char *version)
{
- struct sr_probe *p;
+ struct sr_dev_inst *sdi;
- if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
- return SR_ERR_ARG;
+ if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
+ sr_err("Device instance malloc failed.");
+ return NULL;
}
- /* TODO: Sanity check on 'probenum'. */
+ sdi->driver = NULL;
+ sdi->index = index;
+ sdi->status = status;
+ sdi->inst_type = -1;
+ sdi->vendor = vendor ? g_strdup(vendor) : NULL;
+ sdi->model = model ? g_strdup(model) : NULL;
+ sdi->version = version ? g_strdup(version) : NULL;
+ sdi->channels = NULL;
+ sdi->channel_groups = NULL;
+ sdi->session = NULL;
+ sdi->conn = NULL;
+ sdi->priv = NULL;
+
+ return sdi;
+}
- 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? */
- }
+/** @private
+ * Free device instance struct created by sr_dev_inst().
+ * @param sdi struct* to free.
+ */
+SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
+{
+ struct sr_channel *ch;
+ GSList *l;
- /* If the probe has a name, remove it. */
- if (p->name) {
- g_free(p->name);
- p->name = NULL;
+ for (l = sdi->channels; l; l = l->next) {
+ ch = l->data;
+ g_free(ch->name);
+ g_free(ch);
}
+ g_slist_free(sdi->channels);
- /* If the probe has a trigger, remove it. */
- if (p->trigger) {
- g_free(p->trigger);
- p->trigger = NULL;
- }
+ if (sdi->channel_groups)
+ g_slist_free(sdi->channel_groups);
- return SR_OK;
+ g_free(sdi->vendor);
+ g_free(sdi->model);
+ g_free(sdi->version);
+ g_free(sdi);
}
-/**
- * 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_device_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.
+#ifdef HAVE_LIBUSB_1_0
+
+/** @private
+ * Allocate and init struct for USB device instance.
+ * @param[in] bus @copydoc sr_usb_dev_inst::bus
+ * @param[in] address @copydoc sr_usb_dev_inst::address
+ * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
*
- * @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.
+ * @retval NULL Error
+ * @retval other struct sr_usb_dev_inst * for USB device instance.
*/
-int sr_device_probe_add(struct sr_device *device, const char *name)
+SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
+ uint8_t address, struct libusb_device_handle *hdl)
{
- struct sr_probe *p;
- char probename[16]; /* FIXME: Don't hardcode 16? #define? */
- int probenum;
-
- if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
- return SR_ERR_ARG;
- }
+ struct sr_usb_dev_inst *udi;
- if (!name) {
- sr_err("dev: %s: name was NULL", __func__);
- return SR_ERR_ARG;
+ if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
+ sr_err("USB device instance malloc failed.");
+ return NULL;
}
- /* TODO: Further checks to ensure name is valid. */
+ udi->bus = bus;
+ udi->address = address;
+ udi->devhdl = hdl;
- probenum = g_slist_length(device->probes) + 1;
+ return udi;
+}
- if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) {
- sr_err("dev: %s: p malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
+/** @private
+ * Free struct * allocated by sr_usb_dev_inst().
+ * @param usb struct* to free. Must not be NULL.
+ */
+SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
+{
+ g_free(usb);
+}
- 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->trigger = NULL;
- device->probes = g_slist_append(device->probes, p);
+#endif
- return SR_OK;
-}
+#ifdef HAVE_LIBSERIALPORT
/**
- * Find the probe with the specified number in the specified device.
- *
- * TODO
+ * @private
*
- * @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!).
+ * Both parameters are copied to newly allocated strings, and freed
+ * automatically by sr_serial_dev_inst_free().
*
- * TODO: Should return int.
- * TODO: probenum should be unsigned.
+ * @param[in] port OS-specific serial port specification. Examples:
+ * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
+ * @param[in] serialcomm A serial communication parameters string, in the form
+ * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
+ * "9600/8n1" or "600/7o2". This is an optional parameter;
+ * it may be filled in later.
*
- * @return A pointer to the requested probe's 'struct sr_probe', or NULL
- * if the probe could not be found.
+ * @return A pointer to a newly initialized struct sr_serial_dev_inst,
+ * or NULL on error.
*/
-struct sr_probe *sr_device_probe_find(const struct sr_device *device,
- int probenum)
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
+ const char *serialcomm)
{
- GSList *l;
- struct sr_probe *p, *found_probe;
+ struct sr_serial_dev_inst *serial;
- if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
- return NULL; /* TODO: SR_ERR_ARG */
+ if (!port) {
+ sr_err("Serial port required.");
+ return NULL;
}
- /* TODO: Sanity check on probenum. */
-
- found_probe = NULL;
- for (l = device->probes; l; l = l->next) {
- p = l->data;
- /* TODO: Check for p != NULL. */
- if (p->index == probenum) {
- found_probe = p;
- break;
- }
+ if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
+ sr_err("Serial device instance malloc failed.");
+ return NULL;
}
- return found_probe;
+ serial->port = g_strdup(port);
+ if (serialcomm)
+ serial->serialcomm = g_strdup(serialcomm);
+
+ return serial;
}
-/**
- * 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.
+/** @private
+ * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
+ * @param serial struct sr_serial_dev_inst * to free. Must not be NULL.
*/
-int sr_device_probe_name(struct sr_device *device, int probenum,
- const char *name)
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
{
- struct sr_probe *p;
+ g_free(serial->port);
+ g_free(serial->serialcomm);
+ g_free(serial);
+}
+#endif
+
+/** @private */
+SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
+{
+ struct sr_usbtmc_dev_inst *usbtmc;
if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
- return SR_ERR_ARG;
+ sr_err("Device name required.");
+ return NULL;
}
- p = sr_device_probe_find(device, probenum);
- if (!p) {
- sr_err("dev: %s: probe %d not found", __func__, probenum);
- return SR_ERR; /* TODO: More specific error? */
+ if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
+ sr_err("USBTMC device instance malloc failed.");
+ return NULL;
}
- /* TODO: Sanity check on 'name'. */
+ usbtmc->device = g_strdup(device);
+ usbtmc->fd = -1;
- /* If the probe already has a name, kill it first. */
- if (p->name)
- g_free(p->name);
-
- p->name = g_strdup(name);
+ return usbtmc;
+}
- return SR_OK;
+/** @private */
+SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
+{
+ g_free(usbtmc->device);
+ g_free(usbtmc);
}
/**
- * Remove all triggers set up for the specified device.
+ * Get the list of devices/instances of the specified driver.
*
- * TODO: Better description.
+ * @param driver The driver to use. Must not be NULL.
*
- * @param device TODO
+ * @return The list of devices/instances of this driver, or NULL upon errors
+ * or if the list is empty.
*
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
- * If something other than SR_OK is returned, 'device' is unchanged.
+ * @since 0.2.0
*/
-int sr_device_trigger_clear(struct sr_device *device)
+SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
{
- 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_device_probe_find(device, pnum);
- /* TODO: Silently ignore probes which cannot be found? */
- if (p && p->trigger) {
- g_free(p->trigger);
- p->trigger = NULL;
- }
- }
-
- return SR_OK;
+ if (driver && driver->dev_list)
+ return driver->dev_list();
+ else
+ return NULL;
}
/**
- * Add a trigger to the specified device.
+ * Clear the list of device instances a driver knows about.
*
- * TODO: Better description.
- * TODO: Describe valid format of the 'trigger' string.
+ * @param driver The driver to use. This must be a pointer to one of
+ * the entries returned by sr_driver_list(). Must not be NULL.
*
- * @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?
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid driver
*
- * @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.
+ * @since 0.2.0
*/
-int sr_device_trigger_set(struct sr_device *device, int probenum,
- const char *trigger)
+SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
{
- struct sr_probe *p;
+ int ret;
- if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
+ if (!driver) {
+ sr_err("Invalid driver.");
return SR_ERR_ARG;
}
- /* TODO: Sanity check on 'probenum'. */
-
- /* TODO: Sanity check on 'trigger'. */
-
- p = sr_device_probe_find(device, probenum);
- if (!p) {
- sr_err("dev: %s: probe %d not found", __func__, probenum);
- return SR_ERR; /* TODO: More specific error? */
- }
-
- /* If the probe already has a trigger, kill it first. */
- if (p->trigger)
- g_free(p->trigger);
+ if (driver->dev_clear)
+ ret = driver->dev_clear();
+ else
+ ret = std_dev_clear(driver, NULL);
- p->trigger = g_strdup(trigger);
-
- return SR_OK;
+ return ret;
}
/**
- * Determine whether the specified device has the specified capability.
+ * Open the specified device.
*
- * TODO: Should return int?
+ * @param sdi Device instance to use. Must not be NULL.
*
- * @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 SR_OK upon success, a negative error code upon errors.
*
- * @return TRUE, if the device has the specified capability, FALSE otherwise.
- * FALSE is also returned upon invalid input parameters or other
- * error conditions.
+ * @since 0.2.0
*/
-gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
+SR_API int sr_dev_open(struct sr_dev_inst *sdi)
{
- int *capabilities, i;
+ int ret;
- if (!device) {
- sr_err("dev: %s: device was NULL", __func__);
- return FALSE; /* TODO: SR_ERR_ARG. */
- }
+ if (!sdi || !sdi->driver || !sdi->driver->dev_open)
+ return SR_ERR;
- if (!device->plugin) {
- sr_err("dev: %s: device->plugin was NULL", __func__);
- return FALSE; /* TODO: SR_ERR_ARG. */
- }
+ ret = sdi->driver->dev_open(sdi);
- /* TODO: Sanity check on 'hwcap'. */
+ return ret;
+}
- if (!(capabilities = device->plugin->get_capabilities())) {
- sr_err("dev: %s: device has no capabilities", __func__);
- return FALSE; /* TODO: SR_ERR*. */
- }
+/**
+ * Close the specified device.
+ *
+ * @param sdi Device instance to use. Must not be NULL.
+ *
+ * @return SR_OK upon success, a negative error code upon errors.
+ *
+ * @since 0.2.0
+ */
+SR_API int sr_dev_close(struct sr_dev_inst *sdi)
+{
+ int ret;
- for (i = 0; capabilities[i]; i++) {
- if (capabilities[i] != hwcap)
- continue;
- sr_spew("dev: %s: found hwcap %d", __func__, hwcap);
- return TRUE;
- }
+ if (!sdi || !sdi->driver || !sdi->driver->dev_close)
+ return SR_ERR;
- sr_spew("dev: %s: hwcap %d not found", __func__, hwcap);
+ ret = sdi->driver->dev_close(sdi);
- return FALSE;
+ return ret;
}
+
+/** @} */
projects / libsigrok.git / blobdiff