sr: split driver init into init() and scan()

[libsigrok.git] / hwdriver.c

diff --git a/hwdriver.c b/hwdriver.c
index 5e9cb02f51fdb64c4e08b08bdde0b286127abbeb..91b0e6d9d0813cdfeb0c3f27889f8660fde301f7 100644 (file)
--- a/hwdriver.c
+++ b/hwdriver.c
@@ -23,8 +23,8 @@
 #include <dirent.h>
 #include <string.h>
 #include <glib.h>
-#include "sigrok.h"
-#include "sigrok-internal.h"
+#include "libsigrok.h"
+#include "libsigrok-internal.h"
 
 /*
  * This enumerates which driver capabilities correspond to user-settable
@@ -32,6 +32,11 @@
  */
 /* TODO: This shouldn't be a global. */
 SR_API struct sr_hwcap_option sr_hwcap_options[] = {
+       /* Driver scanning options. */
+       {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"},
+       /* Device instance options. */
        {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"},
@@ -41,8 +46,10 @@ SR_API struct sr_hwcap_option sr_hwcap_options[] = {
        {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
                        "horiz_triggerpos"},
        {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
-       {SR_HWCAP_TIMEBASE, SR_T_RATIONAL, "Time base", "timebase"},
+       {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
        {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
+       {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
+       {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
        {0, 0, NULL, NULL},
 };
 
@@ -71,7 +78,10 @@ extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 #endif
 #ifdef HAVE_HW_HANTEK_DSO
-extern SR_PRIV struct sr_dev_driver hantek_dso_plugin_info;
+extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
+#endif
+#ifdef HAVE_HW_GENERICDMM
+extern SR_PRIV struct sr_dev_driver genericdmm_driver_info;
 #endif
 
 static struct sr_dev_driver *drivers_list[] = {
@@ -100,7 +110,10 @@ static struct sr_dev_driver *drivers_list[] = {
        &fx2lafw_driver_info,
 #endif
 #ifdef HAVE_HW_HANTEK_DSO
-       &hantek_dso_plugin_info,
+       &hantek_dso_driver_info,
+#endif
+#ifdef HAVE_HW_GENERICDMM
+       &genericdmm_driver_info,
 #endif
        NULL,
 };
@@ -112,47 +125,44 @@ static struct sr_dev_driver *drivers_list[] = {
  */
 SR_API struct sr_dev_driver **sr_driver_list(void)
 {
+
        return drivers_list;
 }
 
 /**
  * Initialize a hardware driver.
  *
- * The specified driver is initialized, and all devices discovered by the
- * driver are instantiated.
- *
  * @param driver The driver to initialize.
  *
- * @return The number of devices found and instantiated by the driver.
+ * @return SR_OK if all went well, or an error code otherwise.
  */
 SR_API int sr_driver_init(struct sr_dev_driver *driver)
 {
-       int num_devs, num_probes, i, j;
-       int num_initialized_devs = 0;
-       struct sr_dev *dev;
-       char **probe_names;
-
-       sr_dbg("initializing %s driver", driver->name);
-       num_devs = driver->init(NULL);
-       for (i = 0; i < num_devs; i++) {
-               num_probes = GPOINTER_TO_INT(
-                               driver->dev_info_get(i, SR_DI_NUM_PROBES));
-               probe_names = (char **)driver->dev_info_get(i,
-                                                       SR_DI_PROBE_NAMES);
-
-               if (!probe_names) {
-                       sr_warn("hwdriver: %s: driver %s does not return a "
-                               "list of probe names", __func__, driver->name);
-                       continue;
-               }
-
-               dev = sr_dev_new(driver, i);
-               for (j = 0; j < num_probes; j++)
-                       sr_dev_probe_add(dev, probe_names[j]);
-               num_initialized_devs++;
-       }
 
-       return num_initialized_devs;
+       if (driver->init)
+               return driver->init();
+
+       return SR_OK;
+}
+
+/**
+ * Tell a hardware driver to scan for devices.
+ *
+ * @param driver The driver.
+ * @param options A list of struct sr_hwopt options to pass to the driver's
+ *             scanner.
+ *
+ * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
+ * This list must be freed by the caller, but without freeing the data
+ * pointed to in the list.
+ */
+SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
+{
+
+       if (driver->scan)
+               return driver->scan(options);
+
+       return NULL;
 }
 
 SR_PRIV void sr_hw_cleanup_all(void)
@@ -226,7 +236,7 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 
        udi->bus = bus;
        udi->address = address;
-       udi->devhdl = hdl; /* TODO: Check if this is NULL? */
+       udi->devhdl = hdl;
 
        return udi;
 }
@@ -274,7 +284,8 @@ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
  */
 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
 {
-       int *hwcaps, i;
+       const int *hwcaps;
+       int i;
 
        if (!driver) {
                sr_err("hwdriver: %s: driver was NULL", __func__);
@@ -302,7 +313,7 @@ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
  * @return A pointer to a struct with information about the parameter, or NULL
  *         if the capability was not found.
  */
-SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
+SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
 {
        int i;