]> sigrok.org Git - libsigrok.git/blobdiff - src/hwdriver.c
Fix log varargs bugs indicated by -Wformat
[libsigrok.git] / src / hwdriver.c
index 26ecbe1a538e92343e84885e4c926c8a26594995..0700276cb84db77f39ebdd0ee6e88ca5be9d89c7 100644 (file)
@@ -24,7 +24,7 @@
 #include <string.h>
 #include <glib.h>
 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
-#include "libsigrok.h"
+#include <libsigrok/libsigrok.h>
 #include "libsigrok-internal.h"
 
 /** @cond PRIVATE */
@@ -45,8 +45,8 @@
  * @{
  */
 
-/* Same key order/grouping as in enum sr_configkey (libsigrok.h). */
-static struct sr_config_info sr_config_info_data[] = {
+/* Please use the same order/grouping as in enum sr_configkey (libsigrok.h). */
+static struct sr_key_info sr_key_info_config[] = {
        /* Device classes */
        {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL},
        {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
@@ -59,6 +59,8 @@ static struct sr_config_info sr_config_info_data[] = {
        {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL},
        {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
        {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
+       {SR_CONF_ELECTRONIC_LOAD, SR_T_STRING, NULL, "Electronic load", NULL},
+       {SR_CONF_SCALE, SR_T_STRING, NULL, "Scale", NULL},
 
        /* Driver scan options */
        {SR_CONF_CONN, SR_T_STRING, "conn",
@@ -163,7 +165,7 @@ static struct sr_config_info sr_config_info_data[] = {
                "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",
+       {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
                "Measured quantity", NULL},
        {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
                "Measured secondary quantity", NULL},
@@ -209,6 +211,77 @@ static struct sr_config_info sr_config_info_data[] = {
        {0, 0, NULL, NULL, NULL},
 };
 
+/* Please use the same order as in enum sr_mq (libsigrok.h). */
+static struct sr_key_info sr_key_info_mq[] = {
+       {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL},
+       {SR_MQ_CURRENT, 0, "current", "Current", NULL},
+       {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL},
+       {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL},
+       {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL},
+       {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL},
+       {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL},
+       {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL},
+       {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL},
+       {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL},
+       {SR_MQ_POWER, 0, "power", "Power", NULL},
+       {SR_MQ_GAIN, 0, "gain", "Gain", NULL},
+       {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL},
+       {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL},
+       {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL},
+       {SR_MQ_TIME, 0, "time", "Time", NULL},
+       {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL},
+       {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL},
+       {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL},
+       {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL},
+       {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL},
+       {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL},
+       {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL},
+       {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL},
+       {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL},
+       {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL},
+       {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL},
+       {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL},
+       {SR_MQ_COUNT, 0, "count", "Count", NULL},
+       {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
+       {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
+       {SR_MQ_MASS, 0, "mass", "Mass", NULL},
+       ALL_ZERO
+};
+
+/* Please use the same order as in enum sr_mqflag (libsigrok.h). */
+static struct sr_key_info sr_key_info_mqflag[] = {
+       {SR_MQFLAG_AC, 0, "ac", "AC", NULL},
+       {SR_MQFLAG_DC, 0, "dc", "DC", NULL},
+       {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL},
+       {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL},
+       {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL},
+       {SR_MQFLAG_MAX, 0, "max", "Max", NULL},
+       {SR_MQFLAG_MIN, 0, "min", "Min", NULL},
+       {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL},
+       {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL},
+       {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a",
+               "Frequency weighted (A)", NULL},
+       {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c",
+               "Frequency weighted (C)", NULL},
+       {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z",
+               "Frequency weighted (Z)", NULL},
+       {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat",
+               "Frequency weighted (flat)", NULL},
+       {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s",
+               "Time weighted (S)", NULL},
+       {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f",
+               "Time weighted (F)", NULL},
+       {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL},
+       {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm",
+               "Percentage over alarm", NULL},
+       {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL},
+       {SR_MQFLAG_AVG, 0, "average", "Average", NULL},
+       {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
+       {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
+       ALL_ZERO
+};
+
+/* This must handle all the keys from enum sr_datatype (libsigrok.h). */
 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 {
        switch (datatype) {
@@ -229,6 +302,8 @@ SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
                return G_VARIANT_TYPE_TUPLE;
        case SR_T_KEYVALUE:
                return G_VARIANT_TYPE_DICTIONARY;
+       case SR_T_MQ:
+               return G_VARIANT_TYPE_TUPLE;
        default:
                return NULL;
        }
@@ -236,11 +311,11 @@ SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 
 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 {
-       const struct sr_config_info *info;
+       const struct sr_key_info *info;
        const GVariantType *type, *expected;
        char *expected_string, *type_string;
 
-       info = sr_config_info_get(key);
+       info = sr_key_info_get(SR_KEY_CONFIG, key);
        if (!info)
                return SR_OK;
 
@@ -324,7 +399,7 @@ static int check_options(struct sr_dev_driver *driver, GSList *options,
                struct sr_channel_group *cg)
 {
        struct sr_config *src;
-       const struct sr_config_info *srci;
+       const struct sr_key_info *srci;
        GVariant *gvar_opts;
        GSList *l;
        const uint32_t *opts;
@@ -345,7 +420,7 @@ static int check_options(struct sr_dev_driver *driver, GSList *options,
                                break;
                }
                if (i == num_opts) {
-                       if (!(srci = sr_config_info_get(src->key)))
+                       if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
                                /* Shouldn't happen. */
                                sr_err("Invalid option %d.", src->key);
                        else
@@ -397,7 +472,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;
        }
@@ -434,7 +509,7 @@ SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
        for (i = 0; drivers[i]; i++) {
                if (drivers[i]->cleanup)
                        drivers[i]->cleanup(drivers[i]);
-               drivers[i]->priv = NULL;
+               drivers[i]->context = NULL;
        }
 }
 
@@ -473,14 +548,14 @@ 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;
+       const struct sr_key_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);
+       srci = sr_key_info_get(SR_KEY_CONFIG, 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",
@@ -491,7 +566,7 @@ 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, GVariant *data)
 {
-       const struct sr_config_info *srci;
+       const struct sr_key_info *srci;
        gsize num_opts, i;
        GVariant *gvar_opts;
        const uint32_t *opts;
@@ -505,7 +580,7 @@ static int check_key(const struct sr_dev_driver *driver,
        else
                suffix = "";
 
-       if (!(srci = sr_config_info_get(key))) {
+       if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) {
                sr_err("Invalid key %d.", key);
                return SR_ERR_ARG;
        }
@@ -527,7 +602,7 @@ static int check_key(const struct sr_dev_driver *driver,
 
        if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
                /* Driver publishes no options. */
-               sr_err("No options available%s.", srci->id, suffix);
+               sr_err("No options available%s.", suffix);
                return SR_ERR_ARG;
        }
        opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
@@ -714,47 +789,79 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver,
        return ret;
 }
 
+static struct sr_key_info *get_keytable(int keytype)
+{
+       struct sr_key_info *table;
+
+       switch (keytype) {
+       case SR_KEY_CONFIG:
+               table = sr_key_info_config;
+               break;
+       case SR_KEY_MQ:
+               table = sr_key_info_mq;
+               break;
+       case SR_KEY_MQFLAGS:
+               table = sr_key_info_mqflag;
+               break;
+       default:
+               sr_err("Invalid keytype %d", keytype);
+               return NULL;
+       }
+
+       return table;
+}
+
 /**
- * Get information about a configuration key, by key.
+ * Get information about a key, by key.
  *
- * @param[in] key The configuration key.
+ * @param[in] keytype The namespace the key is in.
+ * @param[in] key The key to find.
  *
- * @return A pointer to a struct sr_config_info, or NULL if the key
+ * @return A pointer to a struct sr_key_info, or NULL if the key
  *         was not found.
  *
- * @since 0.2.0
+ * @since 0.3.0
  */
-SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
+SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key)
 {
+       struct sr_key_info *table;
        int i;
 
-       for (i = 0; sr_config_info_data[i].key; i++) {
-               if (sr_config_info_data[i].key == key)
-                       return &sr_config_info_data[i];
+       if (!(table = get_keytable(keytype)))
+               return NULL;
+
+       for (i = 0; table[i].key; i++) {
+               if (table[i].key == key)
+                       return &table[i];
        }
 
        return NULL;
 }
 
 /**
- * Get information about a configuration key, by name.
+ * Get information about a key, by name.
  *
- * @param[in] optname The configuration key.
+ * @param[in] keytype The namespace the key is in.
+ * @param[in] keyid The key id string.
  *
- * @return A pointer to a struct sr_config_info, or NULL if the key
+ * @return A pointer to a struct sr_key_info, or NULL if the key
  *         was not found.
  *
  * @since 0.2.0
  */
-SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
+SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid)
 {
+       struct sr_key_info *table;
        int i;
 
-       for (i = 0; sr_config_info_data[i].key; i++) {
-               if (!sr_config_info_data[i].id)
+       if (!(table = get_keytable(keytype)))
+               return NULL;
+
+       for (i = 0; table[i].key; i++) {
+               if (!table[i].id)
                        continue;
-               if (!strcmp(sr_config_info_data[i].id, optname))
-                       return &sr_config_info_data[i];
+               if (!strcmp(table[i].id, keyid))
+                       return &table[i];
        }
 
        return NULL;