src/hwdriver.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <stdlib.h>
  21 #include <stdio.h>
  22 #include <sys/types.h>
  23 #include <dirent.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 /** @cond PRIVATE */
  31 #define LOG_PREFIX "hwdriver"
  32 /** @endcond */
  33
  34 extern SR_PRIV struct sr_dev_driver **drivers_lists[];
  35
  36 /**
  37  * @file
  38  *
  39  * Hardware driver handling in libsigrok.
  40  */
  41
  42 /**
  43  * @defgroup grp_driver Hardware drivers
  44  *
  45  * Hardware driver handling in libsigrok.
  46  *
  47  * @{
  48  */
  49
  50 /* Same key order/grouping as in enum sr_configkey (libsigrok.h). */
  51 static struct sr_config_info sr_config_info_data[] = {
  52         /* Device classes */
  53         {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL},
  54         {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
  55         {SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL},
  56         {SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL},
  57         {SR_CONF_SOUNDLEVELMETER, SR_T_STRING, NULL, "Sound level meter", NULL},
  58         {SR_CONF_THERMOMETER, SR_T_STRING, NULL, "Thermometer", NULL},
  59         {SR_CONF_HYGROMETER, SR_T_STRING, NULL, "Hygrometer", NULL},
  60         {SR_CONF_ENERGYMETER, SR_T_STRING, NULL, "Energy meter", NULL},
  61         {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL},
  62         {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
  63         {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
  64
  65         /* Driver scan options */
  66         {SR_CONF_CONN, SR_T_STRING, "conn",
  67                 "Connection", NULL},
  68         {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
  69                 "Serial communication", NULL},
  70
  71         /* Device (or channel group) configuration */
  72         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  73                 "Sample rate", NULL},
  74         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  75                 "Pre-trigger capture ratio", NULL},
  76         {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
  77                 "Pattern", NULL},
  78         {SR_CONF_RLE, SR_T_BOOL, "rle",
  79                 "Run length encoding", NULL},
  80         {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
  81                 "Trigger slope", NULL},
  82         {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
  83                 "Averaging", NULL},
  84         {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
  85                 "Number of samples to average over", NULL},
  86         {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
  87                 "Trigger source", NULL},
  88         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  89                 "Horizontal trigger position", NULL},
  90         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  91                 "Buffer size", NULL},
  92         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  93                 "Time base", NULL},
  94         {SR_CONF_FILTER, SR_T_BOOL, "filter",
  95                 "Filter", NULL},
  96         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  97                 "Volts/div", NULL},
  98         {SR_CONF_COUPLING, SR_T_STRING, "coupling",
  99                 "Coupling", NULL},
 100         {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
 101                 "Trigger matches", NULL},
 102         {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
 103                 "Sample interval", NULL},
 104         {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
 105                 "Number of horizontal divisions", NULL},
 106         {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
 107                 "Number of vertical divisions", NULL},
 108         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
 109                 "Sound pressure level frequency weighting", NULL},
 110         {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
 111                 "Sound pressure level time weighting", NULL},
 112         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
 113                 "Sound pressure level measurement range", NULL},
 114         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
 115                 "Hold max", NULL},
 116         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
 117                 "Hold min", NULL},
 118         {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
 119                 "Voltage threshold", NULL },
 120         {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
 121                 "External clock mode", NULL},
 122         {SR_CONF_SWAP, SR_T_BOOL, "swap",
 123                 "Swap channel order", NULL},
 124         {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
 125                 "Center frequency", NULL},
 126         {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
 127                 "Number of logic channels", NULL},
 128         {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
 129                 "Number of analog channels", NULL},
 130         {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage",
 131                 "Current output voltage", NULL},
 132         {SR_CONF_OUTPUT_VOLTAGE_TARGET, SR_T_FLOAT, "output_voltage_target",
 133                 "Output voltage target", NULL},
 134         {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current",
 135                 "Current output current", NULL},
 136         {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit",
 137                 "Output current limit", NULL},
 138         {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled",
 139                 "Output enabled", NULL},
 140         {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config",
 141                 "Output channel modes", NULL},
 142         {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
 143                 "Over-voltage protection enabled", NULL},
 144         {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
 145                 "Over-voltage protection active", NULL},
 146         {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
 147                 "Over-voltage protection threshold", NULL},
 148         {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
 149                 "Over-current protection enabled", NULL},
 150         {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
 151                 "Over-current protection active", NULL},
 152         {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
 153                 "Over-current protection threshold", NULL},
 154         {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
 155                 "Clock edge", NULL},
 156         {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
 157                 "Amplitude", NULL},
 158         {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation",
 159                 "Output channel regulation", NULL},
 160         {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
 161                 "Over-temperature protection", NULL},
 162         {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency",
 163                 "Output frequency", NULL},
 164         {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
 165                 "Measured quantity", NULL},
 166         {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
 167                 "Measured secondary quantity", NULL},
 168         {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
 169                 "Equivalent circuit model", NULL},
 170
 171         /* Special stuff */
 172         {SR_CONF_SCAN_OPTIONS, SR_T_STRING, "scan_options",
 173                 "Scan options", NULL},
 174         {SR_CONF_DEVICE_OPTIONS, SR_T_STRING, "device_options",
 175                 "Device options", NULL},
 176         {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
 177                 "Session file", NULL},
 178         {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
 179                 "Capture file", NULL},
 180         {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
 181                 "Capture unitsize", NULL},
 182         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
 183                 "Power off", NULL},
 184         {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
 185                 "Data source", NULL},
 186         {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
 187                 "Probe factor", NULL},
 188
 189         /* Acquisition modes, sample limiting */
 190         {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
 191                 "Time limit", NULL},
 192         {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
 193                 "Sample limit", NULL},
 194         {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
 195                 "Frame limit", NULL},
 196         {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
 197                 "Continuous sampling", NULL},
 198         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
 199                 "Datalog", NULL},
 200         {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
 201                 "Device mode", NULL},
 202         {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
 203                 "Test mode", NULL},
 204
 205         {0, 0, NULL, NULL, NULL},
 206 };
 207
 208 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 209 {
 210         switch (datatype) {
 211         case SR_T_INT32:
 212                 return G_VARIANT_TYPE_INT32;
 213         case SR_T_UINT64:
 214                 return G_VARIANT_TYPE_UINT64;
 215         case SR_T_STRING:
 216                 return G_VARIANT_TYPE_STRING;
 217         case SR_T_BOOL:
 218                 return G_VARIANT_TYPE_BOOLEAN;
 219         case SR_T_FLOAT:
 220                 return G_VARIANT_TYPE_DOUBLE;
 221         case SR_T_RATIONAL_PERIOD:
 222         case SR_T_RATIONAL_VOLT:
 223         case SR_T_UINT64_RANGE:
 224         case SR_T_DOUBLE_RANGE:
 225                 return G_VARIANT_TYPE_TUPLE;
 226         case SR_T_KEYVALUE:
 227                 return G_VARIANT_TYPE_DICTIONARY;
 228         default:
 229                 return NULL;
 230         }
 231 }
 232
 233 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 234 {
 235         const struct sr_config_info *info;
 236         const GVariantType *type, *expected;
 237         char *expected_string, *type_string;
 238
 239         info = sr_config_info_get(key);
 240         if (!info)
 241                 return SR_OK;
 242
 243         expected = sr_variant_type_get(info->datatype);
 244         type = g_variant_get_type(value);
 245         if (!g_variant_type_equal(type, expected)
 246                         && !g_variant_type_is_subtype_of(type, expected)) {
 247                 expected_string = g_variant_type_dup_string(expected);
 248                 type_string = g_variant_type_dup_string(type);
 249                 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
 250                         info->name, expected_string, type_string);
 251                 g_free(expected_string);
 252                 g_free(type_string);
 253                 return SR_ERR_ARG;
 254         }
 255
 256         return SR_OK;
 257 }
 258
 259 /**
 260  * Return the list of supported hardware drivers.
 261  *
 262  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 263  *
 264  * @since 0.1.0
 265  */
 266 SR_API struct sr_dev_driver **sr_driver_list(void)
 267 {
 268         static struct sr_dev_driver **combined_list = NULL;
 269         struct sr_dev_driver ***lists, **drivers;
 270         GArray *array;
 271
 272         if (combined_list)
 273                 return combined_list;
 274
 275         array = g_array_new(TRUE, FALSE, sizeof(struct sr_dev_driver *));
 276         for (lists = drivers_lists; *lists; lists++)
 277                 for (drivers = *lists; *drivers; drivers++)
 278                         g_array_append_val(array, *drivers);
 279         combined_list = (struct sr_dev_driver **)array->data;
 280         g_array_free(array, FALSE);
 281
 282         return combined_list;
 283 }
 284
 285 /**
 286  * Initialize a hardware driver.
 287  *
 288  * This usually involves memory allocations and variable initializations
 289  * within the driver, but _not_ scanning for attached devices.
 290  * The API call sr_driver_scan() is used for that.
 291  *
 292  * @param ctx A libsigrok context object allocated by a previous call to
 293  *            sr_init(). Must not be NULL.
 294  * @param driver The driver to initialize. This must be a pointer to one of
 295  *               the entries returned by sr_driver_list(). Must not be NULL.
 296  *
 297  * @retval SR_OK Success
 298  * @retval SR_ERR_ARG Invalid parameter(s).
 299  * @retval SR_ERR_BUG Internal errors.
 300  * @retval other Another negative error code upon other errors.
 301  *
 302  * @since 0.2.0
 303  */
 304 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 305 {
 306         int ret;
 307
 308         if (!ctx) {
 309                 sr_err("Invalid libsigrok context, can't initialize.");
 310                 return SR_ERR_ARG;
 311         }
 312
 313         if (!driver) {
 314                 sr_err("Invalid driver, can't initialize.");
 315                 return SR_ERR_ARG;
 316         }
 317
 318         sr_spew("Initializing driver '%s'.", driver->name);
 319         if ((ret = driver->init(driver, ctx)) < 0)
 320                 sr_err("Failed to initialize the driver: %d.", ret);
 321
 322         return ret;
 323 }
 324
 325 static int check_options(struct sr_dev_driver *driver, GSList *options,
 326                 uint32_t optlist_key, struct sr_dev_inst *sdi,
 327                 struct sr_channel_group *cg)
 328 {
 329         struct sr_config *src;
 330         const struct sr_config_info *srci;
 331         GVariant *gvar_opts;
 332         GSList *l;
 333         const uint32_t *opts;
 334         gsize num_opts, i;
 335         int ret;
 336
 337         if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
 338                 /* Driver publishes no options for this optlist. */
 339                 return SR_ERR;
 340         }
 341
 342         ret = SR_OK;
 343         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 344         for (l = options; l; l = l->next) {
 345                 src = l->data;
 346                 for (i = 0; i < num_opts; i++) {
 347                         if (opts[i] == src->key)
 348                                 break;
 349                 }
 350                 if (i == num_opts) {
 351                         if (!(srci = sr_config_info_get(src->key)))
 352                                 /* Shouldn't happen. */
 353                                 sr_err("Invalid option %d.", src->key);
 354                         else
 355                                 sr_err("Invalid option '%s'.", srci->id);
 356                         ret = SR_ERR_ARG;
 357                         break;
 358                 }
 359                 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
 360                         ret = SR_ERR_ARG;
 361                         break;
 362                 }
 363         }
 364         g_variant_unref(gvar_opts);
 365
 366         return ret;
 367 }
 368
 369 /**
 370  * Tell a hardware driver to scan for devices.
 371  *
 372  * In addition to the detection, the devices that are found are also
 373  * initialized automatically. On some devices, this involves a firmware upload,
 374  * or other such measures.
 375  *
 376  * The order in which the system is scanned for devices is not specified. The
 377  * caller should not assume or rely on any specific order.
 378  *
 379  * Before calling sr_driver_scan(), the user must have previously initialized
 380  * the driver by calling sr_driver_init().
 381  *
 382  * @param driver The driver that should scan. This must be a pointer to one of
 383  *               the entries returned by sr_driver_list(). Must not be NULL.
 384  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 385  *                scanner. Can be NULL/empty.
 386  *
 387  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 388  *         found (or errors were encountered). This list must be freed by the
 389  *         caller using g_slist_free(), but without freeing the data pointed
 390  *         to in the list.
 391  *
 392  * @since 0.2.0
 393  */
 394 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 395 {
 396         GSList *l;
 397
 398         if (!driver) {
 399                 sr_err("Invalid driver, can't scan for devices.");
 400                 return NULL;
 401         }
 402
 403         if (!driver->priv) {
 404                 sr_err("Driver not initialized, can't scan for devices.");
 405                 return NULL;
 406         }
 407
 408         if (options) {
 409                 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
 410                         return NULL;
 411         }
 412
 413         l = driver->scan(driver, options);
 414
 415         sr_spew("Scan of '%s' found %d devices.", driver->name,
 416                 g_slist_length(l));
 417
 418         return l;
 419 }
 420
 421 /** Call driver cleanup function for all drivers.
 422  *  @private */
 423 SR_PRIV void sr_hw_cleanup_all(void)
 424 {
 425         int i;
 426         struct sr_dev_driver **drivers;
 427
 428         drivers = sr_driver_list();
 429         for (i = 0; drivers[i]; i++) {
 430                 if (drivers[i]->cleanup)
 431                         drivers[i]->cleanup(drivers[i]);
 432                 drivers[i]->priv = NULL;
 433         }
 434 }
 435
 436 /** Allocate struct sr_config.
 437  *  A floating reference can be passed in for data.
 438  *  @private
 439  */
 440 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 441 {
 442         struct sr_config *src;
 443
 444         src = g_malloc0(sizeof(struct sr_config));
 445         src->key = key;
 446         src->data = g_variant_ref_sink(data);
 447
 448         return src;
 449 }
 450
 451 /** Free struct sr_config.
 452  *  @private
 453  */
 454 SR_PRIV void sr_config_free(struct sr_config *src)
 455 {
 456
 457         if (!src || !src->data) {
 458                 sr_err("%s: invalid data!", __func__);
 459                 return;
 460         }
 461
 462         g_variant_unref(src->data);
 463         g_free(src);
 464
 465 }
 466
 467 static void log_key(const struct sr_dev_inst *sdi,
 468         const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
 469 {
 470         const char *opstr;
 471         const struct sr_config_info *srci;
 472
 473         /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
 474         if (key == SR_CONF_DEVICE_OPTIONS)
 475                 return;
 476
 477         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 478         srci = sr_config_info_get(key);
 479
 480         sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
 481                 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
 482                 data ? g_variant_print(data, TRUE) : "NULL");
 483 }
 484
 485 static int check_key(const struct sr_dev_driver *driver,
 486                 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
 487                 uint32_t key, int op, GVariant *data)
 488 {
 489         const struct sr_config_info *srci;
 490         gsize num_opts, i;
 491         GVariant *gvar_opts;
 492         const uint32_t *opts;
 493         uint32_t pub_opt;
 494         char *suffix, *opstr;
 495
 496         if (sdi && cg)
 497                 suffix = " for this device and channel group";
 498         else if (sdi)
 499                 suffix = " for this device";
 500         else
 501                 suffix = "";
 502
 503         if (!(srci = sr_config_info_get(key))) {
 504                 sr_err("Invalid key %d.", key);
 505                 return SR_ERR_ARG;
 506         }
 507         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 508
 509         switch (key) {
 510         case SR_CONF_LIMIT_MSEC:
 511         case SR_CONF_LIMIT_SAMPLES:
 512         case SR_CONF_SAMPLERATE:
 513                 /* Setting any of these to 0 is not useful. */
 514                 if (op != SR_CONF_SET || !data)
 515                         break;
 516                 if (g_variant_get_uint64(data) == 0) {
 517                         sr_err("Cannot set '%s' to 0.", srci->id);
 518                         return SR_ERR_ARG;
 519                 }
 520                 break;
 521         }
 522
 523         if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
 524                 /* Driver publishes no options. */
 525                 sr_err("No options available%s.", srci->id, suffix);
 526                 return SR_ERR_ARG;
 527         }
 528         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 529         pub_opt = 0;
 530         for (i = 0; i < num_opts; i++) {
 531                 if ((opts[i] & SR_CONF_MASK) == key) {
 532                         pub_opt = opts[i];
 533                         break;
 534                 }
 535         }
 536         g_variant_unref(gvar_opts);
 537         if (!pub_opt) {
 538                 sr_err("Option '%s' not available%s.", srci->id, suffix);
 539                 return SR_ERR_ARG;
 540         }
 541
 542         if (!(pub_opt & op)) {
 543                 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
 544                 return SR_ERR_ARG;
 545         }
 546
 547         return SR_OK;
 548 }
 549
 550 /**
 551  * Query value of a configuration key at the given driver or device instance.
 552  *
 553  * @param[in] driver The sr_dev_driver struct to query.
 554  * @param[in] sdi (optional) If the key is specific to a device, this must
 555  *            contain a pointer to the struct sr_dev_inst to be checked.
 556  *            Otherwise it must be NULL.
 557  * @param[in] cg The channel group on the device for which to list the
 558  *                    values, or NULL.
 559  * @param[in] key The configuration key (SR_CONF_*).
 560  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 561  *             Must not be NULL. The caller is given ownership of the GVariant
 562  *             and must thus decrease the refcount after use. However if
 563  *             this function returns an error code, the field should be
 564  *             considered unused, and should not be unreferenced.
 565  *
 566  * @retval SR_OK Success.
 567  * @retval SR_ERR Error.
 568  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 569  *          interpreted as an error by the caller; merely as an indication
 570  *          that it's not applicable.
 571  *
 572  * @since 0.3.0
 573  */
 574 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 575                 const struct sr_dev_inst *sdi,
 576                 const struct sr_channel_group *cg,
 577                 uint32_t key, GVariant **data)
 578 {
 579         int ret;
 580
 581         if (!driver || !data)
 582                 return SR_ERR;
 583
 584         if (!driver->config_get)
 585                 return SR_ERR_ARG;
 586
 587         if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
 588                 return SR_ERR_ARG;
 589
 590         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 591                 log_key(sdi, cg, key, SR_CONF_GET, *data);
 592                 /* Got a floating reference from the driver. Sink it here,
 593                  * caller will need to unref when done with it. */
 594                 g_variant_ref_sink(*data);
 595         }
 596
 597         return ret;
 598 }
 599
 600 /**
 601  * Set value of a configuration key in a device instance.
 602  *
 603  * @param[in] sdi The device instance.
 604  * @param[in] cg The channel group on the device for which to list the
 605  *                    values, or NULL.
 606  * @param[in] key The configuration key (SR_CONF_*).
 607  * @param data The new value for the key, as a GVariant with GVariantType
 608  *        appropriate to that key. A floating reference can be passed
 609  *        in; its refcount will be sunk and unreferenced after use.
 610  *
 611  * @retval SR_OK Success.
 612  * @retval SR_ERR Error.
 613  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 614  *          interpreted as an error by the caller; merely as an indication
 615  *          that it's not applicable.
 616  *
 617  * @since 0.3.0
 618  */
 619 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 620                 const struct sr_channel_group *cg,
 621                 uint32_t key, GVariant *data)
 622 {
 623         int ret;
 624
 625         g_variant_ref_sink(data);
 626
 627         if (!sdi || !sdi->driver || !data)
 628                 ret = SR_ERR;
 629         else if (!sdi->driver->config_set)
 630                 ret = SR_ERR_ARG;
 631         else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
 632                 return SR_ERR_ARG;
 633         else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
 634                 log_key(sdi, cg, key, SR_CONF_SET, data);
 635                 ret = sdi->driver->config_set(key, data, sdi, cg);
 636         }
 637
 638         g_variant_unref(data);
 639
 640         return ret;
 641 }
 642
 643 /**
 644  * Apply configuration settings to the device hardware.
 645  *
 646  * @param sdi The device instance.
 647  *
 648  * @return SR_OK upon success or SR_ERR in case of error.
 649  *
 650  * @since 0.3.0
 651  */
 652 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 653 {
 654         int ret;
 655
 656         if (!sdi || !sdi->driver)
 657                 ret = SR_ERR;
 658         else if (!sdi->driver->config_commit)
 659                 ret = SR_OK;
 660         else
 661                 ret = sdi->driver->config_commit(sdi);
 662
 663         return ret;
 664 }
 665
 666 /**
 667  * List all possible values for a configuration key.
 668  *
 669  * @param[in] driver The sr_dev_driver struct to query.
 670  * @param[in] sdi (optional) If the key is specific to a device, this must
 671  *            contain a pointer to the struct sr_dev_inst to be checked.
 672  * @param[in] cg The channel group on the device for which to list the
 673  *                    values, or NULL.
 674  * @param[in] key The configuration key (SR_CONF_*).
 675  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 676  *             The caller is given ownership of the GVariant and must thus
 677  *             unref the GVariant after use. However if this function
 678  *             returns an error code, the field should be considered
 679  *             unused, and should not be unreferenced.
 680  *
 681  * @retval SR_OK Success.
 682  * @retval SR_ERR Error.
 683  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 684  *          interpreted as an error by the caller; merely as an indication
 685  *          that it's not applicable.
 686  *
 687  * @since 0.3.0
 688  */
 689 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 690                 const struct sr_dev_inst *sdi,
 691                 const struct sr_channel_group *cg,
 692                 uint32_t key, GVariant **data)
 693 {
 694         int ret;
 695
 696         if (!driver || !data)
 697                 return SR_ERR;
 698         else if (!driver->config_list)
 699                 return SR_ERR_ARG;
 700         else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
 701                 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
 702                         return SR_ERR_ARG;
 703         }
 704         if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
 705                 log_key(sdi, cg, key, SR_CONF_LIST, *data);
 706                 g_variant_ref_sink(*data);
 707         }
 708
 709         return ret;
 710 }
 711
 712 /**
 713  * Get information about a configuration key, by key.
 714  *
 715  * @param[in] key The configuration key.
 716  *
 717  * @return A pointer to a struct sr_config_info, or NULL if the key
 718  *         was not found.
 719  *
 720  * @since 0.2.0
 721  */
 722 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
 723 {
 724         int i;
 725
 726         for (i = 0; sr_config_info_data[i].key; i++) {
 727                 if (sr_config_info_data[i].key == key)
 728                         return &sr_config_info_data[i];
 729         }
 730
 731         return NULL;
 732 }
 733
 734 /**
 735  * Get information about a configuration key, by name.
 736  *
 737  * @param[in] optname The configuration key.
 738  *
 739  * @return A pointer to a struct sr_config_info, or NULL if the key
 740  *         was not found.
 741  *
 742  * @since 0.2.0
 743  */
 744 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 745 {
 746         int i;
 747
 748         for (i = 0; sr_config_info_data[i].key; i++) {
 749                 if (!sr_config_info_data[i].id)
 750                         continue;
 751                 if (!strcmp(sr_config_info_data[i].id, optname))
 752                         return &sr_config_info_data[i];
 753         }
 754
 755         return NULL;
 756 }
 757
 758 /** @} */