config.h usage cleanups.

[libsigrok.git] / hwdriver.c

diff --git a/hwdriver.c b/hwdriver.c
index 118e49a2571159ec5aec56789c12c12d33f84713..ef7f3efeff3a6a53a02753036e7fac3e8d0e92f0 100644 (file)
--- a/hwdriver.c
+++ b/hwdriver.c
@@ -23,12 +23,26 @@
 #include <dirent.h>
 #include <string.h>
 #include <glib.h>
+#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @file
+ *
+ * Hardware driver handling in libsigrok.
+ */
+
+/**
+ * @defgroup grp_driver Hardware drivers
+ *
+ * Hardware driver handling in libsigrok.
+ *
+ * @{
+ */
 
 /* Driver scanning options. */
-SR_API struct sr_hwcap_option sr_drvopts[] = {
+static struct sr_hwcap_option sr_drvopts[] = {
        {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
        {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
        {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
@@ -36,7 +50,7 @@ SR_API struct sr_hwcap_option sr_drvopts[] = {
 };
 
 /* Device instance options. */
-SR_API struct sr_hwcap_option sr_hwcap_options[] = {
+static struct sr_hwcap_option sr_devopts[] = {
        {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
        {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
        {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
@@ -53,6 +67,7 @@ SR_API struct sr_hwcap_option sr_hwcap_options[] = {
        {0, 0, NULL, NULL},
 };
 
+/** @cond PRIVATE */
 #ifdef HAVE_LA_DEMO
 extern SR_PRIV struct sr_dev_driver demo_driver_info;
 #endif
@@ -83,6 +98,16 @@ extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 #ifdef HAVE_HW_GENERICDMM
 extern SR_PRIV struct sr_dev_driver genericdmm_driver_info;
 #endif
+#ifdef HAVE_HW_AGILENT_DMM
+extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
+#endif
+#ifdef HAVE_HW_FLUKE_DMM
+extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
+#endif
+#ifdef HAVE_HW_RADIOSHACK_DMM
+extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info;
+#endif
+/** @endcond */
 
 static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_LA_DEMO
@@ -114,6 +139,15 @@ static struct sr_dev_driver *drivers_list[] = {
 #endif
 #ifdef HAVE_HW_GENERICDMM
        &genericdmm_driver_info,
+#endif
+#ifdef HAVE_HW_AGILENT_DMM
+       &agdmm_driver_info,
+#endif
+#ifdef HAVE_HW_FLUKE_DMM
+       &flukedmm_driver_info,
+#endif
+#ifdef HAVE_HW_RADIOSHACK_DMM
+       &radioshackdmm_driver_info,
 #endif
        NULL,
 };
@@ -172,6 +206,7 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
        return NULL;
 }
 
+/** @private */
 SR_PRIV void sr_hw_cleanup_all(void)
 {
        int i;
@@ -244,17 +279,37 @@ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 /**
  * Get information about a hardware driver option.
  *
- * @param hwopt The option to get.
+ * @param opt The option to get.
  *
- * @return A pointer to a struct with information about the parameter, or NULL
- *         if the option was not found.
+ * @return A pointer to a struct sr_hwcap_option, or NULL if the option
+ *         was not found.
  */
-SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt)
+SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
 {
        int i;
 
        for (i = 0; sr_drvopts[i].hwcap; i++) {
-               if (sr_drvopts[i].hwcap == hwopt)
+               if (sr_drvopts[i].hwcap == opt)
+                       return &sr_drvopts[i];
+       }
+
+       return NULL;
+}
+
+/**
+ * Get information about a hardware driver option, by name.
+ *
+ * @param optname The name of the option to get.
+ *
+ * @return A pointer to a struct sr_hwcap_option, or NULL if the option
+ *         was not found.
+ */
+SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
+{
+       int i;
+
+       for (i = 0; sr_drvopts[i].hwcap; i++) {
+               if (!strcmp(sr_drvopts[i].shortname, optname))
                        return &sr_drvopts[i];
        }
 
@@ -264,18 +319,38 @@ SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt)
 /**
  * Get information about a device option.
  *
- * @param hwcap The capability to get.
+ * @param opt The option to get.
+ *
+ * @return A pointer to a struct sr_hwcap_option, or NULL if the option
+ *         was not found.
+ */
+SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
+{
+       int i;
+
+       for (i = 0; sr_devopts[i].hwcap; i++) {
+               if (sr_devopts[i].hwcap == opt)
+                       return &sr_devopts[i];
+       }
+
+       return NULL;
+}
+
+/**
+ * Get information about a device option, by name.
+ *
+ * @param optname The name of the option to get.
  *
- * @return A pointer to a struct with information about the parameter, or NULL
- *         if the capability was not found.
+ * @return A pointer to a struct sr_hwcap_option, or NULL if the option
+ *         was not found.
  */
-SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
+SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname)
 {
        int i;
 
-       for (i = 0; sr_hwcap_options[i].hwcap; i++) {
-               if (sr_hwcap_options[i].hwcap == hwcap)
-                       return &sr_hwcap_options[i];
+       for (i = 0; sr_devopts[i].hwcap; i++) {
+               if (!strcmp(sr_devopts[i].shortname, optname))
+                       return &sr_devopts[i];
        }
 
        return NULL;
@@ -283,13 +358,17 @@ SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 
 /* Unnecessary level of indirection follows. */
 
+/** @private */
 SR_PRIV int sr_source_remove(int fd)
 {
        return sr_session_source_remove(fd);
 }
 
+/** @private */
 SR_PRIV int sr_source_add(int fd, int events, int timeout,
                          sr_receive_data_callback_t cb, void *cb_data)
 {
        return sr_session_source_add(fd, events, timeout, cb, cb_data);
 }
+
+/** @} */