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