]> sigrok.org Git - libsigrok.git/blobdiff - src/hwdriver.c
Fix #442 by renaming sr_dev_driver.priv to .context
[libsigrok.git] / src / hwdriver.c
index 95d8163f09d00e6627a3d07bb089bb8d12655a97..74d75e6a1e5bdad58909aabb93e207b8f68d7f1e 100644 (file)
@@ -31,8 +31,6 @@
 #define LOG_PREFIX "hwdriver"
 /** @endcond */
 
-extern SR_PRIV struct sr_dev_driver *drivers_list[];
-
 /**
  * @file
  *
@@ -67,6 +65,8 @@ static struct sr_config_info sr_config_info_data[] = {
                "Connection", NULL},
        {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
                "Serial communication", NULL},
+       {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
+               "Modbus slave address", NULL},
 
        /* Device (or channel group) configuration */
        {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
@@ -79,6 +79,10 @@ static struct sr_config_info sr_config_info_data[] = {
                "Run length encoding", NULL},
        {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
                "Trigger slope", NULL},
+       {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
+               "Averaging", NULL},
+       {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
+               "Number of samples to average over", NULL},
        {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
                "Trigger source", NULL},
        {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
@@ -97,8 +101,8 @@ static struct sr_config_info sr_config_info_data[] = {
                "Trigger matches", NULL},
        {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
                "Sample interval", NULL},
-       {SR_CONF_NUM_TIMEBASE, SR_T_INT32, "num_timebase",
-               "Number of time bases", NULL},
+       {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
+               "Number of horizontal divisions", NULL},
        {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
                "Number of vertical divisions", NULL},
        {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
@@ -123,18 +127,18 @@ static struct sr_config_info sr_config_info_data[] = {
                "Number of logic channels", NULL},
        {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
                "Number of analog channels", NULL},
-       {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
-               "Current output voltage", NULL},
-       {SR_CONF_OUTPUT_VOLTAGE_TARGET, SR_T_FLOAT, "output_voltage_target",
-               "Output voltage target", NULL},
-       {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
-               "Current output current", NULL},
-       {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit",
-               "Output current limit", NULL},
-       {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
-               "Output enabled", NULL},
-       {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config",
-               "Output channel modes", NULL},
+       {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
+               "Current voltage", NULL},
+       {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
+               "Voltage target", NULL},
+       {SR_CONF_CURRENT, SR_T_FLOAT, "current",
+               "Current current", NULL},
+       {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
+               "Current limit", NULL},
+       {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
+               "Channel enabled", NULL},
+       {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
+               "Channel modes", NULL},
        {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
                "Over-voltage protection enabled", NULL},
        {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
@@ -151,18 +155,22 @@ static struct sr_config_info sr_config_info_data[] = {
                "Clock edge", NULL},
        {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
                "Amplitude", NULL},
-       {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation",
-               "Output channel regulation", NULL},
+       {SR_CONF_REGULATION, SR_T_STRING, "regulation",
+               "Channel regulation", NULL},
        {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
                "Over-temperature protection", NULL},
-       {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency",
+       {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
                "Output frequency", NULL},
+       {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
+               "Output frequency target", NULL},
        {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
                "Measured quantity", NULL},
        {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
                "Measured secondary quantity", NULL},
        {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
                "Equivalent circuit model", NULL},
+       {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
+               "Over-temperature protection active", NULL},
 
        /* Special stuff */
        {SR_CONF_SCAN_OPTIONS, SR_T_STRING, "scan_options",
@@ -179,6 +187,8 @@ static struct sr_config_info sr_config_info_data[] = {
                "Power off", NULL},
        {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
                "Data source", NULL},
+       {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
+               "Probe factor", NULL},
 
        /* Acquisition modes, sample limiting */
        {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
@@ -253,14 +263,20 @@ SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 /**
  * Return the list of supported hardware drivers.
  *
- * @return Pointer to the NULL-terminated list of hardware driver pointers.
+ * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
+ *
+ * @retval NULL The ctx argument was NULL, or there are no supported drivers.
+ * @retval Other Pointer to the NULL-terminated list of hardware drivers.
+ *               The user should NOT g_free() this list, sr_exit() will do that.
  *
- * @since 0.1.0
+ * @since 0.4.0
  */
-SR_API struct sr_dev_driver **sr_driver_list(void)
+SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
 {
+       if (!ctx)
+               return NULL;
 
-       return drivers_list;
+       return ctx->driver_list;
 }
 
 /**
@@ -297,7 +313,7 @@ SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
        }
 
        sr_spew("Initializing driver '%s'.", driver->name);
-       if ((ret = driver->init(ctx)) < 0)
+       if ((ret = driver->init(driver, ctx)) < 0)
                sr_err("Failed to initialize the driver: %d.", ret);
 
        return ret;
@@ -381,7 +397,7 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
                return NULL;
        }
 
-       if (!driver->priv) {
+       if (!driver->context) {
                sr_err("Driver not initialized, can't scan for devices.");
                return NULL;
        }
@@ -391,7 +407,7 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
                        return NULL;
        }
 
-       l = driver->scan(options);
+       l = driver->scan(driver, options);
 
        sr_spew("Scan of '%s' found %d devices.", driver->name,
                g_slist_length(l));
@@ -399,17 +415,26 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
        return l;
 }
 
-/** Call driver cleanup function for all drivers.
- *  @private */
-SR_PRIV void sr_hw_cleanup_all(void)
+/**
+ * Call driver cleanup function for all drivers.
+ *
+ * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
+ *
+ * @private
+ */
+SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
 {
        int i;
        struct sr_dev_driver **drivers;
 
-       drivers = sr_driver_list();
+       if (!ctx)
+               return;
+
+       drivers = sr_driver_list(ctx);
        for (i = 0; drivers[i]; i++) {
                if (drivers[i]->cleanup)
-                       drivers[i]->cleanup();
+                       drivers[i]->cleanup(drivers[i]);
+               drivers[i]->context = NULL;
        }
 }
 
@@ -444,9 +469,27 @@ SR_PRIV void sr_config_free(struct sr_config *src)
 
 }
 
+static void log_key(const struct sr_dev_inst *sdi,
+       const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
+{
+       const char *opstr;
+       const struct sr_config_info *srci;
+
+       /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
+       if (key == SR_CONF_DEVICE_OPTIONS)
+               return;
+
+       opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
+       srci = sr_config_info_get(key);
+
+       sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
+               srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
+               data ? g_variant_print(data, TRUE) : "NULL");
+}
+
 static int check_key(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
-               uint32_t key, int op)
+               uint32_t key, int op, GVariant *data)
 {
        const struct sr_config_info *srci;
        gsize num_opts, i;
@@ -467,8 +510,20 @@ static int check_key(const struct sr_dev_driver *driver,
                return SR_ERR_ARG;
        }
        opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
-       sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s", opstr, key,
-                       srci->id, sdi, cg ? cg->name : "NULL");
+
+       switch (key) {
+       case SR_CONF_LIMIT_MSEC:
+       case SR_CONF_LIMIT_SAMPLES:
+       case SR_CONF_SAMPLERATE:
+               /* Setting any of these to 0 is not useful. */
+               if (op != SR_CONF_SET || !data)
+                       break;
+               if (g_variant_get_uint64(data) == 0) {
+                       sr_err("Cannot set '%s' to 0.", srci->id);
+                       return SR_ERR_ARG;
+               }
+               break;
+       }
 
        if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
                /* Driver publishes no options. */
@@ -534,10 +589,11 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver,
        if (!driver->config_get)
                return SR_ERR_ARG;
 
-       if (check_key(driver, sdi, cg, key, SR_CONF_GET) != SR_OK)
+       if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
                return SR_ERR_ARG;
 
        if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
+               log_key(sdi, cg, key, SR_CONF_GET, *data);
                /* Got a floating reference from the driver. Sink it here,
                 * caller will need to unref when done with it. */
                g_variant_ref_sink(*data);
@@ -577,10 +633,12 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi,
                ret = SR_ERR;
        else if (!sdi->driver->config_set)
                ret = SR_ERR_ARG;
-       else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET) != SR_OK)
+       else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
                return SR_ERR_ARG;
-       else if ((ret = sr_variant_type_check(key, data)) == SR_OK)
+       else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
+               log_key(sdi, cg, key, SR_CONF_SET, data);
                ret = sdi->driver->config_set(key, data, sdi, cg);
+       }
 
        g_variant_unref(data);
 
@@ -645,11 +703,13 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver,
        else if (!driver->config_list)
                return SR_ERR_ARG;
        else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
-               if (check_key(driver, sdi, cg, key, SR_CONF_LIST) != SR_OK)
+               if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
                        return SR_ERR_ARG;
        }
-       if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK)
+       if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
+               log_key(sdi, cg, key, SR_CONF_LIST, *data);
                g_variant_ref_sink(*data);
+       }
 
        return ret;
 }