]> sigrok.org Git - libsigrok.git/blobdiff - src/device.c
Build: Set local include directories in Makefile.am
[libsigrok.git] / src / device.c
index 8367ec28c40b9ab67312c762843fb4665dade92a..fe3e231616e67c13989be8340cb74dcddd7195ae 100644 (file)
@@ -20,7 +20,7 @@
 #include <stdio.h>
 #include <glib.h>
 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 /** @cond PRIVATE */
  */
 
 /** @private
- *  Allocate and initialize new struct sr_channel
+ *  Allocate and initialize new struct sr_channel and add to sdi.
+ *  @param[in]  sdi The device instance the channel is connected to.
  *  @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*.
+ *  @return A new struct sr_channel*.
  */
-SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
-               gboolean enabled, const char *name)
+SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
+               int index, int type, gboolean enabled, const char *name)
 {
        struct sr_channel *ch;
 
-       if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
-               sr_err("Channel malloc failed.");
-               return NULL;
-       }
-
+       ch = g_malloc0(sizeof(struct sr_channel));
+       ch->sdi = sdi;
        ch->index = index;
        ch->type = type;
        ch->enabled = enabled;
        if (name)
                ch->name = g_strdup(name);
 
+       sdi->channels = g_slist_append(sdi->channels, ch);
+
        return ch;
 }
 
 /**
- * Set the name of the specified channel in the specified device.
+ * Set the name of the specified channel.
  *
  * 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.
+ * @param[in] channel The channel whose name to set.
+ * @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)
+SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
+               const char *name)
 {
-       GSList *l;
-       struct sr_channel *ch;
-       int ret;
-
-       if (!sdi) {
-               sr_err("%s: sdi was NULL", __func__);
+       if (!channel) {
+               sr_err("%s: channel 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;
+       g_free(channel->name);
+       channel->name = g_strdup(name);
+       return SR_OK;
 }
 
 /**
- * Enable or disable a channel on the specified device.
+ * Enable or disable a channel.
  *
- * @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[in] channel The channel to enable or disable.
+ * @param[in] 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
@@ -124,37 +108,29 @@ SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
  *
  * @since 0.3.0
  */
-SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
+SR_API int sr_dev_channel_enable(struct sr_channel *channel,
                gboolean state)
 {
-       GSList *l;
-       struct sr_channel *ch;
        int ret;
        gboolean was_enabled;
+       struct sr_dev_inst *sdi;
 
-       if (!sdi)
+       if (!channel)
                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;
-               }
+       sdi = channel->sdi;
+       was_enabled = channel->enabled;
+       channel->enabled = state;
+       if (!state != !was_enabled && sdi->driver
+                       && sdi->driver->config_channel_set) {
+               ret = sdi->driver->config_channel_set(
+                       sdi, channel, SR_CHANNEL_SET_ENABLED);
+               /* Roll back change if it wasn't applicable. */
+               if (ret != SR_OK)
+                       return ret;
        }
 
-       return ret;
+       return SR_OK;
 }
 
 /**
@@ -231,16 +207,10 @@ SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
  */
 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
 {
-       struct sr_channel *ch;
-
        if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
                return SR_ERR_ARG;
 
-       ch = sr_channel_new(index, type, TRUE, name);
-       if (!ch)
-               return SR_ERR;
-
-       sdi->channels = g_slist_append(sdi->channels, ch);
+       sr_channel_new(sdi, index, type, TRUE, name);
 
        return SR_OK;
 }
@@ -288,7 +258,6 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
  *  @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,
@@ -296,11 +265,7 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 {
        struct sr_usb_dev_inst *udi;
 
-       if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
-               sr_err("USB device instance malloc failed.");
-               return NULL;
-       }
-
+       udi = g_malloc0(sizeof(struct sr_usb_dev_inst));
        udi->bus = bus;
        udi->address = address;
        udi->devhdl = hdl;
@@ -329,10 +294,11 @@ SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
  *
  * @param[in] port OS-specific serial port specification. Examples:
  *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
+ *                 Must not be NULL.
  * @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.
+ *              it may be filled in later. Can be NULL.
  *
  * @return A pointer to a newly initialized struct sr_serial_dev_inst,
  *         or NULL on error.
@@ -342,16 +308,7 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 {
        struct sr_serial_dev_inst *serial;
 
-       if (!port) {
-               sr_err("Serial port required.");
-               return NULL;
-       }
-
-       if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
-               sr_err("Serial device instance malloc failed.");
-               return NULL;
-       }
-
+       serial = g_malloc0(sizeof(struct sr_serial_dev_inst));
        serial->port = g_strdup(port);
        if (serialcomm)
                serial->serialcomm = g_strdup(serialcomm);
@@ -376,16 +333,7 @@ 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;
-       }
-
-       if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
-               sr_err("USBTMC device instance malloc failed.");
-               return NULL;
-       }
-
+       usbtmc = g_malloc0(sizeof(struct sr_usbtmc_dev_inst));
        usbtmc->device = g_strdup(device);
        usbtmc->fd = -1;
 
@@ -412,7 +360,7 @@ SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
 {
        if (driver && driver->dev_list)
-               return driver->dev_list();
+               return driver->dev_list(driver);
        else
                return NULL;
 }
@@ -438,7 +386,7 @@ SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
        }
 
        if (driver->dev_clear)
-               ret = driver->dev_clear();
+               ret = driver->dev_clear(driver);
        else
                ret = std_dev_clear(driver, NULL);
 
@@ -572,11 +520,10 @@ SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
  */
 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
 {
+#ifdef HAVE_LIBUSB_1_0
        struct drv_context *drvc;
        int r, cnt, i, a, b;
        char connection_id[64];
-
-#ifdef HAVE_LIBUSB_1_0
        struct sr_usb_dev_inst *usb;
        struct libusb_device **devlist;
        struct libusb_device_descriptor des;
@@ -596,12 +543,11 @@ SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
        }
 #endif
 
-
 #ifdef HAVE_LIBUSB_1_0
        if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
                /* connection_id isn't populated, let's do that here. */
 
-               drvc = sdi->driver->priv;
+               drvc = sdi->driver->context;
                usb = sdi->conn;
 
                if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {