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
  69         /* Device (or channel group) configuration */
  70         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  71                 "Sample rate", NULL},
  72         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  73                 "Pre-trigger capture ratio", NULL},
  74         {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
  75                 "Pattern", NULL},
  76         {SR_CONF_RLE, SR_T_BOOL, "rle",
  77                 "Run length encoding", NULL},
  78         {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
  79                 "Trigger slope", NULL},
  80         {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
  81                 "Averaging", NULL},
  82         {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
  83                 "Number of samples to average over", NULL},
  84         {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
  85                 "Trigger source", NULL},
  86         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  87                 "Horizontal trigger position", NULL},
  88         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  89                 "Buffer size", NULL},
  90         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  91                 "Time base", NULL},
  92         {SR_CONF_FILTER, SR_T_BOOL, "filter",
  93                 "Filter", NULL},
  94         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  95                 "Volts/div", NULL},
  96         {SR_CONF_COUPLING, SR_T_STRING, "coupling",
  97                 "Coupling", NULL},
  98         {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
  99                 "Trigger matches", NULL},
 100         {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
 101                 "Sample interval", NULL},
 102         {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
 103                 "Number of horizontal divisions", NULL},
 104         {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
 105                 "Number of vertical divisions", NULL},
 106         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
 107                 "Sound pressure level frequency weighting", NULL},
 108         {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
 109                 "Sound pressure level time weighting", NULL},
 110         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
 111                 "Sound pressure level measurement range", NULL},
 112         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
 113                 "Hold max", NULL},
 114         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
 115                 "Hold min", NULL},
 116         {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
 117                 "Voltage threshold", NULL },
 118         {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
 119                 "External clock mode", NULL},
 120         {SR_CONF_SWAP, SR_T_BOOL, "swap",
 121                 "Swap channel order", NULL},
 122         {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
 123                 "Center frequency", NULL},
 124         {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
 125                 "Number of logic channels", NULL},
 126         {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
 127                 "Number of analog channels", NULL},
 128         {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
 129                 "Current voltage", NULL},
 130         {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
 131                 "Voltage target", NULL},
 132         {SR_CONF_CURRENT, SR_T_FLOAT, "current",
 133                 "Current current", NULL},
 134         {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
 135                 "Current limit", NULL},
 136         {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
 137                 "Channel enabled", NULL},
 138         {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
 139                 "Channel modes", NULL},
 140         {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
 141                 "Over-voltage protection enabled", NULL},
 142         {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
 143                 "Over-voltage protection active", NULL},
 144         {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
 145                 "Over-voltage protection threshold", NULL},
 146         {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
 147                 "Over-current protection enabled", NULL},
 148         {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
 149                 "Over-current protection active", NULL},
 150         {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
 151                 "Over-current protection threshold", NULL},
 152         {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
 153                 "Clock edge", NULL},
 154         {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
 155                 "Amplitude", NULL},
 156         {SR_CONF_REGULATION, SR_T_STRING, "regulation",
 157                 "Channel regulation", NULL},
 158         {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
 159                 "Over-temperature protection", NULL},
 160         {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
 161                 "Output frequency", NULL},
 162         {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
 163                 "Output frequency target", 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  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 263  *
 264  * @retval NULL The ctx argument was NULL, or there are no supported drivers.
 265  * @retval Other Pointer to the NULL-terminated list of hardware drivers.
 266  *               The user should NOT g_free() this list, sr_exit() will do that.
 267  *
 268  * @since 0.4.0
 269  */
 270 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
 271 {
 272         if (!ctx)
 273                 return NULL;
 274
 275         return ctx->driver_list;
 276 }
 277
 278 /**
 279  * Initialize a hardware driver.
 280  *
 281  * This usually involves memory allocations and variable initializations
 282  * within the driver, but _not_ scanning for attached devices.
 283  * The API call sr_driver_scan() is used for that.
 284  *
 285  * @param ctx A libsigrok context object allocated by a previous call to
 286  *            sr_init(). Must not be NULL.
 287  * @param driver The driver to initialize. This must be a pointer to one of
 288  *               the entries returned by sr_driver_list(). Must not be NULL.
 289  *
 290  * @retval SR_OK Success
 291  * @retval SR_ERR_ARG Invalid parameter(s).
 292  * @retval SR_ERR_BUG Internal errors.
 293  * @retval other Another negative error code upon other errors.
 294  *
 295  * @since 0.2.0
 296  */
 297 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 298 {
 299         int ret;
 300
 301         if (!ctx) {
 302                 sr_err("Invalid libsigrok context, can't initialize.");
 303                 return SR_ERR_ARG;
 304         }
 305
 306         if (!driver) {
 307                 sr_err("Invalid driver, can't initialize.");
 308                 return SR_ERR_ARG;
 309         }
 310
 311         sr_spew("Initializing driver '%s'.", driver->name);
 312         if ((ret = driver->init(driver, ctx)) < 0)
 313                 sr_err("Failed to initialize the driver: %d.", ret);
 314
 315         return ret;
 316 }
 317
 318 static int check_options(struct sr_dev_driver *driver, GSList *options,
 319                 uint32_t optlist_key, struct sr_dev_inst *sdi,
 320                 struct sr_channel_group *cg)
 321 {
 322         struct sr_config *src;
 323         const struct sr_config_info *srci;
 324         GVariant *gvar_opts;
 325         GSList *l;
 326         const uint32_t *opts;
 327         gsize num_opts, i;
 328         int ret;
 329
 330         if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
 331                 /* Driver publishes no options for this optlist. */
 332                 return SR_ERR;
 333         }
 334
 335         ret = SR_OK;
 336         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 337         for (l = options; l; l = l->next) {
 338                 src = l->data;
 339                 for (i = 0; i < num_opts; i++) {
 340                         if (opts[i] == src->key)
 341                                 break;
 342                 }
 343                 if (i == num_opts) {
 344                         if (!(srci = sr_config_info_get(src->key)))
 345                                 /* Shouldn't happen. */
 346                                 sr_err("Invalid option %d.", src->key);
 347                         else
 348                                 sr_err("Invalid option '%s'.", srci->id);
 349                         ret = SR_ERR_ARG;
 350                         break;
 351                 }
 352                 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
 353                         ret = SR_ERR_ARG;
 354                         break;
 355                 }
 356         }
 357         g_variant_unref(gvar_opts);
 358
 359         return ret;
 360 }
 361
 362 /**
 363  * Tell a hardware driver to scan for devices.
 364  *
 365  * In addition to the detection, the devices that are found are also
 366  * initialized automatically. On some devices, this involves a firmware upload,
 367  * or other such measures.
 368  *
 369  * The order in which the system is scanned for devices is not specified. The
 370  * caller should not assume or rely on any specific order.
 371  *
 372  * Before calling sr_driver_scan(), the user must have previously initialized
 373  * the driver by calling sr_driver_init().
 374  *
 375  * @param driver The driver that should scan. This must be a pointer to one of
 376  *               the entries returned by sr_driver_list(). Must not be NULL.
 377  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 378  *                scanner. Can be NULL/empty.
 379  *
 380  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 381  *         found (or errors were encountered). This list must be freed by the
 382  *         caller using g_slist_free(), but without freeing the data pointed
 383  *         to in the list.
 384  *
 385  * @since 0.2.0
 386  */
 387 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 388 {
 389         GSList *l;
 390
 391         if (!driver) {
 392                 sr_err("Invalid driver, can't scan for devices.");
 393                 return NULL;
 394         }
 395
 396         if (!driver->priv) {
 397                 sr_err("Driver not initialized, can't scan for devices.");
 398                 return NULL;
 399         }
 400
 401         if (options) {
 402                 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
 403                         return NULL;
 404         }
 405
 406         l = driver->scan(driver, options);
 407
 408         sr_spew("Scan of '%s' found %d devices.", driver->name,
 409                 g_slist_length(l));
 410
 411         return l;
 412 }
 413
 414 /**
 415  * Call driver cleanup function for all drivers.
 416  *
 417  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 418  *
 419  * @private
 420  */
 421 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
 422 {
 423         int i;
 424         struct sr_dev_driver **drivers;
 425
 426         if (!ctx)
 427                 return;
 428
 429         drivers = sr_driver_list(ctx);
 430         for (i = 0; drivers[i]; i++) {
 431                 if (drivers[i]->cleanup)
 432                         drivers[i]->cleanup(drivers[i]);
 433                 drivers[i]->priv = NULL;
 434         }
 435 }
 436
 437 /** Allocate struct sr_config.
 438  *  A floating reference can be passed in for data.
 439  *  @private
 440  */
 441 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 442 {
 443         struct sr_config *src;
 444
 445         src = g_malloc0(sizeof(struct sr_config));
 446         src->key = key;
 447         src->data = g_variant_ref_sink(data);
 448
 449         return src;
 450 }
 451
 452 /** Free struct sr_config.
 453  *  @private
 454  */
 455 SR_PRIV void sr_config_free(struct sr_config *src)
 456 {
 457
 458         if (!src || !src->data) {
 459                 sr_err("%s: invalid data!", __func__);
 460                 return;
 461         }
 462
 463         g_variant_unref(src->data);
 464         g_free(src);
 465
 466 }
 467
 468 static void log_key(const struct sr_dev_inst *sdi,
 469         const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
 470 {
 471         const char *opstr;
 472         const struct sr_config_info *srci;
 473
 474         /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
 475         if (key == SR_CONF_DEVICE_OPTIONS)
 476                 return;
 477
 478         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 479         srci = sr_config_info_get(key);
 480
 481         sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
 482                 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
 483                 data ? g_variant_print(data, TRUE) : "NULL");
 484 }
 485
 486 static int check_key(const struct sr_dev_driver *driver,
 487                 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
 488                 uint32_t key, int op, GVariant *data)
 489 {
 490         const struct sr_config_info *srci;
 491         gsize num_opts, i;
 492         GVariant *gvar_opts;
 493         const uint32_t *opts;
 494         uint32_t pub_opt;
 495         char *suffix, *opstr;
 496
 497         if (sdi && cg)
 498                 suffix = " for this device and channel group";
 499         else if (sdi)
 500                 suffix = " for this device";
 501         else
 502                 suffix = "";
 503
 504         if (!(srci = sr_config_info_get(key))) {
 505                 sr_err("Invalid key %d.", key);
 506                 return SR_ERR_ARG;
 507         }
 508         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 509
 510         switch (key) {
 511         case SR_CONF_LIMIT_MSEC:
 512         case SR_CONF_LIMIT_SAMPLES:
 513         case SR_CONF_SAMPLERATE:
 514                 /* Setting any of these to 0 is not useful. */
 515                 if (op != SR_CONF_SET || !data)
 516                         break;
 517                 if (g_variant_get_uint64(data) == 0) {
 518                         sr_err("Cannot set '%s' to 0.", srci->id);
 519                         return SR_ERR_ARG;
 520                 }
 521                 break;
 522         }
 523
 524         if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
 525                 /* Driver publishes no options. */
 526                 sr_err("No options available%s.", srci->id, suffix);
 527                 return SR_ERR_ARG;
 528         }
 529         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 530         pub_opt = 0;
 531         for (i = 0; i < num_opts; i++) {
 532                 if ((opts[i] & SR_CONF_MASK) == key) {
 533                         pub_opt = opts[i];
 534                         break;
 535                 }
 536         }
 537         g_variant_unref(gvar_opts);
 538         if (!pub_opt) {
 539                 sr_err("Option '%s' not available%s.", srci->id, suffix);
 540                 return SR_ERR_ARG;
 541         }
 542
 543         if (!(pub_opt & op)) {
 544                 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
 545                 return SR_ERR_ARG;
 546         }
 547
 548         return SR_OK;
 549 }
 550
 551 /**
 552  * Query value of a configuration key at the given driver or device instance.
 553  *
 554  * @param[in] driver The sr_dev_driver struct to query.
 555  * @param[in] sdi (optional) If the key is specific to a device, this must
 556  *            contain a pointer to the struct sr_dev_inst to be checked.
 557  *            Otherwise it must be NULL.
 558  * @param[in] cg The channel group on the device for which to list the
 559  *                    values, or NULL.
 560  * @param[in] key The configuration key (SR_CONF_*).
 561  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 562  *             Must not be NULL. The caller is given ownership of the GVariant
 563  *             and must thus decrease the refcount after use. However if
 564  *             this function returns an error code, the field should be
 565  *             considered unused, and should not be unreferenced.
 566  *
 567  * @retval SR_OK Success.
 568  * @retval SR_ERR Error.
 569  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 570  *          interpreted as an error by the caller; merely as an indication
 571  *          that it's not applicable.
 572  *
 573  * @since 0.3.0
 574  */
 575 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 576                 const struct sr_dev_inst *sdi,
 577                 const struct sr_channel_group *cg,
 578                 uint32_t key, GVariant **data)
 579 {
 580         int ret;
 581
 582         if (!driver || !data)
 583                 return SR_ERR;
 584
 585         if (!driver->config_get)
 586                 return SR_ERR_ARG;
 587
 588         if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
 589                 return SR_ERR_ARG;
 590
 591         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 592                 log_key(sdi, cg, key, SR_CONF_GET, *data);
 593                 /* Got a floating reference from the driver. Sink it here,
 594                  * caller will need to unref when done with it. */
 595                 g_variant_ref_sink(*data);
 596         }
 597
 598         return ret;
 599 }
 600
 601 /**
 602  * Set value of a configuration key in a device instance.
 603  *
 604  * @param[in] sdi The device instance.
 605  * @param[in] cg The channel group on the device for which to list the
 606  *                    values, or NULL.
 607  * @param[in] key The configuration key (SR_CONF_*).
 608  * @param data The new value for the key, as a GVariant with GVariantType
 609  *        appropriate to that key. A floating reference can be passed
 610  *        in; its refcount will be sunk and unreferenced after use.
 611  *
 612  * @retval SR_OK Success.
 613  * @retval SR_ERR Error.
 614  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 615  *          interpreted as an error by the caller; merely as an indication
 616  *          that it's not applicable.
 617  *
 618  * @since 0.3.0
 619  */
 620 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 621                 const struct sr_channel_group *cg,
 622                 uint32_t key, GVariant *data)
 623 {
 624         int ret;
 625
 626         g_variant_ref_sink(data);
 627
 628         if (!sdi || !sdi->driver || !data)
 629                 ret = SR_ERR;
 630         else if (!sdi->driver->config_set)
 631                 ret = SR_ERR_ARG;
 632         else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
 633                 return SR_ERR_ARG;
 634         else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
 635                 log_key(sdi, cg, key, SR_CONF_SET, data);
 636                 ret = sdi->driver->config_set(key, data, sdi, cg);
 637         }
 638
 639         g_variant_unref(data);
 640
 641         return ret;
 642 }
 643
 644 /**
 645  * Apply configuration settings to the device hardware.
 646  *
 647  * @param sdi The device instance.
 648  *
 649  * @return SR_OK upon success or SR_ERR in case of error.
 650  *
 651  * @since 0.3.0
 652  */
 653 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 654 {
 655         int ret;
 656
 657         if (!sdi || !sdi->driver)
 658                 ret = SR_ERR;
 659         else if (!sdi->driver->config_commit)
 660                 ret = SR_OK;
 661         else
 662                 ret = sdi->driver->config_commit(sdi);
 663
 664         return ret;
 665 }
 666
 667 /**
 668  * List all possible values for a configuration key.
 669  *
 670  * @param[in] driver The sr_dev_driver struct to query.
 671  * @param[in] sdi (optional) If the key is specific to a device, this must
 672  *            contain a pointer to the struct sr_dev_inst to be checked.
 673  * @param[in] cg The channel group on the device for which to list the
 674  *                    values, or NULL.
 675  * @param[in] key The configuration key (SR_CONF_*).
 676  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 677  *             The caller is given ownership of the GVariant and must thus
 678  *             unref the GVariant after use. However if this function
 679  *             returns an error code, the field should be considered
 680  *             unused, and should not be unreferenced.
 681  *
 682  * @retval SR_OK Success.
 683  * @retval SR_ERR Error.
 684  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 685  *          interpreted as an error by the caller; merely as an indication
 686  *          that it's not applicable.
 687  *
 688  * @since 0.3.0
 689  */
 690 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 691                 const struct sr_dev_inst *sdi,
 692                 const struct sr_channel_group *cg,
 693                 uint32_t key, GVariant **data)
 694 {
 695         int ret;
 696
 697         if (!driver || !data)
 698                 return SR_ERR;
 699         else if (!driver->config_list)
 700                 return SR_ERR_ARG;
 701         else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
 702                 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
 703                         return SR_ERR_ARG;
 704         }
 705         if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
 706                 log_key(sdi, cg, key, SR_CONF_LIST, *data);
 707                 g_variant_ref_sink(*data);
 708         }
 709
 710         return ret;
 711 }
 712
 713 /**
 714  * Get information about a configuration key, by key.
 715  *
 716  * @param[in] key The configuration key.
 717  *
 718  * @return A pointer to a struct sr_config_info, or NULL if the key
 719  *         was not found.
 720  *
 721  * @since 0.2.0
 722  */
 723 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key)
 724 {
 725         int i;
 726
 727         for (i = 0; sr_config_info_data[i].key; i++) {
 728                 if (sr_config_info_data[i].key == key)
 729                         return &sr_config_info_data[i];
 730         }
 731
 732         return NULL;
 733 }
 734
 735 /**
 736  * Get information about a configuration key, by name.
 737  *
 738  * @param[in] optname The configuration key.
 739  *
 740  * @return A pointer to a struct sr_config_info, or NULL if the key
 741  *         was not found.
 742  *
 743  * @since 0.2.0
 744  */
 745 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 746 {
 747         int i;
 748
 749         for (i = 0; sr_config_info_data[i].key; i++) {
 750                 if (!sr_config_info_data[i].id)
 751                         continue;
 752                 if (!strcmp(sr_config_info_data[i].id, optname))
 753                         return &sr_config_info_data[i];
 754         }
 755
 756         return NULL;
 757 }
 758
 759 /** @} */