]> sigrok.org Git - libsigrok.git/blobdiff - hwdriver.c
Add initial README.devices file.
[libsigrok.git] / hwdriver.c
index 9535b053b4b304a5c498754142464ab1336389fc..a5f85b8861bb065145b6943895ca7202ae8f16cb 100644 (file)
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "hwdriver: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
 /**
  * @file
  *
@@ -70,10 +79,15 @@ static struct sr_config_info sr_config_info_data[] = {
                "Volts/div", NULL},
        {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
                "Coupling", NULL},
+       {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
+               "Datalog", NULL},
        {0, 0, NULL, NULL, NULL},
 };
 
 /** @cond PRIVATE */
+#ifdef HAVE_HW_BRYMEN_DMM
+extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
+#endif
 #ifdef HAVE_HW_COLEAD_SLM
 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
 #endif
@@ -83,6 +97,10 @@ extern SR_PRIV struct sr_dev_driver demo_driver_info;
 #ifdef HAVE_HW_LASCAR_EL_USB
 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
 #endif
+#ifdef HAVE_HW_MIC_985XX
+extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
+extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
+#endif
 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
 #endif
@@ -148,6 +166,9 @@ extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 /** @endcond */
 
 static struct sr_dev_driver *drivers_list[] = {
+#ifdef HAVE_HW_BRYMEN_DMM
+       &brymen_bm857_driver_info,
+#endif
 #ifdef HAVE_HW_COLEAD_SLM
        &colead_slm_driver_info,
 #endif
@@ -157,6 +178,10 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_HW_LASCAR_EL_USB
        &lascar_el_usb_driver_info,
 #endif
+#ifdef HAVE_HW_MIC_985XX
+       &mic_98581_driver_info,
+       &mic_98583_driver_info,
+#endif
 #ifdef HAVE_HW_NEXUS_OSCIPRIME
        &nexus_osciprime_driver_info,
 #endif
@@ -236,19 +261,38 @@ SR_API struct sr_dev_driver **sr_driver_list(void)
 /**
  * Initialize a hardware driver.
  *
+ * This usually involves memory allocations and variable initializations
+ * within the driver, but _not_ scanning for attached devices.
+ * The API call sr_driver_scan() is used for that.
+ *
  * @param ctx A libsigrok context object allocated by a previous call to
- *             sr_init().
- * @param driver The driver to initialize.
+ *            sr_init(). Must not be NULL.
+ * @param driver The driver to initialize. This must be a pointer to one of
+ *               the entries returned by sr_driver_list(). Must not be NULL.
  *
- * @return SR_OK if all went well, or an error code otherwise.
+ * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
+ *         SR_ERR_BUG upon internal errors, or another negative error code
+ *         upon other errors.
  */
 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 {
+       int ret;
 
-       if (driver->init)
-               return driver->init(ctx);
+       if (!ctx) {
+               sr_err("Invalid libsigrok context, can't initialize.");
+               return SR_ERR_ARG;
+       }
 
-       return SR_OK;
+       if (!driver) {
+               sr_err("Invalid driver, can't initialize.");
+               return SR_ERR_ARG;
+       }
+
+       sr_spew("Initializing driver '%s'.", driver->name);
+       if ((ret = driver->init(ctx)) < 0)
+               sr_err("Failed to initialize the driver: %d.", ret);
+
+       return ret;
 }
 
 /**
@@ -261,21 +305,39 @@ SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
  * The order in which the system is scanned for devices is not specified. The
  * caller should not assume or rely on any specific order.
  *
- * @param driver The driver.
- * @param options A list of struct sr_hwopt options to pass to the driver's
- *             scanner.
+ * Before calling sr_driver_scan(), the user must have previously initialized
+ * the driver by calling sr_driver_init().
  *
- * @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.
+ * @param driver The driver that should scan. This must be a pointer to one of
+ *               the entries returned by sr_driver_list(). Must not be NULL.
+ * @param options A list of 'struct sr_hwopt' options to pass to the driver's
+ *                scanner. Can be NULL/empty.
+ *
+ * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
+ *         found (or errors were encountered). This list must be freed by the
+ *         caller using g_slist_free(), but without freeing the data pointed
+ *         to in the list.
  */
 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 {
+       GSList *l;
 
-       if (driver->scan)
-               return driver->scan(options);
+       if (!driver) {
+               sr_err("Invalid driver, can't scan for devices.");
+               return NULL;
+       }
 
-       return NULL;
+       if (!driver->priv) {
+               sr_err("Driver not initialized, can't scan for devices.");
+               return NULL;
+       }
+
+       l = driver->scan(options);
+
+       sr_spew("Scan of '%s' found %d devices.", driver->name,
+               g_slist_length(l));
+
+       return l;
 }
 
 /** @private */
@@ -317,7 +379,7 @@ SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
  *         but this is not to be flagged as an error by the caller; merely
  *         as an indication that it's not applicable.
  */
-SR_API int sr_config_get(struct sr_dev_driver *driver, int key,
+SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
                const void **data, const struct sr_dev_inst *sdi)
 {
        int ret;
@@ -325,9 +387,6 @@ SR_API int sr_config_get(struct sr_dev_driver *driver, int key,
        if (!driver || !data)
                return SR_ERR;
 
-       if (!driver->config_get)
-               return SR_ERR_ARG;
-
        ret = driver->config_get(key, data, sdi);
 
        return ret;
@@ -351,7 +410,7 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
 {
        int ret;
 
-       if (!sdi || !sdi->driver)
+       if (!sdi || !sdi->driver || !value)
                return SR_ERR;
 
        if (!sdi->driver->config_set)
@@ -377,7 +436,7 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
  *         but this is not to be flagged as an error by the caller; merely
  *         as an indication that it's not applicable.
  */
-SR_API int sr_config_list(struct sr_dev_driver *driver, int key,
+SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
                const void **data, const struct sr_dev_inst *sdi)
 {
        int ret;
@@ -385,9 +444,6 @@ SR_API int sr_config_list(struct sr_dev_driver *driver, int key,
        if (!driver || !data)
                return SR_ERR;
 
-       if (!driver->config_list)
-               return SR_ERR_ARG;
-
        ret = driver->config_list(key, data, sdi);
 
        return ret;