X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=device.c;h=0aeb41595fc1522f3fd6aa5be1f403ad306a42a0;hb=79bb0e97d53526ef6deb491ea9c7698ed6e90631;hp=72cba33873fba72fe74a112df3d05ec4aebfad99;hpb=c37d2b1ba12b62d63590509879bf58adf842896d;p=libsigrok.git

diff --git a/device.c b/device.c
index 72cba338..0aeb4159 100644
--- a/device.c
+++ b/device.c
@@ -1,7 +1,7 @@
 /*
  * 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
@@ -19,471 +19,328 @@
 
 #include <stdio.h>
 #include <glib.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
-
-static GSList *devices = NULL;
+#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
+
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "device: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
 
 /**
- * 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_device_list().
- *
- * TODO: Error checks?
- * TODO: Option to only scan for specific devices or device classes.
+ * @file
  *
- * @return SR_OK upon success, SR_ERR upon errors.
+ * Device handling in libsigrok.
  */
-int sr_device_scan(void)
-{
-	GSList *plugins, *l;
-	struct sr_device_plugin *plugin;
-
-	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
-	 * 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);
-	}
-
-	return SR_OK;
-}
 
 /**
- * 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_device_scan() -- is performed first.
+ * @defgroup grp_devices Devices
  *
- * TODO: Error handling?
+ * Device handling in libsigrok.
  *
- * @return The list (GSList) of detected devices, or NULL if none were found.
+ * @{
  */
-GSList *sr_device_list(void)
-{
-	if (!devices)
-		sr_device_scan();
-
-	return devices;
-}
 
