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 <config.h>
  21 #include <stdlib.h>
  22 #include <stdio.h>
  23 #include <sys/types.h>
  24 #include <dirent.h>
  25 #include <string.h>
  26 #include <glib.h>
  27 #include <libsigrok/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 /* Please use the same order/grouping as in enum sr_configkey (libsigrok.h). */
  49 static struct sr_key_info sr_key_info_config[] = {
  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         {SR_CONF_ELECTRONIC_LOAD, SR_T_STRING, NULL, "Electronic load", NULL},
  63         {SR_CONF_SCALE, SR_T_STRING, NULL, "Scale", 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         {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr",
  71                 "Modbus slave address", NULL},
  72
  73         /* Device (or channel group) configuration */
  74         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  75                 "Sample rate", NULL},
  76         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  77                 "Pre-trigger capture ratio", NULL},
  78         {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern",
  79                 "Pattern", NULL},
  80         {SR_CONF_RLE, SR_T_BOOL, "rle",
  81                 "Run length encoding", NULL},
  82         {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope",
  83                 "Trigger slope", NULL},
  84         {SR_CONF_AVERAGING, SR_T_BOOL, "averaging",
  85                 "Averaging", NULL},
  86         {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples",
  87                 "Number of samples to average over", NULL},
  88         {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource",
  89                 "Trigger source", NULL},
  90         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  91                 "Horizontal trigger position", NULL},
  92         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  93                 "Buffer size", NULL},
  94         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  95                 "Time base", NULL},
  96         {SR_CONF_FILTER, SR_T_BOOL, "filter",
  97                 "Filter", NULL},
  98         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  99                 "Volts/div", NULL},
 100         {SR_CONF_COUPLING, SR_T_STRING, "coupling",
 101                 "Coupling", NULL},
 102         {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch",
 103                 "Trigger matches", NULL},
 104         {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval",
 105                 "Sample interval", NULL},
 106         {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv",
 107                 "Number of horizontal divisions", NULL},
 108         {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv",
 109                 "Number of vertical divisions", NULL},
 110         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq",
 111                 "Sound pressure level frequency weighting", NULL},
 112         {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time",
 113                 "Sound pressure level time weighting", NULL},
 114         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
 115                 "Sound pressure level measurement range", NULL},
 116         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
 117                 "Hold max", NULL},
 118         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
 119                 "Hold min", NULL},
 120         {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
 121                 "Voltage threshold", NULL },
 122         {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
 123                 "External clock mode", NULL},
 124         {SR_CONF_SWAP, SR_T_BOOL, "swap",
 125                 "Swap channel order", NULL},
 126         {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency",
 127                 "Center frequency", NULL},
 128         {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels",
 129                 "Number of logic channels", NULL},
 130         {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels",
 131                 "Number of analog channels", NULL},
 132         {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage",
 133                 "Current voltage", NULL},
 134         {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target",
 135                 "Voltage target", NULL},
 136         {SR_CONF_CURRENT, SR_T_FLOAT, "current",
 137                 "Current current", NULL},
 138         {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit",
 139                 "Current limit", NULL},
 140         {SR_CONF_ENABLED, SR_T_BOOL, "enabled",
 141                 "Channel enabled", NULL},
 142         {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config",
 143                 "Channel modes", NULL},
 144         {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled",
 145                 "Over-voltage protection enabled", NULL},
 146         {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active",
 147                 "Over-voltage protection active", NULL},
 148         {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold",
 149                 "Over-voltage protection threshold", NULL},
 150         {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled",
 151                 "Over-current protection enabled", NULL},
 152         {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active",
 153                 "Over-current protection active", NULL},
 154         {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold",
 155                 "Over-current protection threshold", NULL},
 156         {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge",
 157                 "Clock edge", NULL},
 158         {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude",
 159                 "Amplitude", NULL},
 160         {SR_CONF_REGULATION, SR_T_STRING, "regulation",
 161                 "Channel regulation", NULL},
 162         {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp",
 163                 "Over-temperature protection", NULL},
 164         {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency",
 165                 "Output frequency", NULL},
 166         {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target",
 167                 "Output frequency target", NULL},
 168         {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity",
 169                 "Measured 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         {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc",
 175                 "Under-voltage condition", NULL},
 176         {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active",
 177                 "Under-voltage condition active", NULL},
 178
 179         /* Special stuff */
 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         {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc",
 193                 "Number of ADC powerline cycles", NULL},
 194
 195         /* Acquisition modes, sample limiting */
 196         {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time",
 197                 "Time limit", NULL},
 198         {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples",
 199                 "Sample limit", NULL},
 200         {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames",
 201                 "Frame limit", NULL},
 202         {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous",
 203                 "Continuous sampling", NULL},
 204         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
 205                 "Datalog", NULL},
 206         {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode",
 207                 "Device mode", NULL},
 208         {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode",
 209                 "Test mode", NULL},
 210
 211         ALL_ZERO
 212 };
 213
 214 /* Please use the same order as in enum sr_mq (libsigrok.h). */
 215 static struct sr_key_info sr_key_info_mq[] = {
 216         {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL},
 217         {SR_MQ_CURRENT, 0, "current", "Current", NULL},
 218         {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL},
 219         {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL},
 220         {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL},
 221         {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL},
 222         {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL},
 223         {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL},
 224         {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL},
 225         {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL},
 226         {SR_MQ_POWER, 0, "power", "Power", NULL},
 227         {SR_MQ_GAIN, 0, "gain", "Gain", NULL},
 228         {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL},
 229         {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL},
 230         {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL},
 231         {SR_MQ_TIME, 0, "time", "Time", NULL},
 232         {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL},
 233         {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL},
 234         {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL},
 235         {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL},
 236         {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL},
 237         {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL},
 238         {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL},
 239         {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL},
 240         {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL},
 241         {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL},
 242         {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL},
 243         {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL},
 244         {SR_MQ_COUNT, 0, "count", "Count", NULL},
 245         {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL},
 246         {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL},
 247         {SR_MQ_MASS, 0, "mass", "Mass", NULL},
 248         ALL_ZERO
 249 };
 250
 251 /* Please use the same order as in enum sr_mqflag (libsigrok.h). */
 252 static struct sr_key_info sr_key_info_mqflag[] = {
 253         {SR_MQFLAG_AC, 0, "ac", "AC", NULL},
 254         {SR_MQFLAG_DC, 0, "dc", "DC", NULL},
 255         {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL},
 256         {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL},
 257         {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL},
 258         {SR_MQFLAG_MAX, 0, "max", "Max", NULL},
 259         {SR_MQFLAG_MIN, 0, "min", "Min", NULL},
 260         {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL},
 261         {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL},
 262         {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a",
 263                 "Frequency weighted (A)", NULL},
 264         {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c",
 265                 "Frequency weighted (C)", NULL},
 266         {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z",
 267                 "Frequency weighted (Z)", NULL},
 268         {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat",
 269                 "Frequency weighted (flat)", NULL},
 270         {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s",
 271                 "Time weighted (S)", NULL},
 272         {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f",
 273                 "Time weighted (F)", NULL},
 274         {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL},
 275         {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm",
 276                 "Percentage over alarm", NULL},
 277         {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL},
 278         {SR_MQFLAG_AVG, 0, "average", "Average", NULL},
 279         {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL},
 280         {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL},
 281         {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL},
 282         ALL_ZERO
 283 };
 284
 285 /* This must handle all the keys from enum sr_datatype (libsigrok.h). */
 286 SR_PRIV const GVariantType *sr_variant_type_get(int datatype)
 287 {
 288         switch (datatype) {
 289         case SR_T_INT32:
 290                 return G_VARIANT_TYPE_INT32;
 291         case SR_T_UINT64:
 292                 return G_VARIANT_TYPE_UINT64;
 293         case SR_T_STRING:
 294                 return G_VARIANT_TYPE_STRING;
 295         case SR_T_BOOL:
 296                 return G_VARIANT_TYPE_BOOLEAN;
 297         case SR_T_FLOAT:
 298                 return G_VARIANT_TYPE_DOUBLE;
 299         case SR_T_RATIONAL_PERIOD:
 300         case SR_T_RATIONAL_VOLT:
 301         case SR_T_UINT64_RANGE:
 302         case SR_T_DOUBLE_RANGE:
 303                 return G_VARIANT_TYPE_TUPLE;
 304         case SR_T_KEYVALUE:
 305                 return G_VARIANT_TYPE_DICTIONARY;
 306         case SR_T_MQ:
 307                 return G_VARIANT_TYPE_TUPLE;
 308         default:
 309                 return NULL;
 310         }
 311 }
 312
 313 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value)
 314 {
 315         const struct sr_key_info *info;
 316         const GVariantType *type, *expected;
 317         char *expected_string, *type_string;
 318
 319         info = sr_key_info_get(SR_KEY_CONFIG, key);
 320         if (!info)
 321                 return SR_OK;
 322
 323         expected = sr_variant_type_get(info->datatype);
 324         type = g_variant_get_type(value);
 325         if (!g_variant_type_equal(type, expected)
 326                         && !g_variant_type_is_subtype_of(type, expected)) {
 327                 expected_string = g_variant_type_dup_string(expected);
 328                 type_string = g_variant_type_dup_string(type);
 329                 sr_err("Wrong variant type for key '%s': expected '%s', got '%s'",
 330                         info->name, expected_string, type_string);
 331                 g_free(expected_string);
 332                 g_free(type_string);
 333                 return SR_ERR_ARG;
 334         }
 335
 336         return SR_OK;
 337 }
 338
 339 /**
 340  * Return the list of supported hardware drivers.
 341  *
 342  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 343  *
 344  * @retval NULL The ctx argument was NULL, or there are no supported drivers.
 345  * @retval Other Pointer to the NULL-terminated list of hardware drivers.
 346  *               The user should NOT g_free() this list, sr_exit() will do that.
 347  *
 348  * @since 0.4.0
 349  */
 350 SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx)
 351 {
 352         if (!ctx)
 353                 return NULL;
 354
 355         return ctx->driver_list;
 356 }
 357
 358 /**
 359  * Initialize a hardware driver.
 360  *
 361  * This usually involves memory allocations and variable initializations
 362  * within the driver, but _not_ scanning for attached devices.
 363  * The API call sr_driver_scan() is used for that.
 364  *
 365  * @param ctx A libsigrok context object allocated by a previous call to
 366  *            sr_init(). Must not be NULL.
 367  * @param driver The driver to initialize. This must be a pointer to one of
 368  *               the entries returned by sr_driver_list(). Must not be NULL.
 369  *
 370  * @retval SR_OK Success
 371  * @retval SR_ERR_ARG Invalid parameter(s).
 372  * @retval SR_ERR_BUG Internal errors.
 373  * @retval other Another negative error code upon other errors.
 374  *
 375  * @since 0.2.0
 376  */
 377 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 378 {
 379         int ret;
 380
 381         if (!ctx) {
 382                 sr_err("Invalid libsigrok context, can't initialize.");
 383                 return SR_ERR_ARG;
 384         }
 385
 386         if (!driver) {
 387                 sr_err("Invalid driver, can't initialize.");
 388                 return SR_ERR_ARG;
 389         }
 390
 391         sr_spew("Initializing driver '%s'.", driver->name);
 392         if ((ret = driver->init(driver, ctx)) < 0)
 393                 sr_err("Failed to initialize the driver: %d.", ret);
 394
 395         return ret;
 396 }
 397
 398 /**
 399  * Enumerate scan options supported by this driver.
 400  *
 401  * Before calling sr_driver_scan_options_list(), the user must have previously
 402  * initialized the driver by calling sr_driver_init().
 403  *
 404  * @param driver The driver to enumerate options for. This must be a pointer
 405  *               to one of the entries returned by sr_driver_list(). Must not
 406  *               be NULL.
 407  *
 408  * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each
 409  *         entry is a configuration key that is supported as a scan option.
 410  *         The array must be freed by the caller using g_array_free().
 411  *
 412  * @since 0.4.0
 413  */
 414 SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver)
 415 {
 416         GVariant *gvar;
 417         const uint32_t *opts;
 418         gsize num_opts;
 419         GArray *result;
 420
 421         if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK)
 422                 return NULL;
 423
 424         opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
 425
 426         result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
 427
 428         g_array_insert_vals(result, 0, opts, num_opts);
 429
 430         g_variant_unref(gvar);
 431
 432         return result;
 433 }
 434
 435 static int check_options(struct sr_dev_driver *driver, GSList *options,
 436                 uint32_t optlist_key, struct sr_dev_inst *sdi,
 437                 struct sr_channel_group *cg)
 438 {
 439         struct sr_config *src;
 440         const struct sr_key_info *srci;
 441         GVariant *gvar_opts;
 442         GSList *l;
 443         const uint32_t *opts;
 444         gsize num_opts, i;
 445         int ret;
 446
 447         if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) {
 448                 /* Driver publishes no options for this optlist. */
 449                 return SR_ERR;
 450         }
 451
 452         ret = SR_OK;
 453         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 454         for (l = options; l; l = l->next) {
 455                 src = l->data;
 456                 for (i = 0; i < num_opts; i++) {
 457                         if (opts[i] == src->key)
 458                                 break;
 459                 }
 460                 if (i == num_opts) {
 461                         if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key)))
 462                                 /* Shouldn't happen. */
 463                                 sr_err("Invalid option %d.", src->key);
 464                         else
 465                                 sr_err("Invalid option '%s'.", srci->id);
 466                         ret = SR_ERR_ARG;
 467                         break;
 468                 }
 469                 if (sr_variant_type_check(src->key, src->data) != SR_OK) {
 470                         ret = SR_ERR_ARG;
 471                         break;
 472                 }
 473         }
 474         g_variant_unref(gvar_opts);
 475
 476         return ret;
 477 }
 478
 479 /**
 480  * Tell a hardware driver to scan for devices.
 481  *
 482  * In addition to the detection, the devices that are found are also
 483  * initialized automatically. On some devices, this involves a firmware upload,
 484  * or other such measures.
 485  *
 486  * The order in which the system is scanned for devices is not specified. The
 487  * caller should not assume or rely on any specific order.
 488  *
 489  * Before calling sr_driver_scan(), the user must have previously initialized
 490  * the driver by calling sr_driver_init().
 491  *
 492  * @param driver The driver that should scan. This must be a pointer to one of
 493  *               the entries returned by sr_driver_list(). Must not be NULL.
 494  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 495  *                scanner. Can be NULL/empty.
 496  *
 497  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 498  *         found (or errors were encountered). This list must be freed by the
 499  *         caller using g_slist_free(), but without freeing the data pointed
 500  *         to in the list.
 501  *
 502  * @since 0.2.0
 503  */
 504 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 505 {
 506         GSList *l;
 507
 508         if (!driver) {
 509                 sr_err("Invalid driver, can't scan for devices.");
 510                 return NULL;
 511         }
 512
 513         if (!driver->context) {
 514                 sr_err("Driver not initialized, can't scan for devices.");
 515                 return NULL;
 516         }
 517
 518         if (options) {
 519                 if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK)
 520                         return NULL;
 521         }
 522
 523         l = driver->scan(driver, options);
 524
 525         sr_spew("Scan of '%s' found %d devices.", driver->name,
 526                 g_slist_length(l));
 527
 528         return l;
 529 }
 530
 531 /**
 532  * Call driver cleanup function for all drivers.
 533  *
 534  * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL.
 535  *
 536  * @private
 537  */
 538 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx)
 539 {
 540         int i;
 541         struct sr_dev_driver **drivers;
 542
 543         if (!ctx)
 544                 return;
 545
 546         drivers = sr_driver_list(ctx);
 547         for (i = 0; drivers[i]; i++) {
 548                 if (drivers[i]->cleanup)
 549                         drivers[i]->cleanup(drivers[i]);
 550                 drivers[i]->context = NULL;
 551         }
 552 }
 553
 554 /** Allocate struct sr_config.
 555  *  A floating reference can be passed in for data.
 556  *  @private
 557  */
 558 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data)
 559 {
 560         struct sr_config *src;
 561
 562         src = g_malloc0(sizeof(struct sr_config));
 563         src->key = key;
 564         src->data = g_variant_ref_sink(data);
 565
 566         return src;
 567 }
 568
 569 /** Free struct sr_config.
 570  *  @private
 571  */
 572 SR_PRIV void sr_config_free(struct sr_config *src)
 573 {
 574
 575         if (!src || !src->data) {
 576                 sr_err("%s: invalid data!", __func__);
 577                 return;
 578         }
 579
 580         g_variant_unref(src->data);
 581         g_free(src);
 582
 583 }
 584
 585 static void log_key(const struct sr_dev_inst *sdi,
 586         const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data)
 587 {
 588         const char *opstr;
 589         const struct sr_key_info *srci;
 590         gchar *tmp_str;
 591
 592         /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */
 593         if (key == SR_CONF_DEVICE_OPTIONS)
 594                 return;
 595
 596         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 597         srci = sr_key_info_get(SR_KEY_CONFIG, key);
 598
 599         tmp_str = g_variant_print(data, TRUE);
 600         sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key,
 601                 srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL",
 602                 data ? tmp_str : "NULL");
 603         g_free(tmp_str);
 604 }
 605
 606 static int check_key(const struct sr_dev_driver *driver,
 607                 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
 608                 uint32_t key, int op, GVariant *data)
 609 {
 610         const struct sr_key_info *srci;
 611         gsize num_opts, i;
 612         GVariant *gvar_opts;
 613         const uint32_t *opts;
 614         uint32_t pub_opt;
 615         const char *suffix;
 616         const char *opstr;
 617
 618         if (sdi && cg)
 619                 suffix = " for this device and channel group";
 620         else if (sdi)
 621                 suffix = " for this device";
 622         else
 623                 suffix = "";
 624
 625         if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) {
 626                 sr_err("Invalid key %d.", key);
 627                 return SR_ERR_ARG;
 628         }
 629         opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list";
 630
 631         switch (key) {
 632         case SR_CONF_LIMIT_MSEC:
 633         case SR_CONF_LIMIT_SAMPLES:
 634         case SR_CONF_SAMPLERATE:
 635                 /* Setting any of these to 0 is not useful. */
 636                 if (op != SR_CONF_SET || !data)
 637                         break;
 638                 if (g_variant_get_uint64(data) == 0) {
 639                         sr_err("Cannot set '%s' to 0.", srci->id);
 640                         return SR_ERR_ARG;
 641                 }
 642                 break;
 643         }
 644
 645         if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) {
 646                 /* Driver publishes no options. */
 647                 sr_err("No options available%s.", suffix);
 648                 return SR_ERR_ARG;
 649         }
 650         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t));
 651         pub_opt = 0;
 652         for (i = 0; i < num_opts; i++) {
 653                 if ((opts[i] & SR_CONF_MASK) == key) {
 654                         pub_opt = opts[i];
 655                         break;
 656                 }
 657         }
 658         g_variant_unref(gvar_opts);
 659         if (!pub_opt) {
 660                 sr_err("Option '%s' not available%s.", srci->id, suffix);
 661                 return SR_ERR_ARG;
 662         }
 663
 664         if (!(pub_opt & op)) {
 665                 sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix);
 666                 return SR_ERR_ARG;
 667         }
 668
 669         return SR_OK;
 670 }
 671
 672 /**
 673  * Query value of a configuration key at the given driver or device instance.
 674  *
 675  * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
 676  * @param[in] sdi (optional) If the key is specific to a device, this must
 677  *            contain a pointer to the struct sr_dev_inst to be checked.
 678  *            Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
 679  *            also be != NULL.
 680  * @param[in] cg The channel group on the device for which to list the
 681  *                    values, or NULL.
 682  * @param[in] key The configuration key (SR_CONF_*).
 683  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 684  *             Must not be NULL. The caller is given ownership of the GVariant
 685  *             and must thus decrease the refcount after use. However if
 686  *             this function returns an error code, the field should be
 687  *             considered unused, and should not be unreferenced.
 688  *
 689  * @retval SR_OK Success.
 690  * @retval SR_ERR Error.
 691  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 692  *          interpreted as an error by the caller; merely as an indication
 693  *          that it's not applicable.
 694  *
 695  * @since 0.3.0
 696  */
 697 SR_API int sr_config_get(const struct sr_dev_driver *driver,
 698                 const struct sr_dev_inst *sdi,
 699                 const struct sr_channel_group *cg,
 700                 uint32_t key, GVariant **data)
 701 {
 702         int ret;
 703
 704         if (!driver || !data)
 705                 return SR_ERR;
 706
 707         if (!driver->config_get)
 708                 return SR_ERR_ARG;
 709
 710         if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK)
 711                 return SR_ERR_ARG;
 712
 713         if (sdi && !sdi->priv) {
 714                 sr_err("Can't get config (sdi != NULL, sdi->priv == NULL).");
 715                 return SR_ERR;
 716         }
 717
 718         if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) {
 719                 log_key(sdi, cg, key, SR_CONF_GET, *data);
 720                 /* Got a floating reference from the driver. Sink it here,
 721                  * caller will need to unref when done with it. */
 722                 g_variant_ref_sink(*data);
 723         }
 724
 725         return ret;
 726 }
 727
 728 /**
 729  * Set value of a configuration key in a device instance.
 730  *
 731  * @param[in] sdi The device instance. Must not be NULL. sdi->driver and
 732  *                sdi->priv must not be NULL either.
 733  * @param[in] cg The channel group on the device for which to list the
 734  *                    values, or NULL.
 735  * @param[in] key The configuration key (SR_CONF_*).
 736  * @param data The new value for the key, as a GVariant with GVariantType
 737  *        appropriate to that key. A floating reference can be passed
 738  *        in; its refcount will be sunk and unreferenced after use.
 739  *
 740  * @retval SR_OK Success.
 741  * @retval SR_ERR Error.
 742  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 743  *          interpreted as an error by the caller; merely as an indication
 744  *          that it's not applicable.
 745  *
 746  * @since 0.3.0
 747  */
 748 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
 749                 const struct sr_channel_group *cg,
 750                 uint32_t key, GVariant *data)
 751 {
 752         int ret;
 753
 754         g_variant_ref_sink(data);
 755
 756         if (!sdi || !sdi->driver || !sdi->priv || !data)
 757                 ret = SR_ERR;
 758         else if (!sdi->driver->config_set)
 759                 ret = SR_ERR_ARG;
 760         else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK)
 761                 return SR_ERR_ARG;
 762         else if ((ret = sr_variant_type_check(key, data)) == SR_OK) {
 763                 log_key(sdi, cg, key, SR_CONF_SET, data);
 764                 ret = sdi->driver->config_set(key, data, sdi, cg);
 765         }
 766
 767         g_variant_unref(data);
 768
 769         return ret;
 770 }
 771
 772 /**
 773  * Apply configuration settings to the device hardware.
 774  *
 775  * @param sdi The device instance.
 776  *
 777  * @return SR_OK upon success or SR_ERR in case of error.
 778  *
 779  * @since 0.3.0
 780  */
 781 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 782 {
 783         int ret;
 784
 785         if (!sdi || !sdi->driver)
 786                 ret = SR_ERR;
 787         else if (!sdi->driver->config_commit)
 788                 ret = SR_OK;
 789         else
 790                 ret = sdi->driver->config_commit(sdi);
 791
 792         return ret;
 793 }
 794
 795 /**
 796  * List all possible values for a configuration key.
 797  *
 798  * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
 799  * @param[in] sdi (optional) If the key is specific to a device, this must
 800  *            contain a pointer to the struct sr_dev_inst to be checked.
 801  *            Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
 802  *            also be != NULL.
 803  * @param[in] cg The channel group on the device for which to list the
 804  *                    values, or NULL.
 805  * @param[in] key The configuration key (SR_CONF_*).
 806  * @param[in,out] data A pointer to a GVariant where the list will be stored.
 807  *             The caller is given ownership of the GVariant and must thus
 808  *             unref the GVariant after use. However if this function
 809  *             returns an error code, the field should be considered
 810  *             unused, and should not be unreferenced.
 811  *
 812  * @retval SR_OK Success.
 813  * @retval SR_ERR Error.
 814  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 815  *          interpreted as an error by the caller; merely as an indication
 816  *          that it's not applicable.
 817  *
 818  * @since 0.3.0
 819  */
 820 SR_API int sr_config_list(const struct sr_dev_driver *driver,
 821                 const struct sr_dev_inst *sdi,
 822                 const struct sr_channel_group *cg,
 823                 uint32_t key, GVariant **data)
 824 {
 825         int ret;
 826
 827         if (!driver || !data)
 828                 return SR_ERR;
 829         else if (!driver->config_list)
 830                 return SR_ERR_ARG;
 831         else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) {
 832                 if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK)
 833                         return SR_ERR_ARG;
 834         }
 835         if (sdi && !sdi->priv) {
 836                 sr_err("Can't list config (sdi != NULL, sdi->priv == NULL).");
 837                 return SR_ERR;
 838         }
 839         if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) {
 840                 log_key(sdi, cg, key, SR_CONF_LIST, *data);
 841                 g_variant_ref_sink(*data);
 842         }
 843
 844         return ret;
 845 }
 846
 847 static struct sr_key_info *get_keytable(int keytype)
 848 {
 849         struct sr_key_info *table;
 850
 851         switch (keytype) {
 852         case SR_KEY_CONFIG:
 853                 table = sr_key_info_config;
 854                 break;
 855         case SR_KEY_MQ:
 856                 table = sr_key_info_mq;
 857                 break;
 858         case SR_KEY_MQFLAGS:
 859                 table = sr_key_info_mqflag;
 860                 break;
 861         default:
 862                 sr_err("Invalid keytype %d", keytype);
 863                 return NULL;
 864         }
 865
 866         return table;
 867 }
 868
 869 /**
 870  * Get information about a key, by key.
 871  *
 872  * @param[in] keytype The namespace the key is in.
 873  * @param[in] key The key to find.
 874  *
 875  * @return A pointer to a struct sr_key_info, or NULL if the key
 876  *         was not found.
 877  *
 878  * @since 0.3.0
 879  */
 880 SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key)
 881 {
 882         struct sr_key_info *table;
 883         int i;
 884
 885         if (!(table = get_keytable(keytype)))
 886                 return NULL;
 887
 888         for (i = 0; table[i].key; i++) {
 889                 if (table[i].key == key)
 890                         return &table[i];
 891         }
 892
 893         return NULL;
 894 }
 895
 896 /**
 897  * Get information about a key, by name.
 898  *
 899  * @param[in] keytype The namespace the key is in.
 900  * @param[in] keyid The key id string.
 901  *
 902  * @return A pointer to a struct sr_key_info, or NULL if the key
 903  *         was not found.
 904  *
 905  * @since 0.2.0
 906  */
 907 SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid)
 908 {
 909         struct sr_key_info *table;
 910         int i;
 911
 912         if (!(table = get_keytable(keytype)))
 913                 return NULL;
 914
 915         for (i = 0; table[i].key; i++) {
 916                 if (!table[i].id)
 917                         continue;
 918                 if (!strcmp(table[i].id, keyid))
 919                         return &table[i];
 920         }
 921
 922         return NULL;
 923 }
 924
 925 /** @} */