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 /**
  35  * @file
  36  *
  37  * Hardware driver handling in libsigrok.
  38  */
  39
  40 /**
  41  * @defgroup grp_driver Hardware drivers
  42  *
  43  * Hardware driver handling in libsigrok.
  44  *
  45  * @{
  46  */
  47
  48 /* Same key order/grouping as in enum sr_configkey (libsigrok.h). */
  49 static struct sr_config_info sr_config_info_data[] = {
  50         /* Device classes */
  51         {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL},
  52         {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL},
  53         {SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL},
  54         {SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL},
  55         {SR_CONF_SOUNDLEVELMETER, SR_T_STRING, NULL, "Sound level meter", NULL},
  56         {SR_CONF_THERMOMETER, SR_T_STRING, NULL, "Thermometer", NULL},
  57         {SR_CONF_HYGROMETER, SR_T_STRING, NULL, "Hygrometer", NULL},
  58         {SR_CONF_ENERGYMETER, SR_T_STRING, NULL, "Energy meter", NULL},
  59         {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL},
  60         {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL},
  61         {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL},
  62
  63         /* Driver scan options */
  64         {SR_CONF_CONN, SR_T_STRING, "conn",
  65                 "Connection", NULL},
  66         {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm",
  67                 "Serial communication", NULL},
  68         {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
  69                 "Modbus slave address", 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_VOLTAGE, SR_T_FLOAT, "voltage",
 131                 "Current voltage", NULL},
 132         {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
 133                 "Voltage target", NULL},
 134         {SR_CONF_CURRENT, SR_T_FLOAT, "current",
 135                 "Current current", NULL},
 136         {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
 137                 "Current limit", NULL},
 138         {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
 139                 "Channel enabled", NULL},
 140         {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
 141                 "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_REGULATION, SR_T_STRING, "regulation",
 159                 "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_FLOAT, "output_frequency",
 163                 "Output frequency", NULL},
 164         {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
 165                 "Output frequency target", NULL},
 166         {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity",
 167                 "Measured quantity", NULL},
 168         {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity",
 169                 "Measured secondary quantity", NULL},
 170         {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model",
 171                 "Equivalent circuit model", NULL},
 172         {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active",
 173                 "Over-temperature protection active", NULL},
 174
 175         /* Special stuff */
 176         {SR_CONF_SCAN_OPTIONS, SR_T_STRING, "scan_options",
 177                 "Scan options", NULL},
 178         {SR_CONF_DEVICE_OPTIONS, SR_T_STRING, "device_options",
 179                 "Device options", NULL},
 180         {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile",
 181                 "Session file", NULL},
 182         {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile",
 183                 "Capture file", NULL},
 184         {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize",
 185                 "Capture unitsize", NULL},
 186         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
 187                 "Power off", NULL},
 188         {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source",
 189                 "Data source", NULL},
 190         {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor",
 191                 "Probe factor", NULL},
 192
 193         /* Acquisition modes, sample limiting */
 194         {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
 195                 "Time limit", NULL},
 196         {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
 197                 "Sample limit", NULL},
 198         {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
 199                 "Frame limit", NULL},
 200         {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous",
 201                 "Continuous sampling", NULL},
 202         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
 203                 "Datalog", NULL},
 204         {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
 205                 "Device mode", NULL},
 206         {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
 207                 "Test mode", NULL},
 208
 209         {0, 0, NULL, NULL, NULL},
 210 };
 211
 212 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 213 {
 214         switch (datatype) {
 215         case SR_T_INT32:
 216                 return G_VARIANT_TYPE_INT32;
 217         case SR_T_UINT64:
 218                 return G_VARIANT_TYPE_UINT64;
 219         case SR_T_STRING:
 220                 return G_VARIANT_TYPE_STRING;
 221         case SR_T_BOOL:
 222                 return G_VARIANT_TYPE_BOOLEAN;
 223         case SR_T_FLOAT:
 224                 return G_VARIANT_TYPE_DOUBLE;
 225         case SR_T_RATIONAL_PERIOD:
 226         case SR_T_RATIONAL_VOLT:
 227         case SR_T_UINT64_RANGE:
 228         case SR_T_DOUBLE_RANGE:
 229                 return G_VARIANT_TYPE_TUPLE;
 230         case SR_T_KEYVALUE:
 231                 return G_VARIANT_TYPE_DICTIONARY;
 232         default:
 233                 return NULL;
 234         }
 235 }
 236
 237 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 238 {
 239         const struct sr_config_info *info;
 240         const GVariantType *type, *expected;
 241         char *expected_string, *type_string;
 242
 243         info = sr_config_info_get(key);
 244         if (!info)
 245                 return SR_OK;
 246
 247         expected = sr_variant_type_get(info->datatype);
 248         type = g_variant_get_type(value);
 249         if (!g_variant_type_equal(type, expected)
 250                         && !g_variant_type_is_subtype_of(type, expected)) {
 251                 expected_string = g_variant_type_dup_string(expected);
 252                 type_string = g_variant_type_dup_string(type);
 253                 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
 254                         info->name, expected_string, type_string);
 255                 g_free(expected_string);
 256                 g_free(type_string);
 257                 return SR_ERR_ARG;
 258         }
 259
 260         return SR_OK;
 261 }
 262
 263 /**
 264  * Return the list of supported hardware drivers.
 265  *
 266  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 267  *
 268  * @retval NULL The ctx argument was NULL, or there are no supported drivers.
 269  * @retval Other Pointer to the NULL-terminated list of hardware drivers.
 270  *               The user should NOT g_free() this list, sr_exit() will do that.
 271  *
 272  * @since 0.4.0
 273  */
 274 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
 275 {
 276         if (!ctx)
 277                 return NULL;
 278
 279         return ctx->driver_list;
 280 }
 281
 282 /**
 283  * Initialize a hardware driver.
 284  *
 285  * This usually involves memory allocations and variable initializations
 286  * within the driver, but _not_ scanning for attached devices.
 287  * The API call sr_driver_scan() is used for that.
 288  *
 289  * @param ctx A libsigrok context object allocated by a previous call to
 290  *            sr_init(). Must not be NULL.
 291  * @param driver The driver to initialize. This must be a pointer to one of
 292  *               the entries returned by sr_driver_list(). Must not be NULL.
 293  *
 294  * @retval SR_OK Success
 295  * @retval SR_ERR_ARG Invalid parameter(s).
 296  * @retval SR_ERR_BUG Internal errors.
 297  * @retval other Another negative error code upon other errors.
 298  *
 299  * @since 0.2.0
 300  */
 301 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 302 {
 303         int ret;
 304
 305         if (!ctx) {
 306                 sr_err("Invalid libsigrok context, can't initialize.");
 307                 return SR_ERR_ARG;
 308         }
 309
 310         if (!driver) {
 311                 sr_err("Invalid driver, can't initialize.");
 312                 return SR_ERR_ARG;
 313         }
 314
 315         sr_spew("Initializing driver '%s'.", driver->name);
 316         if ((ret = driver->init(driver, ctx)) < 0)
 317                 sr_err("Failed to initialize the driver: %d.", ret);
 318
 319         return ret;
 320 }
 321
 322 static int check_options(struct sr_dev_driver *driver, GSList *options,
 323                 uint32_t optlist_key, struct sr_dev_inst *sdi,
 324                 struct sr_channel_group *cg)
 325 {
 326         struct sr_config *src;
 327         const struct sr_config_info *srci;
 328         GVariant *gvar_opts;
 329         GSList *l;
 330         const uint32_t *opts;
 331         gsize num_opts, i;
 332         int ret;
 333
 334         if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
 335                 /* Driver publishes no options for this optlist. */
 336                 return SR_ERR;
 337         }
 338
 339         ret = SR_OK;
 340         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 341         for (l = options; l; l = l->next) {
 342                 src = l->data;
 343                 for (i = 0; i < num_opts; i++) {
 344                         if (opts[i] == src->key)
 345                                 break;
 346                 }
 347                 if (i == num_opts) {
 348                         if (!(srci = sr_config_info_get(src->key)))
 349                                 /* Shouldn't happen. */
 350                                 sr_err("Invalid option %d.", src->key);
 351                         else
 352                                 sr_err("Invalid option '%s'.", srci->id);
 353                         ret = SR_ERR_ARG;
 354                         break;
 355                 }
 356                 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
 357                         ret = SR_ERR_ARG;
 358                         break;
 359                 }
 360         }
 361         g_variant_unref(gvar_opts);
 362
 363         return ret;
 364 }
 365
 366 /**
 367  * Tell a hardware driver to scan for devices.
 368  *
 369  * In addition to the detection, the devices that are found are also
 370  * initialized automatically. On some devices, this involves a firmware upload,
 371  * or other such measures.
 372  *
 373  * The order in which the system is scanned for devices is not specified. The
 374  * caller should not assume or rely on any specific order.
 375  *
 376  * Before calling sr_driver_scan(), the user must have previously initialized
 377  * the driver by calling sr_driver_init().
 378  *
 379  * @param driver The driver that should scan. This must be a pointer to one of
 380  *               the entries returned by sr_driver_list(). Must not be NULL.
 381  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 382  *                scanner. Can be NULL/empty.
 383  *
 384  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 385  *         found (or errors were encountered). This list must be freed by the
 386  *         caller using g_slist_free(), but without freeing the data pointed
 387  *         to in the list.
 388  *
 389  * @since 0.2.0
 390  */
 391 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 392 {
 393         GSList *l;
 394
 395         if (!driver) {
 396                 sr_err("Invalid driver, can't scan for devices.");
 397                 return NULL;
 398         }
 399
 400         if (!driver->context) {
 401                 sr_err("Driver not initialized, can't scan for devices.");
 402                 return NULL;
 403         }
 404
 405         if (options) {
 406                 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
 407                         return NULL;
 408         }
 409
 410         l = driver->scan(driver, options);
 411
 412         sr_spew("Scan of '%s' found %d devices.", driver->name,
 413                 g_slist_length(l));
 414
 415         return l;
 416 }
 417
 418 /**
 419  * Call driver cleanup function for all drivers.
 420  *
 421  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 422  *
 423  * @private
 424  */
 425 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
 426 {
 427         int i;
 428         struct sr_dev_driver **drivers;
 429
 430         if (!ctx)
 431                 return;
 432
 433         drivers = sr_driver_list(ctx);
 434         for (i = 0; drivers[i]; i++) {
 435                 if (drivers[i]->cleanup)
 436                         drivers[i]->cleanup(drivers[i]);
 437                 drivers[i]->context = NULL;
 438         }
 439 }
 440
 441 /** Allocate struct sr_config.
 442  *  A floating reference can be passed in for data.
 443  *  @private
 444  */
 445 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 446 {
 447         struct sr_config *src;
 448
 449         src = g_malloc0(sizeof(struct sr_config));
 450         src->key = key;
 451         src->data = g_variant_ref_sink(data);
 452
 453         return src;
 454 }
 455
 456 /** Free struct sr_config.
 457  *  @private
 458  */
 459 SR_PRIV void sr_config_free(struct sr_config *src)
 460 {
 461
 462         if (!src || !src->data) {
 463                 sr_err("%s: invalid data!", __func__);
 464                 return;
 465         }
 466
 467         g_variant_unref(src->data);
 468         g_free(src);
 469
 470 }
 471
 472 static void log_key(const struct sr_dev_inst *sdi,
 473         const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
 474 {
 475         const char *opstr;
 476         const struct sr_config_info *srci;
 477
 478         /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
 479         if (key == SR_CONF_DEVICE_OPTIONS)
 480                 return;
 481
 482         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 483         srci = sr_config_info_get(key);
 484
 485         sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
 486                 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
 487                 data ? g_variant_print(data, TRUE) : "NULL");
 488 }
 489
 490 static int check_key(const struct sr_dev_driver *driver,
 491                 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
 492                 uint32_t key, int op, GVariant *data)
 493 {
 494         const struct sr_config_info *srci;
 495         gsize num_opts, i;
 496         GVariant *gvar_opts;
 497         const uint32_t *opts;
 498         uint32_t pub_opt;
 499         char *suffix, *opstr;
 500
 501         if (sdi && cg)
 502                 suffix = " for this device and channel group";
 503         else if (sdi)
 504                 suffix = " for this device";
 505         else
 506                 suffix = "";
 507
 508         if (!(srci = sr_config_info_get(key))) {
 509                 sr_err("Invalid key %d.", key);
 510                 return SR_ERR_ARG;
 511         }
 512         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 513
 514         switch (key) {
 515         case SR_CONF_LIMIT_MSEC:
 516         case SR_CONF_LIMIT_SAMPLES:
 517         case SR_CONF_SAMPLERATE:
 518                 /* Setting any of these to 0 is not useful. */
 519                 if (op != SR_CONF_SET || !data)
 520                         break;
 521                 if (g_variant_get_uint64(data) == 0) {
 522                         sr_err("Cannot set '%s' to 0.", srci->id);
 523                         return SR_ERR_ARG;
 524                 }
 525                 break;
 526         }
 527
 528         if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
 529                 /* Driver publishes no options. */
 530                 sr_err("No options available%s.", srci->id, suffix);
 531                 return SR_ERR_ARG;
 532         }
 533         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 534         pub_opt = 0;
 535         for (i = 0; i < num_opts; i++) {
 536                 if ((opts[i] & SR_CONF_MASK) == key) {
 537                         pub_opt = opts[i];
 538                         break;
 539                 }
 540         }
 541         g_variant_unref(gvar_opts);
 542         if (!pub_opt) {
 543                 sr_err("Option '%s' not available%s.", srci->id, suffix);
 544                 return SR_ERR_ARG;
 545         }
 546
 547         if (!(pub_opt & op)) {
 548                 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
 549                 return SR_ERR_ARG;
 550         }
 551
 552         return SR_OK;
 553 }
 554
 555 /**
 556  * Query value of a configuration key at the given driver or device instance.
 557  *
 558  * @param[in] driver The sr_dev_driver struct to query.
 559  * @param[in] sdi (optional) If the key is specific to a device, this must
 560  *            contain a pointer to the struct sr_dev_inst to be checked.
 561  *            Otherwise it must be NULL.
 562  * @param[in] cg The channel group on the device for which to list the
 563  *                    values, or NULL.
 564  * @param[in] key The configuration key (SR_CONF_*).
 565  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 566  *             Must not be NULL. The caller is given ownership of the GVariant
 567  *             and must thus decrease the refcount after use. However if
 568  *             this function returns an error code, the field should be
 569  *             considered unused, and should not be unreferenced.
 570  *
 571  * @retval SR_OK Success.
 572  * @retval SR_ERR Error.
 573  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 574  *          interpreted as an error by the caller; merely as an indication
 575  *          that it's not applicable.
 576  *
 577  * @since 0.3.0
 578  */
 579 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 580                 const struct sr_dev_inst *sdi,
 581                 const struct sr_channel_group *cg,
 582                 uint32_t key, GVariant **data)
 583 {
 584         int ret;
 585
 586         if (!driver || !data)
 587                 return SR_ERR;
 588
 589         if (!driver->config_get)
 590                 return SR_ERR_ARG;
 591
 592         if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
 593                 return SR_ERR_ARG;
 594
 595         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 596                 log_key(sdi, cg, key, SR_CONF_GET, *data);
 597                 /* Got a floating reference from the driver. Sink it here,
 598                  * caller will need to unref when done with it. */
 599                 g_variant_ref_sink(*data);
 600         }
 601
 602         return ret;
 603 }
 604
 605 /**
 606  * Set value of a configuration key in a device instance.
 607  *
 608  * @param[in] sdi The device instance.
 609  * @param[in] cg The channel group on the device for which to list the
 610  *                    values, or NULL.
 611  * @param[in] key The configuration key (SR_CONF_*).
 612  * @param data The new value for the key, as a GVariant with GVariantType
 613  *        appropriate to that key. A floating reference can be passed
 614  *        in; its refcount will be sunk and unreferenced after use.
 615  *
 616  * @retval SR_OK Success.
 617  * @retval SR_ERR Error.
 618  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 619  *          interpreted as an error by the caller; merely as an indication
 620  *          that it's not applicable.
 621  *
 622  * @since 0.3.0
 623  */
 624 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 625                 const struct sr_channel_group *cg,
 626                 uint32_t key, GVariant *data)
 627 {
 628         int ret;
 629
 630         g_variant_ref_sink(data);
 631
 632         if (!sdi || !sdi->driver || !data)
 633                 ret = SR_ERR;
 634         else if (!sdi->driver->config_set)
 635                 ret = SR_ERR_ARG;
 636         else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
 637                 return SR_ERR_ARG;
 638         else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
 639                 log_key(sdi, cg, key, SR_CONF_SET, data);
 640                 ret = sdi->driver->config_set(key, data, sdi, cg);
 641         }
 642
 643         g_variant_unref(data);
 644
 645         return ret;
 646 }
 647
 648 /**
 649  * Apply configuration settings to the device hardware.
 650  *
 651  * @param sdi The device instance.
 652  *
 653  * @return SR_OK upon success or SR_ERR in case of error.
 654  *
 655  * @since 0.3.0
 656  */
 657 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 658 {
 659         int ret;
 660
 661         if (!sdi || !sdi->driver)
 662                 ret = SR_ERR;
 663         else if (!sdi->driver->config_commit)
 664                 ret = SR_OK;
 665         else
 666                 ret = sdi->driver->config_commit(sdi);
 667
 668         return ret;
 669 }
 670
 671 /**
 672  * List all possible values for a configuration key.
 673  *
 674  * @param[in] driver The sr_dev_driver struct to query.
 675  * @param[in] sdi (optional) If the key is specific to a device, this must
 676  *            contain a pointer to the struct sr_dev_inst to be checked.
 677  * @param[in] cg The channel group on the device for which to list the
 678  *                    values, or NULL.
 679  * @param[in] key The configuration key (SR_CONF_*).
 680  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 681  *             The caller is given ownership of the GVariant and must thus
 682  *             unref the GVariant after use. However if this function
 683  *             returns an error code, the field should be considered
 684  *             unused, and should not be unreferenced.
 685  *
 686  * @retval SR_OK Success.
 687  * @retval SR_ERR Error.
 688  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 689  *          interpreted as an error by the caller; merely as an indication
 690  *          that it's not applicable.
 691  *
 692  * @since 0.3.0
 693  */
 694 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 695                 const struct sr_dev_inst *sdi,
 696                 const struct sr_channel_group *cg,
 697                 uint32_t key, GVariant **data)
 698 {
 699         int ret;
 700
 701         if (!driver || !data)
 702                 return SR_ERR;
 703         else if (!driver->config_list)
 704                 return SR_ERR_ARG;
 705         else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
 706                 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
 707                         return SR_ERR_ARG;
 708         }
 709         if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
 710                 log_key(sdi, cg, key, SR_CONF_LIST, *data);
 711                 g_variant_ref_sink(*data);
 712         }
 713
 714         return ret;
 715 }
 716
 717 /**
 718  * Get information about a configuration key, by key.
 719  *
 720  * @param[in] key The configuration key.
 721  *
 722  * @return A pointer to a struct sr_config_info, or NULL if the key
 723  *         was not found.
 724  *
 725  * @since 0.2.0
 726  */
 727 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
 728 {
 729         int i;
 730
 731         for (i = 0; sr_config_info_data[i].key; i++) {
 732                 if (sr_config_info_data[i].key == key)
 733                         return &sr_config_info_data[i];
 734         }
 735
 736         return NULL;
 737 }
 738
 739 /**
 740  * Get information about a configuration key, by name.
 741  *
 742  * @param[in] optname The configuration key.
 743  *
 744  * @return A pointer to a struct sr_config_info, or NULL if the key
 745  *         was not found.
 746  *
 747  * @since 0.2.0
 748  */
 749 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 750 {
 751         int i;
 752
 753         for (i = 0; sr_config_info_data[i].key; i++) {
 754                 if (!sr_config_info_data[i].id)
 755                         continue;
 756                 if (!strcmp(sr_config_info_data[i].id, optname))
 757                         return &sr_config_info_data[i];
 758         }
 759
 760         return NULL;
 761 }
 762
 763 /** @} */