-/**
- * 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_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
- * 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.
- */
-struct sr_device *sr_device_new(const struct sr_device_plugin *plugin,
-				int plugin_index)
+/** @private */
+SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
+		gboolean enabled, const char *name)
 {
-	struct sr_device *device;
-
-	/* TODO: Check if plugin_index valid? */
+	struct sr_probe *probe;
 
-	if (!(device = g_try_malloc0(sizeof(struct sr_device)))) {
-		sr_err("dev: %s: device malloc failed", __func__);
+	if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
+		sr_err("Probe malloc failed.");
 		return NULL;
 	}
 
-	device->plugin = (struct sr_device_plugin *)plugin;
-	device->plugin_index = plugin_index;
-	devices = g_slist_append(devices, device);
+	probe->index = index;
+	probe->type = type;
+	probe->enabled = enabled;
+	if (name)
+		probe->name = g_strdup(name);
 
-	return device;
+	return probe;
 }
 
 /**
- * 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.
+ * Set the name of the specified probe in the specified device.
  *
- * TODO: Rename to sr_device_clear_probes() or sr_device_probe_clear_all().
+ * If the probe already has a different name assigned to it, it will be
+ * removed, and the new name will be saved instead.
  *
- * @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).
+ * @param sdi The device instance the probe is connected to.
+ * @param probenum The number of the probe whose name to set.
+ *                 Note that the probe numbers start at 0.
+ * @param name The new name that the specified probe should get. A copy
+ *             of the string is made.
  *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
- *         If something other than SR_OK is returned, 'device' is unchanged.
+ * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  */
-int sr_device_clear(struct sr_device *device)
+SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
+		int probenum, const char *name)
 {
-	unsigned int pnum;
+	GSList *l;
+	struct sr_probe *probe;
+	int ret;
 
-	if (!device) {
-		sr_err("dev: %s: device was NULL", __func__);
+	if (!sdi) {
+		sr_err("%s: sdi 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);
+	ret = SR_ERR_ARG;
+	for (l = sdi->probes; l; l = l->next) {
+		probe = l->data;
+		if (probe->index == probenum) {
+			g_free(probe->name);
+			probe->name = g_strdup(name);
+			ret = SR_OK;
+			break;
+		}
+	}
 
-	return SR_OK;
+	return ret;
 }
 
 /**
- * Clear the specified probe in the specified device.
+ * Enable or disable a probe on the specified device.
  *
- * The probe itself still exists afterwards, but its 'name' and 'trigger'
- * fields are g_free()'d and set to NULL.
+ * @param sdi The device instance the probe is connected to.
+ * @param probenum The probe number, starting from 0.
+ * @param state TRUE to enable the probe, FALSE to disable.
  *
- * @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.
+ * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  */
-int sr_device_probe_clear(struct sr_device *device, int probenum)
+SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
+		gboolean state)
 {
-	struct sr_probe *p;
+	GSList *l;
+	struct sr_probe *probe;
+	int ret;
 
-	if (!device) {
-		sr_err("dev: %s: device was NULL", __func__);
+	if (!sdi)
 		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;
+	ret = SR_ERR_ARG;
+	for (l = sdi->probes; l; l = l->next) {
+		probe = l->data;
+		if (probe->index == probenum) {
+			probe->enabled = state;
+			ret = SR_OK;
+			break;
+		}
 	}
 
-	return SR_OK;
+	return ret;
 }
 
 /**
- * Add a probe with the specified name to the specified device.
+ * Add a trigger to the specified device (and the specified probe).
  *
- * The added probe is automatically enabled (the 'enabled' field is TRUE).
+ * If the specified probe of this device already has a trigger, it will
+ * be silently replaced.
  *
- * The 'trigger' field of the added probe is set to NULL. A trigger can be
- * added via sr_device_trigger_set().
+ * @param sdi Must not be NULL.
+ * @param probenum The probe number, starting from 0.
+ * @param trigger Trigger string, in the format used by sigrok-cli
  *
- * 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.
+ * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  */
-int sr_device_probe_add(struct sr_device *device, const char *name)
+SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
+		const char *trigger)
 {
-	struct sr_probe *p;
-	int probenum;
-
-	if (!device) {
-		sr_err("dev: %s: device was NULL", __func__);
-		return SR_ERR_ARG;
-	}
+	GSList *l;
+	struct sr_probe *probe;
+	int ret;
 
-	if (!name) {
-		sr_err("dev: %s: name was NULL", __func__);
+	if (!sdi)
 		return SR_ERR_ARG;
-	}
-
-	/* TODO: Further checks to ensure name is valid. */
 
-	probenum = g_slist_length(device->probes) + 1;
-
-	if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) {
-		sr_err("dev: %s: p malloc failed", __func__);
-		return SR_ERR_MALLOC;
+	ret = SR_ERR_ARG;
+	for (l = sdi->probes; l; l = l->next) {
+		probe = l->data;
+		if (probe->index == probenum) {
+			/* If the probe already has a trigger, kill it first. */
+			g_free(probe->trigger);
+			probe->trigger = g_strdup(trigger);
+			ret = SR_OK;
+			break;
+		}
 	}
 
-	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;
+	return ret;
 }
 
 /**
- * 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.
+ * Determine whether the specified device instance has the specified
+ * capability.
+ *
+ * @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 option The option that should be checked for support on the
+ *            specified device.
+ *
+ * @return TRUE if the device has the specified option, FALSE otherwise.
+ *         FALSE is also returned on invalid input parameters or other
+ *         error conditions.
  */
-struct sr_probe *sr_device_probe_find(const struct sr_device *device,
-				      int probenum)
+SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
 {
-	GSList *l;
-	struct sr_probe *p, *found_probe;
+	const int *devopts;
+	int i;
 
-	if (!device) {
-		sr_err("dev: %s: device was NULL", __func__);
-		return NULL; /* TODO: SR_ERR_ARG */
-	}
+	if (!sdi || !sdi->driver)
+		return FALSE;
 
-	/* TODO: Sanity check on probenum. */
+	if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
+			(const void **)&devopts, NULL) != SR_OK)
+		return FALSE;
 
-	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;
-		}
+	for (i = 0; devopts[i]; i++) {
+		if (devopts[i] == key)
+			return TRUE;
 	}
 
-	return found_probe;
+	return FALSE;
 }
 
-/**
- * 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.
- */
-int sr_device_probe_name(struct sr_device *device, int probenum,
-			 const char *name)
+/** @private */
+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;
-	}
-
-	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 (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
+		sr_err("Device instance malloc failed.");
+		return NULL;
 	}
 
-	/* TODO: Sanity check on 'name'. */
-
-	/* If the probe already has a name, kill it first. */
-	if (p->name)
-		g_free(p->name);
-
-	p->name = g_strdup(name);
-
-	return SR_OK;
+	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->probes = NULL;
+	sdi->priv = NULL;
+
+	return sdi;
 }
 
