include/libsigrok/libsigrok.h

   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 #ifndef LIBSIGROK_LIBSIGROK_H
  21 #define LIBSIGROK_LIBSIGROK_H
  22
  23 #include <stdio.h>
  24 #include <sys/time.h>
  25 #include <stdint.h>
  26 #include <inttypes.h>
  27 #include <glib.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /**
  34  * @file
  35  *
  36  * The public libsigrok header file to be used by frontends.
  37  *
  38  * This is the only file that libsigrok users (frontends) are supposed to
  39  * use and \#include. There are other header files which get installed with
  40  * libsigrok, but those are not meant to be used directly by frontends.
  41  *
  42  * The correct way to get/use the libsigrok API functions is:
  43  *
  44  * @code{.c}
  45  *   #include <libsigrok/libsigrok.h>
  46  * @endcode
  47  */
  48
  49 /*
  50  * All possible return codes of libsigrok functions must be listed here.
  51  * Functions should never return hardcoded numbers as status, but rather
  52  * use these enum values. All error codes are negative numbers.
  53  *
  54  * The error codes are globally unique in libsigrok, i.e. if one of the
  55  * libsigrok functions returns a "malloc error" it must be exactly the same
  56  * return value as used by all other functions to indicate "malloc error".
  57  * There must be no functions which indicate two different errors via the
  58  * same return code.
  59  *
  60  * Also, for compatibility reasons, no defined return codes are ever removed
  61  * or reused for different errors later. You can only add new entries and
  62  * return codes, but never remove or redefine existing ones.
  63  */
  64
  65 /** Status/error codes returned by libsigrok functions. */
  66 enum sr_error_code {
  67         SR_OK                =  0, /**< No error. */
  68         SR_ERR               = -1, /**< Generic/unspecified error. */
  69         SR_ERR_MALLOC        = -2, /**< Malloc/calloc/realloc error. */
  70         SR_ERR_ARG           = -3, /**< Function argument error. */
  71         SR_ERR_BUG           = -4, /**< Errors hinting at internal bugs. */
  72         SR_ERR_SAMPLERATE    = -5, /**< Incorrect samplerate. */
  73         SR_ERR_NA            = -6, /**< Not applicable. */
  74         SR_ERR_DEV_CLOSED    = -7, /**< Device is closed, but must be open. */
  75         SR_ERR_TIMEOUT       = -8, /**< A timeout occurred. */
  76         SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
  77         SR_ERR_DATA          =-10, /**< Data is invalid.  */
  78         SR_ERR_IO            =-11, /**< Input/output error. */
  79
  80         /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
  81 };
  82
  83 /** Ternary return type for DMM/LCR/etc packet parser validity checks. */
  84 enum sr_valid_code {
  85         SR_PACKET_INVALID = -1, /**< Certainly invalid. */
  86         SR_PACKET_VALID = 0,    /**< Certainly valid. */
  87         SR_PACKET_NEED_RX = +1, /**< Need more RX data. */
  88 };
  89
  90 #define SR_MAX_CHANNELNAME_LEN 32
  91
  92 /* Handy little macros */
  93 #define SR_HZ(n)  (n)
  94 #define SR_KHZ(n) ((n) * UINT64_C(1000))
  95 #define SR_MHZ(n) ((n) * UINT64_C(1000000))
  96 #define SR_GHZ(n) ((n) * UINT64_C(1000000000))
  97
  98 #define SR_HZ_TO_NS(n) (UINT64_C(1000000000) / (n))
  99
 100 /** libsigrok loglevels. */
 101 enum sr_loglevel {
 102         SR_LOG_NONE = 0, /**< Output no messages at all. */
 103         SR_LOG_ERR  = 1, /**< Output error messages. */
 104         SR_LOG_WARN = 2, /**< Output warnings. */
 105         SR_LOG_INFO = 3, /**< Output informational messages. */
 106         SR_LOG_DBG  = 4, /**< Output debug messages. */
 107         SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
 108 };
 109
 110 /*
 111  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
 112  *
 113  * Variables and functions marked 'static' are private already and don't
 114  * need SR_PRIV. However, functions which are not static (because they need
 115  * to be used in other libsigrok-internal files) but are also not meant to
 116  * be part of the public libsigrok API, must use SR_PRIV.
 117  *
 118  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 119  *
 120  * This feature is not available on MinGW/Windows, as it is a feature of
 121  * ELF files and MinGW/Windows uses PE files.
 122  *
 123  * Details: http://gcc.gnu.org/wiki/Visibility
 124  */
 125
 126 /* Marks public libsigrok API symbols. */
 127 #ifndef _WIN32
 128 #define SR_API __attribute__((visibility("default")))
 129 #else
 130 #define SR_API
 131 #endif
 132
 133 /* Marks private, non-public libsigrok symbols (not part of the API). */
 134 #ifndef _WIN32
 135 #define SR_PRIV __attribute__((visibility("hidden")))
 136 #else
 137 #define SR_PRIV
 138 #endif
 139
 140 /** Type definition for callback function for data reception. */
 141 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
 142
 143 /** Data types used by sr_config_info(). */
 144 enum sr_datatype {
 145         SR_T_UINT64 = 10000,
 146         SR_T_STRING,
 147         SR_T_BOOL,
 148         SR_T_FLOAT,
 149         SR_T_RATIONAL_PERIOD,
 150         SR_T_RATIONAL_VOLT,
 151         SR_T_KEYVALUE,
 152         SR_T_UINT64_RANGE,
 153         SR_T_DOUBLE_RANGE,
 154         SR_T_INT32,
 155         SR_T_MQ,
 156         SR_T_UINT32,
 157
 158         /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
 159 };
 160
 161 /** Value for sr_datafeed_packet.type. */
 162 enum sr_packettype {
 163         /** Payload is sr_datafeed_header. */
 164         SR_DF_HEADER = 10000,
 165         /** End of stream (no further data). */
 166         SR_DF_END,
 167         /** Payload is struct sr_datafeed_meta */
 168         SR_DF_META,
 169         /** The trigger matched at this point in the data feed. No payload. */
 170         SR_DF_TRIGGER,
 171         /** Payload is struct sr_datafeed_logic. */
 172         SR_DF_LOGIC,
 173         /** Beginning of frame. No payload. */
 174         SR_DF_FRAME_BEGIN,
 175         /** End of frame. No payload. */
 176         SR_DF_FRAME_END,
 177         /** Payload is struct sr_datafeed_analog. */
 178         SR_DF_ANALOG,
 179
 180         /* Update datafeed_dump() (session.c) upon changes! */
 181 };
 182
 183 /** Measured quantity, sr_analog_meaning.mq. */
 184 enum sr_mq {
 185         SR_MQ_VOLTAGE = 10000,
 186         SR_MQ_CURRENT,
 187         SR_MQ_RESISTANCE,
 188         SR_MQ_CAPACITANCE,
 189         SR_MQ_TEMPERATURE,
 190         SR_MQ_FREQUENCY,
 191         /** Duty cycle, e.g. on/off ratio. */
 192         SR_MQ_DUTY_CYCLE,
 193         /** Continuity test. */
 194         SR_MQ_CONTINUITY,
 195         SR_MQ_PULSE_WIDTH,
 196         SR_MQ_CONDUCTANCE,
 197         /** Electrical power, usually in W, or dBm. */
 198         SR_MQ_POWER,
 199         /** Gain (a transistor's gain, or hFE, for example). */
 200         SR_MQ_GAIN,
 201         /** Logarithmic representation of sound pressure relative to a
 202          * reference value. */
 203         SR_MQ_SOUND_PRESSURE_LEVEL,
 204         /** Carbon monoxide level */
 205         SR_MQ_CARBON_MONOXIDE,
 206         /** Humidity */
 207         SR_MQ_RELATIVE_HUMIDITY,
 208         /** Time */
 209         SR_MQ_TIME,
 210         /** Wind speed */
 211         SR_MQ_WIND_SPEED,
 212         /** Pressure */
 213         SR_MQ_PRESSURE,
 214         /** Parallel inductance (LCR meter model). */
 215         SR_MQ_PARALLEL_INDUCTANCE,
 216         /** Parallel capacitance (LCR meter model). */
 217         SR_MQ_PARALLEL_CAPACITANCE,
 218         /** Parallel resistance (LCR meter model). */
 219         SR_MQ_PARALLEL_RESISTANCE,
 220         /** Series inductance (LCR meter model). */
 221         SR_MQ_SERIES_INDUCTANCE,
 222         /** Series capacitance (LCR meter model). */
 223         SR_MQ_SERIES_CAPACITANCE,
 224         /** Series resistance (LCR meter model). */
 225         SR_MQ_SERIES_RESISTANCE,
 226         /** Dissipation factor. */
 227         SR_MQ_DISSIPATION_FACTOR,
 228         /** Quality factor. */
 229         SR_MQ_QUALITY_FACTOR,
 230         /** Phase angle. */
 231         SR_MQ_PHASE_ANGLE,
 232         /** Difference from reference value. */
 233         SR_MQ_DIFFERENCE,
 234         /** Count. */
 235         SR_MQ_COUNT,
 236         /** Power factor. */
 237         SR_MQ_POWER_FACTOR,
 238         /** Apparent power */
 239         SR_MQ_APPARENT_POWER,
 240         /** Mass */
 241         SR_MQ_MASS,
 242         /** Harmonic ratio */
 243         SR_MQ_HARMONIC_RATIO,
 244         /** Energy. */
 245         SR_MQ_ENERGY,
 246         /** Electric charge. */
 247         SR_MQ_ELECTRIC_CHARGE,
 248
 249         /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
 250 };
 251
 252 /** Unit of measured quantity, sr_analog_meaning.unit. */
 253 enum sr_unit {
 254         /** Volt */
 255         SR_UNIT_VOLT = 10000,
 256         /** Ampere (current). */
 257         SR_UNIT_AMPERE,
 258         /** Ohm (resistance). */
 259         SR_UNIT_OHM,
 260         /** Farad (capacity). */
 261         SR_UNIT_FARAD,
 262         /** Kelvin (temperature). */
 263         SR_UNIT_KELVIN,
 264         /** Degrees Celsius (temperature). */
 265         SR_UNIT_CELSIUS,
 266         /** Degrees Fahrenheit (temperature). */
 267         SR_UNIT_FAHRENHEIT,
 268         /** Hertz (frequency, 1/s, [Hz]). */
 269         SR_UNIT_HERTZ,
 270         /** Percent value. */
 271         SR_UNIT_PERCENTAGE,
 272         /** Boolean value. */
 273         SR_UNIT_BOOLEAN,
 274         /** Time in seconds. */
 275         SR_UNIT_SECOND,
 276         /** Unit of conductance, the inverse of resistance. */
 277         SR_UNIT_SIEMENS,
 278         /**
 279          * An absolute measurement of power, in decibels, referenced to
 280          * 1 milliwatt (dBm).
 281          */
 282         SR_UNIT_DECIBEL_MW,
 283         /** Voltage in decibel, referenced to 1 volt (dBV). */
 284         SR_UNIT_DECIBEL_VOLT,
 285         /**
 286          * Measurements that intrinsically do not have units attached, such
 287          * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
 288          * a unitless quantity, for example.
 289          */
 290         SR_UNIT_UNITLESS,
 291         /** Sound pressure level, in decibels, relative to 20 micropascals. */
 292         SR_UNIT_DECIBEL_SPL,
 293         /**
 294          * Normalized (0 to 1) concentration of a substance or compound with 0
 295          * representing a concentration of 0%, and 1 being 100%. This is
 296          * represented as the fraction of number of particles of the substance.
 297          */
 298         SR_UNIT_CONCENTRATION,
 299         /** Revolutions per minute. */
 300         SR_UNIT_REVOLUTIONS_PER_MINUTE,
 301         /** Apparent power [VA]. */
 302         SR_UNIT_VOLT_AMPERE,
 303         /** Real power [W]. */
 304         SR_UNIT_WATT,
 305         /** Energy (consumption) in watt hour [Wh]. */
 306         SR_UNIT_WATT_HOUR,
 307         /** Wind speed in meters per second. */
 308         SR_UNIT_METER_SECOND,
 309         /** Pressure in hectopascal */
 310         SR_UNIT_HECTOPASCAL,
 311         /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
 312         SR_UNIT_HUMIDITY_293K,
 313         /** Plane angle in 1/360th of a full circle. */
 314         SR_UNIT_DEGREE,
 315         /** Henry (inductance). */
 316         SR_UNIT_HENRY,
 317         /** Mass in gram [g]. */
 318         SR_UNIT_GRAM,
 319         /** Mass in carat [ct]. */
 320         SR_UNIT_CARAT,
 321         /** Mass in ounce [oz]. */
 322         SR_UNIT_OUNCE,
 323         /** Mass in troy ounce [oz t]. */
 324         SR_UNIT_TROY_OUNCE,
 325         /** Mass in pound [lb]. */
 326         SR_UNIT_POUND,
 327         /** Mass in pennyweight [dwt]. */
 328         SR_UNIT_PENNYWEIGHT,
 329         /** Mass in grain [gr]. */
 330         SR_UNIT_GRAIN,
 331         /** Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan) */
 332         SR_UNIT_TAEL,
 333         /** Mass in momme. */
 334         SR_UNIT_MOMME,
 335         /** Mass in tola. */
 336         SR_UNIT_TOLA,
 337         /** Pieces (number of items). */
 338         SR_UNIT_PIECE,
 339         /** Energy in joule. */
 340         SR_UNIT_JOULE,
 341         /** Electric charge in coulomb. */
 342         SR_UNIT_COULOMB,
 343         /** Electric charge in ampere hour [Ah]. */
 344         SR_UNIT_AMPERE_HOUR,
 345
 346         /*
 347          * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
 348          * upon changes!
 349          */
 350 };
 351
 352 /** Values for sr_analog_meaning.mqflags. */
 353 enum sr_mqflag {
 354         /** Voltage measurement is alternating current (AC). */
 355         SR_MQFLAG_AC = 0x01,
 356         /** Voltage measurement is direct current (DC). */
 357         SR_MQFLAG_DC = 0x02,
 358         /** This is a true RMS measurement. */
 359         SR_MQFLAG_RMS = 0x04,
 360         /** Value is voltage drop across a diode, or NAN. */
 361         SR_MQFLAG_DIODE = 0x08,
 362         /** Device is in "hold" mode (repeating the last measurement). */
 363         SR_MQFLAG_HOLD = 0x10,
 364         /** Device is in "max" mode, only updating upon a new max value. */
 365         SR_MQFLAG_MAX = 0x20,
 366         /** Device is in "min" mode, only updating upon a new min value. */
 367         SR_MQFLAG_MIN = 0x40,
 368         /** Device is in autoranging mode. */
 369         SR_MQFLAG_AUTORANGE = 0x80,
 370         /** Device is in relative mode. */
 371         SR_MQFLAG_RELATIVE = 0x100,
 372         /** Sound pressure level is A-weighted in the frequency domain,
 373          * according to IEC 61672:2003. */
 374         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
 375         /** Sound pressure level is C-weighted in the frequency domain,
 376          * according to IEC 61672:2003. */
 377         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
 378         /** Sound pressure level is Z-weighted (i.e. not at all) in the
 379          * frequency domain, according to IEC 61672:2003. */
 380         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
 381         /** Sound pressure level is not weighted in the frequency domain,
 382          * albeit without standards-defined low and high frequency limits. */
 383         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
 384         /** Sound pressure level measurement is S-weighted (1s) in the
 385          * time domain. */
 386         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
 387         /** Sound pressure level measurement is F-weighted (125ms) in the
 388          * time domain. */
 389         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
 390         /** Sound pressure level is time-averaged (LAT), also known as
 391          * Equivalent Continuous A-weighted Sound Level (LEQ). */
 392         SR_MQFLAG_SPL_LAT = 0x8000,
 393         /** Sound pressure level represented as a percentage of measurements
 394          * that were over a preset alarm level. */
 395         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 396         /** Time is duration (as opposed to epoch, ...). */
 397         SR_MQFLAG_DURATION = 0x20000,
 398         /** Device is in "avg" mode, averaging upon each new value. */
 399         SR_MQFLAG_AVG = 0x40000,
 400         /** Reference value shown. */
 401         SR_MQFLAG_REFERENCE = 0x80000,
 402         /** Unstable value (hasn't settled yet). */
 403         SR_MQFLAG_UNSTABLE = 0x100000,
 404         /** Measurement is four wire (e.g. Kelvin connection). */
 405         SR_MQFLAG_FOUR_WIRE = 0x200000,
 406
 407         /*
 408          * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
 409          * upon changes!
 410          */
 411 };
 412
 413 enum sr_trigger_matches {
 414         SR_TRIGGER_ZERO = 1,
 415         SR_TRIGGER_ONE,
 416         SR_TRIGGER_RISING,
 417         SR_TRIGGER_FALLING,
 418         SR_TRIGGER_EDGE,
 419         SR_TRIGGER_OVER,
 420         SR_TRIGGER_UNDER,
 421 };
 422
 423 /** The representation of a trigger, consisting of one or more stages
 424  * containing one or more matches on a channel.
 425  */
 426 struct sr_trigger {
 427         /** A name for this trigger. This may be NULL if none is needed. */
 428         char *name;
 429         /** List of pointers to struct sr_trigger_stage. */
 430         GSList *stages;
 431 };
 432
 433 /** A trigger stage. */
 434 struct sr_trigger_stage {
 435         /** Starts at 0. */
 436         int stage;
 437         /** List of pointers to struct sr_trigger_match. */
 438         GSList *matches;
 439 };
 440
 441 /** A channel to match and what to match it on. */
 442 struct sr_trigger_match {
 443         /** The channel to trigger on. */
 444         struct sr_channel *channel;
 445         /** The trigger match to use.
 446          * For logic channels, only the following matches may be used:
 447          * SR_TRIGGER_ZERO
 448          * SR_TRIGGER_ONE
 449          * SR_TRIGGER_RISING
 450          * SR_TRIGGER_FALLING
 451          * SR_TRIGGER_EDGE
 452          *
 453          * For analog channels, only these matches may be used:
 454          * SR_TRIGGER_RISING
 455          * SR_TRIGGER_FALLING
 456          * SR_TRIGGER_OVER
 457          * SR_TRIGGER_UNDER
 458          *
 459          */
 460         int match;
 461         /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
 462          * this contains the value to compare against. */
 463         float value;
 464 };
 465
 466 /**
 467  * @struct sr_context
 468  * Opaque structure representing a libsigrok context.
 469  *
 470  * None of the fields of this structure are meant to be accessed directly.
 471  *
 472  * @see sr_init(), sr_exit().
 473  */
 474 struct sr_context;
 475
 476 /**
 477  * @struct sr_session
 478  * Opaque structure representing a libsigrok session.
 479  *
 480  * None of the fields of this structure are meant to be accessed directly.
 481  *
 482  * @see sr_session_new(), sr_session_destroy().
 483  */
 484 struct sr_session;
 485
 486 struct sr_rational {
 487         /** Numerator of the rational number. */
 488         int64_t p;
 489         /** Denominator of the rational number. */
 490         uint64_t q;
 491 };
 492
 493 /** Packet in a sigrok data feed. */
 494 struct sr_datafeed_packet {
 495         uint16_t type;
 496         const void *payload;
 497 };
 498
 499 /** Header of a sigrok data feed. */
 500 struct sr_datafeed_header {
 501         int feed_version;
 502         struct timeval starttime;
 503 };
 504
 505 /** Datafeed payload for type SR_DF_META. */
 506 struct sr_datafeed_meta {
 507         GSList *config;
 508 };
 509
 510 /** Logic datafeed payload for type SR_DF_LOGIC. */
 511 struct sr_datafeed_logic {
 512         uint64_t length;
 513         uint16_t unitsize;
 514         void *data;
 515 };
 516
 517 /** Analog datafeed payload for type SR_DF_ANALOG. */
 518 struct sr_datafeed_analog {
 519         void *data;
 520         uint32_t num_samples;
 521         struct sr_analog_encoding *encoding;
 522         struct sr_analog_meaning *meaning;
 523         struct sr_analog_spec *spec;
 524 };
 525
 526 struct sr_analog_encoding {
 527         uint8_t unitsize;
 528         gboolean is_signed;
 529         gboolean is_float;
 530         gboolean is_bigendian;
 531         /**
 532          * Number of significant digits after the decimal point, if positive.
 533          * When negative, exponent with reversed polarity that is necessary to
 534          * express the value with all digits without a decimal point.
 535          * Refers to the value we actually read on the wire.
 536          *
 537          * Examples:
 538          *
 539          * | Disp. value | Exp. notation       | Exp. not. normalized | digits |
 540          * |-------------|---------------------|----------------------|--------|
 541          * |  12.34 MOhm |  1.234 * 10^7   Ohm |    1234 * 10^4   Ohm |     -4 |
 542          * | 1.2345 MOhm | 1.2345 * 10^6   Ohm |   12345 * 10^2   Ohm |     -2 |
 543          * |  123.4 kOhm |  1.234 * 10^5   Ohm |    1234 * 10^2   Ohm |     -2 |
 544          * |   1234  Ohm |  1.234 * 10^3   Ohm |    1234 * 10^0   Ohm |      0 |
 545          * |  12.34  Ohm |  1.234 * 10^1   Ohm |    1234 * 10^-2  Ohm |      2 |
 546          * | 0.0123  Ohm |   1.23 * 10^-2  Ohm |     123 * 10^-4  Ohm |      4 |
 547          * |  1.234 pF   |  1.234 * 10^-12 F   |    1234 * 10^-15 F   |     15 |
 548          */
 549         int8_t digits;
 550         gboolean is_digits_decimal;
 551         struct sr_rational scale;
 552         struct sr_rational offset;
 553 };
 554
 555 struct sr_analog_meaning {
 556         enum sr_mq mq;
 557         enum sr_unit unit;
 558         enum sr_mqflag mqflags;
 559         GSList *channels;
 560 };
 561
 562 struct sr_analog_spec {
 563         /**
 564          * Number of significant digits after the decimal point, if positive.
 565          * When negative, exponent with reversed polarity that is necessary to
 566          * express the value with all digits without a decimal point.
 567          * Refers to vendor specifications/datasheet or actual device display.
 568          *
 569          * Examples:
 570          *
 571          * | On the wire | Exp. notation       | Exp. not. normalized | spec_digits |
 572          * |-------------|---------------------|----------------------|-------------|
 573          * |  12.34 MOhm |  1.234 * 10^7   Ohm |    1234 * 10^4   Ohm |          -4 |
 574          * | 1.2345 MOhm | 1.2345 * 10^6   Ohm |   12345 * 10^2   Ohm |          -2 |
 575          * |  123.4 kOhm |  1.234 * 10^5   Ohm |    1234 * 10^2   Ohm |          -2 |
 576          * |   1234  Ohm |  1.234 * 10^3   Ohm |    1234 * 10^0   Ohm |           0 |
 577          * |  12.34  Ohm |  1.234 * 10^1   Ohm |    1234 * 10^-2  Ohm |           2 |
 578          * | 0.0123  Ohm |   1.23 * 10^-2  Ohm |     123 * 10^-4  Ohm |           4 |
 579          * |  1.234 pF   |  1.234 * 10^-12 F   |    1234 * 10^-15 F   |          15 |
 580          */
 581         int8_t spec_digits;
 582 };
 583
 584 /** Generic option struct used by various subsystems. */
 585 struct sr_option {
 586         /* Short name suitable for commandline usage, [a-z0-9-]. */
 587         const char *id;
 588         /* Short name suitable for GUI usage, can contain UTF-8. */
 589         const char *name;
 590         /* Description of the option, in a sentence. */
 591         const char *desc;
 592         /* Default value for this option. */
 593         GVariant *def;
 594         /* List of possible values, if this is an option with few values. */
 595         GSList *values;
 596 };
 597
 598 /** Resource type.
 599  * @since 0.4.0
 600  */
 601 enum sr_resource_type {
 602         SR_RESOURCE_FIRMWARE = 1,
 603 };
 604
 605 /** Resource descriptor.
 606  * @since 0.4.0
 607  */
 608 struct sr_resource {
 609         /** Size of resource in bytes; set by resource open callback. */
 610         uint64_t size;
 611         /** File handle or equivalent; set by resource open callback. */
 612         void *handle;
 613         /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
 614         int type;
 615 };
 616
 617 /** Output module flags. */
 618 enum sr_output_flag {
 619         /** If set, this output module writes the output itself. */
 620         SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
 621 };
 622
 623 struct sr_input;
 624 struct sr_input_module;
 625 struct sr_output;
 626 struct sr_output_module;
 627 struct sr_transform;
 628 struct sr_transform_module;
 629
 630 /** Constants for channel type. */
 631 enum sr_channeltype {
 632         /** Channel type is logic channel. */
 633         SR_CHANNEL_LOGIC = 10000,
 634         /** Channel type is analog channel. */
 635         SR_CHANNEL_ANALOG,
 636 };
 637
 638 /** Information on single channel. */
 639 struct sr_channel {
 640         /** The device this channel is attached to. */
 641         struct sr_dev_inst *sdi;
 642         /** The index of this channel, starting at 0. Logic channels will
 643          * be encoded according to this index in SR_DF_LOGIC packets. */
 644         int index;
 645         /** Channel type (SR_CHANNEL_LOGIC, ...) */
 646         int type;
 647         /** Is this channel enabled? */
 648         gboolean enabled;
 649         /** Name of channel. */
 650         char *name;
 651         /** Private data for driver use. */
 652         void *priv;
 653 };
 654
 655 /** Structure for groups of channels that have common properties. */
 656 struct sr_channel_group {
 657         /** Name of the channel group. */
 658         char *name;
 659         /** List of sr_channel structs of the channels belonging to this group. */
 660         GSList *channels;
 661         /** Private data for driver use. */
 662         void *priv;
 663 };
 664
 665 /** Used for setting or getting value of a config item. */
 666 struct sr_config {
 667         /** Config key like SR_CONF_CONN, etc. */
 668         uint32_t key;
 669         /** Key-specific data. */
 670         GVariant *data;
 671 };
 672
 673 enum sr_keytype {
 674         SR_KEY_CONFIG,
 675         SR_KEY_MQ,
 676         SR_KEY_MQFLAGS,
 677 };
 678
 679 /** Information about a key. */
 680 struct sr_key_info {
 681         /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
 682         uint32_t key;
 683         /** Data type like SR_T_STRING, etc if applicable. */
 684         int datatype;
 685         /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
 686         const char *id;
 687         /** Full capitalized name, e.g. "Serial communication". */
 688         const char *name;
 689         /** Verbose description (unused currently). */
 690         const char *description;
 691 };
 692
 693 /** Configuration capabilities. */
 694 enum sr_configcap {
 695         /** Value can be read. */
 696         SR_CONF_GET = (1UL << 31),
 697         /** Value can be written. */
 698         SR_CONF_SET = (1UL << 30),
 699         /** Possible values can be enumerated. */
 700         SR_CONF_LIST = (1UL << 29),
 701 };
 702
 703 /** Configuration keys */
 704 enum sr_configkey {
 705         /*--- Device classes ------------------------------------------------*/
 706
 707         /** The device can act as logic analyzer. */
 708         SR_CONF_LOGIC_ANALYZER = 10000,
 709
 710         /** The device can act as an oscilloscope. */
 711         SR_CONF_OSCILLOSCOPE,
 712
 713         /** The device can act as a multimeter. */
 714         SR_CONF_MULTIMETER,
 715
 716         /** The device is a demo device. */
 717         SR_CONF_DEMO_DEV,
 718
 719         /** The device can act as a sound level meter. */
 720         SR_CONF_SOUNDLEVELMETER,
 721
 722         /** The device can measure temperature. */
 723         SR_CONF_THERMOMETER,
 724
 725         /** The device can measure humidity. */
 726         SR_CONF_HYGROMETER,
 727
 728         /** The device can measure energy consumption. */
 729         SR_CONF_ENERGYMETER,
 730
 731         /** The device can act as a signal demodulator. */
 732         SR_CONF_DEMODULATOR,
 733
 734         /** The device can act as a programmable power supply. */
 735         SR_CONF_POWER_SUPPLY,
 736
 737         /** The device can act as an LCR meter. */
 738         SR_CONF_LCRMETER,
 739
 740         /** The device can act as an electronic load. */
 741         SR_CONF_ELECTRONIC_LOAD,
 742
 743         /** The device can act as a scale. */
 744         SR_CONF_SCALE,
 745
 746         /** The device can act as a function generator. */
 747         SR_CONF_SIGNAL_GENERATOR,
 748
 749         /** The device can measure power. */
 750         SR_CONF_POWERMETER,
 751
 752         /**
 753          * The device can switch between multiple sources, e.g. a relay actuator
 754          * or multiplexer.
 755          */
 756         SR_CONF_MULTIPLEXER,
 757
 758         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 759
 760         /*--- Driver scan options -------------------------------------------*/
 761
 762         /**
 763          * Specification on how to connect to a device.
 764          *
 765          * In combination with SR_CONF_SERIALCOMM, this is a serial port in
 766          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 767          * Otherwise this specifies a USB device, either in the form of
 768          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 769          * @verbatim <vendorid>.<productid> @endverbatim
 770          * (hexadecimal, e.g. 1d6b.0001).
 771          */
 772         SR_CONF_CONN = 20000,
 773
 774         /**
 775          * Serial communication specification, in the form:
 776          *
 777          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 778          *
 779          * Example: 9600/8n1
 780          *
 781          * The string may also be followed by one or more special settings,
 782          * in the form "/key=value". Supported keys and their values are:
 783          *
 784          * rts    0,1    set the port's RTS pin to low or high
 785          * dtr    0,1    set the port's DTR pin to low or high
 786          * flow   0      no flow control
 787          *        1      hardware-based (RTS/CTS) flow control
 788          *        2      software-based (XON/XOFF) flow control
 789          *
 790          * This is always an optional parameter, since a driver typically
 791          * knows the speed at which the device wants to communicate.
 792          */
 793         SR_CONF_SERIALCOMM,
 794
 795         /**
 796          * Modbus slave address specification.
 797          *
 798          * This is always an optional parameter, since a driver typically
 799          * knows the default slave address of the device.
 800          */
 801         SR_CONF_MODBUSADDR,
 802
 803         /**
 804          * User specified forced driver attachment to unknown devices.
 805          *
 806          * By design the interpretation of the string depends on the
 807          * specific driver. It typically would be either a replacement
 808          * '*IDN?' response value, or a sub-driver name. But could also
 809          * be anything else and totally arbitrary.
 810          */
 811         SR_CONF_FORCE_DETECT,
 812
 813         /**
 814          * Override builtin probe names from user specs.
 815          *
 816          * Users may want to override the names which are assigned to
 817          * probes during scan (these usually match the vendor's labels
 818          * on the device). This avoids the interactive tedium of
 819          * changing channel names after device creation and before
 820          * protocol decoder attachment. Think of IEEE488 recorders or
 821          * parallel computer bus loggers. The scan option eliminates
 822          * the issue of looking up previously assigned names before
 823          * renaming a channel (see sigrok-cli -C), which depends on
 824          * the device as well as the application, and is undesirable.
 825          * The scan option is limited to those drivers which implement
 826          * support for it, but works identically across those drivers.
 827          *
 828          * The value is a string, either a comma separated list of
 829          * probe names, or an alias for a typical set of names.
 830          */
 831         SR_CONF_PROBE_NAMES,
 832
 833         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 834
 835         /*--- Device (or channel group) configuration -----------------------*/
 836
 837         /** The device supports setting its samplerate, in Hz. */
 838         SR_CONF_SAMPLERATE = 30000,
 839
 840         /** The device supports setting a pre/post-trigger capture ratio. */
 841         SR_CONF_CAPTURE_RATIO,
 842
 843         /** The device supports setting a pattern (pattern generator mode). */
 844         SR_CONF_PATTERN_MODE,
 845
 846         /** The device supports run-length encoding (RLE). */
 847         SR_CONF_RLE,
 848
 849         /** The device supports setting trigger slope. */
 850         SR_CONF_TRIGGER_SLOPE,
 851
 852         /** The device supports averaging. */
 853         SR_CONF_AVERAGING,
 854
 855         /**
 856          * The device supports setting number of samples to be
 857          * averaged over.
 858          */
 859         SR_CONF_AVG_SAMPLES,
 860
 861         /** Trigger source. */
 862         SR_CONF_TRIGGER_SOURCE,
 863
 864         /** Horizontal trigger position. */
 865         SR_CONF_HORIZ_TRIGGERPOS,
 866
 867         /** Buffer size. */
 868         SR_CONF_BUFFERSIZE,
 869
 870         /** Time base. */
 871         SR_CONF_TIMEBASE,
 872
 873         /** Filter. */
 874         SR_CONF_FILTER,
 875
 876         /** Volts/div. */
 877         SR_CONF_VDIV,
 878
 879         /** Coupling. */
 880         SR_CONF_COUPLING,
 881
 882         /** Trigger matches. */
 883         SR_CONF_TRIGGER_MATCH,
 884
 885         /** The device supports setting its sample interval, in ms. */
 886         SR_CONF_SAMPLE_INTERVAL,
 887
 888         /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
 889         SR_CONF_NUM_HDIV,
 890
 891         /** Number of vertical divisions, as related to SR_CONF_VDIV. */
 892         SR_CONF_NUM_VDIV,
 893
 894         /** Sound pressure level frequency weighting. */
 895         SR_CONF_SPL_WEIGHT_FREQ,
 896
 897         /** Sound pressure level time weighting. */
 898         SR_CONF_SPL_WEIGHT_TIME,
 899
 900         /** Sound pressure level measurement range. */
 901         SR_CONF_SPL_MEASUREMENT_RANGE,
 902
 903         /** Max hold mode. */
 904         SR_CONF_HOLD_MAX,
 905
 906         /** Min hold mode. */
 907         SR_CONF_HOLD_MIN,
 908
 909         /** Logic low-high threshold range. */
 910         SR_CONF_VOLTAGE_THRESHOLD,
 911
 912         /** The device supports using an external clock. */
 913         SR_CONF_EXTERNAL_CLOCK,
 914
 915         /**
 916          * The device supports swapping channels. Typical this is between
 917          * buffered and unbuffered channels.
 918          */
 919         SR_CONF_SWAP,
 920
 921         /** Center frequency.
 922          * The input signal is downmixed by this frequency before the ADC
 923          * anti-aliasing filter.
 924          */
 925         SR_CONF_CENTER_FREQUENCY,
 926
 927         /** The device supports setting the number of logic channels. */
 928         SR_CONF_NUM_LOGIC_CHANNELS,
 929
 930         /** The device supports setting the number of analog channels. */
 931         SR_CONF_NUM_ANALOG_CHANNELS,
 932
 933         /**
 934          * Current voltage.
 935          * @arg type: double
 936          * @arg get: get measured voltage
 937          */
 938         SR_CONF_VOLTAGE,
 939
 940         /**
 941          * Maximum target voltage.
 942          * @arg type: double
 943          * @arg get: get target voltage
 944          * @arg set: change target voltage
 945          */
 946         SR_CONF_VOLTAGE_TARGET,
 947
 948         /**
 949          * Current current.
 950          * @arg type: double
 951          * @arg get: get measured current
 952          */
 953         SR_CONF_CURRENT,
 954
 955         /**
 956          * Current limit.
 957          * @arg type: double
 958          * @arg get: get current limit
 959          * @arg set: change current limit
 960          */
 961         SR_CONF_CURRENT_LIMIT,
 962
 963         /**
 964          * Enabling/disabling channel.
 965          * @arg type: boolean
 966          * @arg get: @b true if currently enabled
 967          * @arg set: enable/disable
 968          */
 969         SR_CONF_ENABLED,
 970
 971         /**
 972          * Channel configuration.
 973          * @arg type: string
 974          * @arg get: get current setting
 975          * @arg set: change current setting
 976          * @arg list: array of possible values
 977          */
 978         SR_CONF_CHANNEL_CONFIG,
 979
 980         /**
 981          * Over-voltage protection (OVP) feature
 982          * @arg type: boolean
 983          * @arg get: @b true if currently enabled
 984          * @arg set: enable/disable
 985          */
 986         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
 987
 988         /**
 989          * Over-voltage protection (OVP) active
 990          * @arg type: boolean
 991          * @arg get: @b true if device has activated OVP, i.e. the output voltage
 992          *      exceeds the over-voltage protection threshold.
 993          */
 994         SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
 995
 996         /**
 997          * Over-voltage protection (OVP) threshold
 998          * @arg type: double (voltage)
 999          * @arg get: get current threshold
1000          * @arg set: set new threshold
1001          */
1002         SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
1003
1004         /**
1005          * Over-current protection (OCP) feature
1006          * @arg type: boolean
1007          * @arg get: @b true if currently enabled
1008          * @arg set: enable/disable
1009          */
1010         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
1011
1012         /**
1013          * Over-current protection (OCP) active
1014          * @arg type: boolean
1015          * @arg get: @b true if device has activated OCP, i.e. the current current
1016          *      exceeds the over-current protection threshold.
1017          */
1018         SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
1019
1020         /**
1021          * Over-current protection (OCP) threshold
1022          * @arg type: double (current)
1023          * @arg get: get current threshold
1024          * @arg set: set new threshold
1025          */
1026         SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
1027
1028         /** Choice of clock edge for external clock ("r" or "f"). */
1029         SR_CONF_CLOCK_EDGE,
1030
1031         /** Amplitude of a source without strictly-defined MQ. */
1032         SR_CONF_AMPLITUDE,
1033
1034         /**
1035          * Channel regulation
1036          * get: "CV", "CC" or "UR", denoting constant voltage, constant current
1037          *      or unregulated.
1038          *      "CC-" denotes a power supply in current sink mode (e.g. HP 66xxB).
1039          *      "" is used when there is no regulation, e.g. the output is disabled.
1040          */
1041         SR_CONF_REGULATION,
1042
1043         /** Over-temperature protection (OTP) */
1044         SR_CONF_OVER_TEMPERATURE_PROTECTION,
1045
1046         /** Output frequency in Hz. */
1047         SR_CONF_OUTPUT_FREQUENCY,
1048
1049         /** Output frequency target in Hz. */
1050         SR_CONF_OUTPUT_FREQUENCY_TARGET,
1051
1052         /** Measured quantity. */
1053         SR_CONF_MEASURED_QUANTITY,
1054
1055         /** Equivalent circuit model. */
1056         SR_CONF_EQUIV_CIRCUIT_MODEL,
1057
1058         /** Over-temperature protection (OTP) active. */
1059         SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
1060
1061         /** Under-voltage condition. */
1062         SR_CONF_UNDER_VOLTAGE_CONDITION,
1063
1064         /** Under-voltage condition active. */
1065         SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE,
1066
1067         /** Trigger level. */
1068         SR_CONF_TRIGGER_LEVEL,
1069
1070         /** Under-voltage condition threshold. */
1071         SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD,
1072
1073         /**
1074          * Which external clock source to use if the device supports
1075          * multiple external clock channels.
1076          */
1077         SR_CONF_EXTERNAL_CLOCK_SOURCE,
1078
1079         /** Offset of a source without strictly-defined MQ. */
1080         SR_CONF_OFFSET,
1081
1082         /** The device supports setting a pattern for the logic trigger. */
1083         SR_CONF_TRIGGER_PATTERN,
1084
1085         /** High resolution mode. */
1086         SR_CONF_HIGH_RESOLUTION,
1087
1088         /** Peak detection. */
1089         SR_CONF_PEAK_DETECTION,
1090
1091         /** Logic threshold: predefined levels (TTL, ECL, CMOS, etc). */
1092         SR_CONF_LOGIC_THRESHOLD,
1093
1094         /** Logic threshold: custom numerical value. */
1095         SR_CONF_LOGIC_THRESHOLD_CUSTOM,
1096
1097         /** The measurement range of a DMM or the output range of a power supply. */
1098         SR_CONF_RANGE,
1099
1100         /** The number of digits (e.g. for a DMM). */
1101         SR_CONF_DIGITS,
1102
1103         /** Phase of a source signal. */
1104         SR_CONF_PHASE,
1105
1106         /** Duty cycle of a source signal. */
1107         SR_CONF_DUTY_CYCLE,
1108
1109         /**
1110          * Current power.
1111          * @arg type: double
1112          * @arg get: get measured power
1113          */
1114         SR_CONF_POWER,
1115
1116         /**
1117          * Power target.
1118          * @arg type: double
1119          * @arg get: get power target
1120          * @arg set: change power target
1121          */
1122         SR_CONF_POWER_TARGET,
1123
1124         /**
1125          * Resistance target.
1126          * @arg type: double
1127          * @arg get: get resistance target
1128          * @arg set: change resistance target
1129          */
1130         SR_CONF_RESISTANCE_TARGET,
1131
1132         /**
1133          * Over-current protection (OCP) delay
1134          * @arg type: double (time)
1135          * @arg get: get current delay
1136          * @arg set: set new delay
1137          */
1138         SR_CONF_OVER_CURRENT_PROTECTION_DELAY,
1139
1140         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1141
1142         /*--- Special stuff -------------------------------------------------*/
1143
1144         /** Session filename. */
1145         SR_CONF_SESSIONFILE = 40000,
1146
1147         /** The device supports specifying a capturefile to inject. */
1148         SR_CONF_CAPTUREFILE,
1149
1150         /** The device supports specifying the capturefile unit size. */
1151         SR_CONF_CAPTURE_UNITSIZE,
1152
1153         /** Power off the device. */
1154         SR_CONF_POWER_OFF,
1155
1156         /**
1157          * Data source for acquisition. If not present, acquisition from
1158          * the device is always "live", i.e. acquisition starts when the
1159          * frontend asks and the results are sent out as soon as possible.
1160          *
1161          * If present, it indicates that either the device has no live
1162          * acquisition capability (for example a pure data logger), or
1163          * there is a choice. sr_config_list() returns those choices.
1164          *
1165          * In any case if a device has live acquisition capabilities, it
1166          * is always the default.
1167          */
1168         SR_CONF_DATA_SOURCE,
1169
1170         /** The device supports setting a probe factor. */
1171         SR_CONF_PROBE_FACTOR,
1172
1173         /** Number of powerline cycles for ADC integration time. */
1174         SR_CONF_ADC_POWERLINE_CYCLES,
1175
1176         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1177
1178         /*--- Acquisition modes, sample limiting ----------------------------*/
1179
1180         /**
1181          * The device supports setting a sample time limit (how long
1182          * the sample acquisition should run, in ms).
1183          */
1184         SR_CONF_LIMIT_MSEC = 50000,
1185
1186         /**
1187          * The device supports setting a sample number limit (how many
1188          * samples should be acquired).
1189          */
1190         SR_CONF_LIMIT_SAMPLES,
1191
1192         /**
1193          * The device supports setting a frame limit (how many
1194          * frames should be acquired).
1195          */
1196         SR_CONF_LIMIT_FRAMES,
1197
1198         /**
1199          * The device supports continuous sampling. Neither a time limit
1200          * nor a sample number limit has to be supplied, it will just acquire
1201          * samples continuously, until explicitly stopped by a certain command.
1202          */
1203         SR_CONF_CONTINUOUS,
1204
1205         /** The device has internal storage, into which data is logged. This
1206          * starts or stops the internal logging. */
1207         SR_CONF_DATALOG,
1208
1209         /** Device mode for multi-function devices. */
1210         SR_CONF_DEVICE_MODE,
1211
1212         /** Self test mode. */
1213         SR_CONF_TEST_MODE,
1214
1215         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1216 };
1217
1218 /**
1219  * Opaque structure representing a libsigrok device instance.
1220  *
1221  * None of the fields of this structure are meant to be accessed directly.
1222  */
1223 struct sr_dev_inst;
1224
1225 /** Types of device instance, struct sr_dev_inst.type */
1226 enum sr_dev_inst_type {
1227         /** Device instance type for USB devices. */
1228         SR_INST_USB = 10000,
1229         /** Device instance type for serial port devices. */
1230         SR_INST_SERIAL,
1231         /** Device instance type for SCPI devices. */
1232         SR_INST_SCPI,
1233         /** Device-instance type for user-created "devices". */
1234         SR_INST_USER,
1235         /** Device instance type for Modbus devices. */
1236         SR_INST_MODBUS,
1237 };
1238
1239 /** Device instance status, struct sr_dev_inst.status */
1240 enum sr_dev_inst_status {
1241         /** The device instance was not found. */
1242         SR_ST_NOT_FOUND = 10000,
1243         /** The device instance was found, but is still booting. */
1244         SR_ST_INITIALIZING,
1245         /** The device instance is live, but not in use. */
1246         SR_ST_INACTIVE,
1247         /** The device instance is actively in use in a session. */
1248         SR_ST_ACTIVE,
1249         /** The device is winding down its session. */
1250         SR_ST_STOPPING,
1251 };
1252
1253 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1254 struct sr_dev_driver {
1255         /* Driver-specific */
1256         /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1257         const char *name;
1258         /** Long name. Verbose driver name shown to user. */
1259         const char *longname;
1260         /** API version (currently 1).  */
1261         int api_version;
1262         /** Called when driver is loaded, e.g. program startup. */
1263         int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1264         /** Called before driver is unloaded.
1265          *  Driver must free all resources held by it. */
1266         int (*cleanup) (const struct sr_dev_driver *driver);
1267         /** Scan for devices. Driver should do all initialisation required.
1268          *  Can be called several times, e.g. with different port options.
1269          *  @retval NULL Error or no devices found.
1270          *  @retval other GSList of a struct sr_dev_inst for each device.
1271          *                Must be freed by caller!
1272          */
1273         GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1274         /** Get list of device instances the driver knows about.
1275          *  @returns NULL or GSList of a struct sr_dev_inst for each device.
1276          *           Must not be freed by caller!
1277          */
1278         GSList *(*dev_list) (const struct sr_dev_driver *driver);
1279         /** Clear list of devices the driver knows about. */
1280         int (*dev_clear) (const struct sr_dev_driver *driver);
1281         /** Query value of a configuration key in driver or given device instance.
1282          *  @see sr_config_get().
1283          */
1284         int (*config_get) (uint32_t key, GVariant **data,
1285                         const struct sr_dev_inst *sdi,
1286                         const struct sr_channel_group *cg);
1287         /** Set value of a configuration key in driver or a given device instance.
1288          *  @see sr_config_set(). */
1289         int (*config_set) (uint32_t key, GVariant *data,
1290                         const struct sr_dev_inst *sdi,
1291                         const struct sr_channel_group *cg);
1292         /** Channel status change.
1293          *  @see sr_dev_channel_enable(). */
1294         int (*config_channel_set) (const struct sr_dev_inst *sdi,
1295                         struct sr_channel *ch, unsigned int changes);
1296         /** Apply configuration settings to the device hardware.
1297          *  @see sr_config_commit().*/
1298         int (*config_commit) (const struct sr_dev_inst *sdi);
1299         /** List all possible values for a configuration key in a device instance.
1300          *  @see sr_config_list().
1301          */
1302         int (*config_list) (uint32_t key, GVariant **data,
1303                         const struct sr_dev_inst *sdi,
1304                         const struct sr_channel_group *cg);
1305
1306         /* Device-specific */
1307         /** Open device */
1308         int (*dev_open) (struct sr_dev_inst *sdi);
1309         /** Close device */
1310         int (*dev_close) (struct sr_dev_inst *sdi);
1311         /** Begin data acquisition on the specified device. */
1312         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi);
1313         /** End data acquisition on the specified device. */
1314         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi);
1315
1316         /* Dynamic */
1317         /** Device driver context, considered private. Initialized by init(). */
1318         void *context;
1319 };
1320
1321 /** Serial port descriptor. */
1322 struct sr_serial_port {
1323         /** The OS dependent name of the serial port. */
1324         char *name;
1325         /** An end user friendly description for the serial port. */
1326         char *description;
1327 };
1328
1329 #include <libsigrok/proto.h>
1330 #include <libsigrok/version.h>
1331
1332 #ifdef __cplusplus
1333 }
1334 #endif
1335
1336 #endif