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