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