Doxygen: Initial groups and topic short descriptions.

[libsigrok.git] / device.c

diff --git a/device.c b/device.c
index e9f6c7bcdd661a644221acbd07e5b43804b56365..d305710c1bc1f98c1655d1f4fb8fbba774aa294e 100644 (file)
--- a/device.c
+++ b/device.c
@@ -22,6 +22,15 @@
 #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)
 {
@@ -184,6 +193,7 @@ 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)
 {
@@ -207,17 +217,29 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
        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)
 {
@@ -235,6 +257,7 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
        return udi;
 }
 
+/** @private */
 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 {
        /* Avoid compiler warnings. */
@@ -245,6 +268,7 @@ SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 
 #endif
 
+/** @private */
 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
                                                          int fd)
 {
@@ -261,8 +285,43 @@ SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
        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;
+}
+
+/** @} */