Doxygen: Initial groups and topic short descriptions.

[libsigrok.git] / device.c

diff --git a/device.c b/device.c
index cfa5492f179a7ec5e3f2a14fc2ec997917b47849..d305710c1bc1f98c1655d1f4fb8fbba774aa294e 100644 (file)
--- a/device.c
+++ b/device.c
@@ -22,6 +22,34 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @defgroup grp_devices Devices
+ *
+ * Device handling in libsigrok.
+ *
+ * @{
+ */
+
+/** @private */
+SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
+               gboolean enabled, const char *name)
+{
+       struct sr_probe *probe;
+
+       if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
+               sr_err("hwdriver: probe malloc failed");
+               return NULL;
+       }
+
+       probe->index = index;
+       probe->type = type;
+       probe->enabled = enabled;
+       if (name)
+               probe->name = g_strdup(name);
+
+       return probe;
+}
+
 /**
  * Set the name of the specified probe in the specified device.
  *
@@ -101,11 +129,10 @@ SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
  * be silently replaced.
  *
  * @param sdi Must not be NULL.
- * @param probenum The number of the probe.
- *                 Note that the probe numbers start at 1 (not 0!).
- * @param trigger trigger string, in the format used by sigrok-cli
+ * @param probenum The probe number, starting from 0.
+ * @param trigger Trigger string, in the format used by sigrok-cli
  *
- * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments.
+ * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  */
 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
                const char *trigger)
@@ -142,7 +169,7 @@ SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
  * @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.
+ * @return TRUE if the device has the specified capability, FALSE otherwise.
  *         FALSE is also returned upon invalid input parameters or other
  *         error conditions.
  */
@@ -166,3 +193,135 @@ SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap)
        return FALSE;
 }
 
+/** @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_dev_inst *sdi;
+
+       if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
+               sr_err("hwdriver: %s: sdi malloc failed", __func__);
+               return NULL;
+       }
+
+       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;
+}
+
+/** @private */
+SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
+{
+       struct sr_probe *probe;
+       GSList *l;
+
+       for (l = sdi->probes; l; l = l->next) {
+               probe = l->data;
+               g_free(probe->name);
+               g_free(probe);
+       }
+
+       g_free(sdi->priv);
+       g_free(sdi->vendor);
+       g_free(sdi->model);
+       g_free(sdi->version);
+       g_free(sdi);
+
+}
+
+#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_usb_dev_inst *udi;
+
+       if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
+               sr_err("hwdriver: %s: udi malloc failed", __func__);
+               return NULL;
+       }
+
+       udi->bus = bus;
+       udi->address = address;
+       udi->devhdl = hdl;
+
+       return udi;
+}
+
+/** @private */
+SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
+{
+       /* Avoid compiler warnings. */
+       (void)usb;
+
+       /* Nothing to do for this device instance type. */
+}
+
+#endif
+
+/** @private */
+SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
+                                                         int fd)
+{
+       struct sr_serial_dev_inst *serial;
+
+       if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
+               sr_err("hwdriver: %s: serial malloc failed", __func__);
+               return NULL;
+       }
+
+       serial->port = g_strdup(port);
+       serial->fd = fd;
+
+       return serial;
+}
+
+/** @private */
+SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
+{
+       g_free(serial->port);
+}
+
+SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
+               const void *value)
+{
+       int ret;
+
+       if (!sdi || !sdi->driver || !sdi->driver->dev_config_set) {
+               sr_err("hwdriver: unable to set config option");
+               return SR_ERR;
+       }
+
+       ret = sdi->driver->dev_config_set(sdi, hwcap, value);
+
+       return ret;
+}
+
+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;
+}
+
+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;
+}
+
+/** @} */