]> sigrok.org Git - libsigrok.git/blobdiff - device.c
build: Portability fixes.
[libsigrok.git] / device.c
index 6921ceb0fad60243a8eae13e06adfc2434af4167..434d1066aac692d7a8a6f732f80938cc02f7ff02 100644 (file)
--- a/device.c
+++ b/device.c
@@ -1,7 +1,7 @@
 /*
- * 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"
 
-extern struct sr_global *global;
+/** @cond PRIVATE */
+#define LOG_PREFIX "device"
+/** @endcond */
 
-GSList *devices = NULL;
+/**
+ * @file
+ *
+ * Device handling in libsigrok.
+ */
 
+/**
+ * @defgroup grp_devices Devices
+ *
+ * Device handling in libsigrok.
+ *
+ * @{
+ */
 
-void sr_device_scan(void)
+/** @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 NULL (failure) or new struct sr_channel*.
+ */
+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;
-
-       plugins = sr_list_hwplugins();
+       struct sr_channel *ch;
 
-       /*
-        * 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;
-               sr_init_hwplugins(plugin);
+       if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
+               sr_err("Channel malloc failed.");
+               return NULL;
        }
 
+       ch->index = index;
+       ch->type = type;
+       ch->enabled = enabled;
+       if (name)
+               ch->name = g_strdup(name);
+
+       return ch;
 }
 
-GSList *sr_device_list(void)
+/**
+ * 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.
+ *
+ * @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.
+ *
+ * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
+ *
+ * @since 0.3.0
+ */
+SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
+               int channelnum, const char *name)
 {
+       GSList *l;
+       struct sr_channel *ch;
+       int ret;
 
-       if (!devices)
-               sr_device_scan();
+       if (!sdi) {
+               sr_err("%s: sdi was NULL", __func__);
+               return SR_ERR_ARG;
+       }
 
-       return devices;
+       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;
 }
 
-struct sr_device *sr_device_new(struct sr_device_plugin *plugin, int plugin_index,
-                            int num_probes)
+/**
+ * Enable or disable a channel on the specified device.
+ *
+ * @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.
+ *
+ * @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.
+ *
+ * @since 0.3.0
+ */
+SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
+               gboolean state)
 {
-       struct sr_device *device;
-       int i;
-
-       if (!(device = g_try_malloc0(sizeof(struct sr_device)))) {
-               sr_err("dev: %s: device malloc failed", __func__);
-               return NULL;
+       GSList *l;
+       struct sr_channel *ch;
+       int ret;
+       gboolean was_enabled;
+
+       if (!sdi)
+               return SR_ERR_ARG;
+
+       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 = plugin;
-       device->plugin_index = plugin_index;
-       devices = g_slist_append(devices, device);
+       return ret;
+}
+
+/**
+ * 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[in] key The option that should be checked for is supported by the
+ *            specified device.
+ *
+ * @retval TRUE Device has the specified option
+ * @retval FALSE Device does not have the specified option, invalid input
+ *         parameters or other error conditions.
+ *
+ * @since 0.2.0
+ */
+SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
+{
+       GVariant *gvar;
+       const int *devopts;
+       gsize num_opts, i;
+       int ret;
+
+       if (!sdi || !sdi->driver || !sdi->driver->config_list)
+               return FALSE;
 
-       for (i = 0; i < num_probes; i++)
-               sr_device_probe_add(device, NULL);
+       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);
 
-       return device;
+       return ret;
 }
 
-void sr_device_clear(struct sr_device *device)
+/** @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().
+ */
+SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
+               const char *vendor, const char *model, const char *version)
 {
-       unsigned int pnum;
+       struct sr_dev_inst *sdi;
 
-       if (!device->probes)
-               return;
+       if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
+               sr_err("Device instance malloc failed.");
+               return NULL;
+       }
 
-       for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++)
-               sr_device_probe_clear(device, pnum);
+       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;
 }
 
-void sr_device_probe_clear(struct sr_device *device, int probenum)
+/** @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_probe *p;
-
-       p = sr_device_probe_find(device, probenum);
-       if (!p)
-               return;
+       struct sr_channel *ch;
+       GSList *l;
 
-       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 (sdi->channel_groups)
+               g_slist_free(sdi->channel_groups);
+
+       g_free(sdi->vendor);
+       g_free(sdi->model);
+       g_free(sdi->version);
+       g_free(sdi);
+}
+
+#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
+ *
+ *  @retval NULL Error
+ *  @retval other struct sr_usb_dev_inst * for USB device instance.
+ */
+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_usb_dev_inst *udi;
 
-       if (p->trigger) {
-               g_free(p->trigger);
-               p->trigger = NULL;
+       if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
+               sr_err("USB device instance malloc failed.");
+               return NULL;
        }
+
+       udi->bus = bus;
+       udi->address = address;
+       udi->devhdl = hdl;
+
+       return udi;
 }
 
