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