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