-/**
- * 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.
- */
-int sr_device_trigger_clear(struct sr_device *device)
+/** @private */
+SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 {
-	struct sr_probe *p;
-	unsigned int pnum; /* TODO: uint16_t? */
-
-	if (!device) {
-		sr_err("dev: %s: device was NULL", __func__);
-		return SR_ERR_ARG;
-	}
+	struct sr_probe *probe;
+	GSList *l;
 
-	if (!device->probes) {
-		sr_err("dev: %s: device->probes was NULL", __func__);
-		return SR_ERR_ARG;
+	for (l = sdi->probes; l; l = l->next) {
+		probe = l->data;
+		g_free(probe->name);
+		g_free(probe);
 	}
 
-	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;
-		}
-	}
+	g_free(sdi->priv);
+	g_free(sdi->vendor);
+	g_free(sdi->model);
+	g_free(sdi->version);
+	g_free(sdi);
 
-	return SR_OK;
 }
 
-/**
- * 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.
- */
-int sr_device_trigger_set(struct sr_device *device, int probenum,
-			  const char *trigger)
+#ifdef HAVE_LIBUSB_1_0
+
+/** @private */
+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;
+	struct sr_usb_dev_inst *udi;
 
-	if (!device) {
-		sr_err("dev: %s: device 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: 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? */
-	}
+	udi->bus = bus;
+	udi->address = address;
+	udi->devhdl = hdl;
 
-	/* If the probe already has a trigger, kill it first. */
-	if (p->trigger)
-		g_free(p->trigger);
+	return udi;
+}
 
-	p->trigger = g_strdup(trigger);
+/** @private */
+SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
+{
+	(void)usb;
 
-	return SR_OK;
+	/* Nothing to do for this device instance type. */
 }
 
-/**
- * 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).
+#endif
+
+/** @private
+ * @param pathname OS-specific serial port specification. Examples:
+ * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
+ * @param 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 a newly initialized struct sr_serial_dev_inst,
+ * or NULL on error.
  *
- * @return TRUE, if the device has the specified capability, FALSE otherwise.
- *         FALSE is also returned upon invalid input parameters or other
- *         error conditions.
+ * Both parameters are copied to newly allocated strings, and freed
+ * automatically by sr_serial_dev_inst_free().
  */
-gboolean sr_device_has_hwcap(const struct sr_device *device, int hwcap)
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
+		const char *serialcomm)
 {
-	int *capabilities, i;
+	struct sr_serial_dev_inst *serial;
 
-	if (!device) {
-		sr_err("dev: %s: device was NULL", __func__);
-		return FALSE; /* TODO: SR_ERR_ARG. */
+	if (!port) {
+		sr_err("Serial port required.");
+		return NULL;
 	}
 
-	if (!device->plugin) {
-		sr_err("dev: %s: device->plugin was NULL", __func__);
-		return FALSE; /* TODO: SR_ERR_ARG. */
+	if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
+		sr_err("Serial device instance malloc failed.");
+		return NULL;
 	}
 
-	/* TODO: Sanity check on 'hwcap'. */
+	serial->port = g_strdup(port);
+	if (serialcomm)
+		serial->serialcomm = g_strdup(serialcomm);
+	serial->fd = -1;
 
-	if (!(capabilities = device->plugin->get_capabilities())) {
-		sr_err("dev: %s: device has no capabilities", __func__);
-		return FALSE; /* TODO: SR_ERR*. */
-	}
+	return serial;
+}
 
-	for (i = 0; capabilities[i]; i++) {
-		if (capabilities[i] != hwcap)
-			continue;
-		sr_spew("dev: %s: found hwcap %d", __func__, hwcap);
-		return TRUE;
-	}
+/** @private */
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
+{
+	g_free(serial->port);
+	g_free(serial->serialcomm);
+	g_free(serial);
+}
 
-	sr_spew("dev: %s: hwcap %d not found", __func__, hwcap);
+SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver)
+{
+	if (driver && driver->dev_list)
+		return driver->dev_list();
+	else
+		return NULL;
+}
 
-	return FALSE;
+SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver)
+{
+	if (driver && driver->dev_clear)
+		return driver->dev_clear();
+	else
+		return SR_OK;
 }
+
+/** @} */