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