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