-void sr_device_probe_add(struct sr_device *device, const char *name)
+/** @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)
 {
-       struct sr_probe *p;
-       char probename[16];
-       int probenum;
+       g_free(usb);
+}
+
+#endif
 
-       probenum = g_slist_length(device->probes) + 1;
+#ifdef HAVE_LIBSERIALPORT
 
-       if (!(p = g_try_malloc0(sizeof(struct sr_probe)))) {
-               sr_err("dev: %s: p malloc failed", __func__);
-               // return SR_ERR_MALLOC;
-               return; /* FIXME: should return int. */
+/**
+ * @private
+ *
+ * Both parameters are copied to newly allocated strings, and freed
+ * automatically by sr_serial_dev_inst_free().
+ *
+ * @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 a newly initialized struct sr_serial_dev_inst,
+ *         or NULL on error.
+ */
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
+               const char *serialcomm)
+{
+       struct sr_serial_dev_inst *serial;
+
+       if (!port) {
+               sr_err("Serial port required.");
+               return NULL;
        }
 
-       p->index = probenum;
-       p->enabled = TRUE;
-       if (name) {
-               p->name = g_strdup(name);
-       } else {
-               snprintf(probename, 16, "%d", probenum);
-               p->name = g_strdup(probename);
+       if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
+               sr_err("Serial device instance malloc failed.");
+               return NULL;
        }
-       p->trigger = NULL;
-       device->probes = g_slist_append(device->probes, p);
+
+       serial->port = g_strdup(port);
+       if (serialcomm)
+               serial->serialcomm = g_strdup(serialcomm);
+
+       return serial;
 }
 
-struct sr_probe *sr_device_probe_find(struct sr_device *device, int probenum)
+/** @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.
+ */
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 {
-       GSList *l;
-       struct sr_probe *p, *found_probe;
+       g_free(serial->port);
+       g_free(serial->serialcomm);
+       g_free(serial);
+}
+#endif
 
-       found_probe = NULL;
-       for (l = device->probes; l; l = l->next) {
-               p = l->data;
-               if (p->index == probenum) {
-                       found_probe = p;
-                       break;
-               }
+/** @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("Device name required.");
+               return NULL;
        }
 
-       return found_probe;
-}
+       if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
+               sr_err("USBTMC device instance malloc failed.");
+               return NULL;
+       }
 
-/* TODO: return SR_ERR if probenum not found */
-void sr_device_probe_name(struct sr_device *device, int probenum,
-                         const char *name)
-{
-       struct sr_probe *p;
+       usbtmc->device = g_strdup(device);
+       usbtmc->fd = -1;
 
-       p = sr_device_probe_find(device, probenum);
-       if (!p)
-               return;
+       return usbtmc;
+}
 
-       if (p->name)
-               g_free(p->name);
-       p->name = g_strdup(name);
+/** @private */
+SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
+{
+       g_free(usbtmc->device);
+       g_free(usbtmc);
 }
 
-/* TODO: return SR_ERR if probenum not found */
-void sr_device_trigger_clear(struct sr_device *device)
+/**
+ * Get the list of devices/instances of the specified driver.
+ *
+ * @param driver The driver to use. Must not be NULL.
+ *
+ * @return The list of devices/instances of this driver, or NULL upon errors
+ *         or if the list is empty.
+ *
+ * @since 0.2.0
+ */
+SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
 {
-       struct sr_probe *p;
-       unsigned int pnum;
+       if (driver && driver->dev_list)
+               return driver->dev_list();
+       else
+               return NULL;
+}
 
-       if (!device->probes)
-               return;
+/**
+ * Clear the list of device instances a driver knows about.
+ *
+ * @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.
+ *
+ * @retval SR_OK Success
+ * @retval SR_ERR_ARG Invalid driver
+ *
+ * @since 0.2.0
+ */
+SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
+{
+       int ret;
 
-       for (pnum = 1; pnum <= g_slist_length(device->probes); pnum++) {
-               p = sr_device_probe_find(device, pnum);
-               if (p && p->trigger) {
-                       g_free(p->trigger);
-                       p->trigger = NULL;
-               }
+       if (!driver) {
+               sr_err("Invalid driver.");
+               return SR_ERR_ARG;
        }
+
+       if (driver->dev_clear)
+               ret = driver->dev_clear();
+       else
+               ret = std_dev_clear(driver, NULL);
+
+       return ret;
 }
 
-/* TODO: return SR_ERR if probenum not found */
-void sr_device_trigger_set(struct sr_device *device, int probenum,
-                          const char *trigger)
+/**
+ * Open 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_open(struct sr_dev_inst *sdi)
 {
-       struct sr_probe *p;
+       int ret;
 
-       p = sr_device_probe_find(device, probenum);
-       if (!p)
-               return;
+       if (!sdi || !sdi->driver || !sdi->driver->dev_open)
+               return SR_ERR;
 
-       if (p->trigger)
-               g_free(p->trigger);
-
-       p->trigger = g_strdup(trigger);
+       ret = sdi->driver->dev_open(sdi);
 
+       return ret;
 }
 
-gboolean sr_device_has_hwcap(struct sr_device *device, int hwcap)
+/**
+ * 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 *capabilities, i;
+       int ret;
 
-       if (!device || !device->plugin)
-               return FALSE;
+       if (!sdi || !sdi->driver || !sdi->driver->dev_close)
+               return SR_ERR;
 
-       if ((capabilities = device->plugin->get_capabilities()))
-               for (i = 0; capabilities[i]; i++)
-                       if (capabilities[i] == hwcap)
-                               return TRUE;
+       ret = sdi->driver->dev_close(sdi);
 
-       return FALSE;
+       return ret;
 }
+
+/** @} */