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          * or number of non-significant digits before the decimal point if
 534          * negative (refers to the value we actually read on the wire).
 535          */
 536         int8_t digits;
 537         gboolean is_digits_decimal;
 538         struct sr_rational scale;
 539         struct sr_rational offset;
 540 };
 541
 542 struct sr_analog_meaning {
 543         enum sr_mq mq;
 544         enum sr_unit unit;
 545         enum sr_mqflag mqflags;
 546         GSList *channels;
 547 };
 548
 549 struct sr_analog_spec {
 550         /**
 551          * Number of significant digits after the decimal point if positive,
 552          * or number of non-significant digits before the decimal point if
 553          * negative (refers to vendor specifications/datasheet or actual
 554          * device display).
 555          */
 556         int8_t spec_digits;
 557 };
 558
 559 /** Generic option struct used by various subsystems. */
 560 struct sr_option {
 561         /* Short name suitable for commandline usage, [a-z0-9-]. */
 562         const char *id;
 563         /* Short name suitable for GUI usage, can contain UTF-8. */
 564         const char *name;
 565         /* Description of the option, in a sentence. */
 566         const char *desc;
 567         /* Default value for this option. */
 568         GVariant *def;
 569         /* List of possible values, if this is an option with few values. */
 570         GSList *values;
 571 };
 572
 573 /** Resource type.
 574  * @since 0.4.0
 575  */
 576 enum sr_resource_type {
 577         SR_RESOURCE_FIRMWARE = 1,
 578 };
 579
 580 /** Resource descriptor.
 581  * @since 0.4.0
 582  */
 583 struct sr_resource {
 584         /** Size of resource in bytes; set by resource open callback. */
 585         uint64_t size;
 586         /** File handle or equivalent; set by resource open callback. */
 587         void *handle;
 588         /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
 589         int type;
 590 };
 591
 592 /** Output module flags. */
 593 enum sr_output_flag {
 594         /** If set, this output module writes the output itself. */
 595         SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
 596 };
 597
 598 struct sr_input;
 599 struct sr_input_module;
 600 struct sr_output;
 601 struct sr_output_module;
 602 struct sr_transform;
 603 struct sr_transform_module;
 604
 605 /** Constants for channel type. */
 606 enum sr_channeltype {
 607         /** Channel type is logic channel. */
 608         SR_CHANNEL_LOGIC = 10000,
 609         /** Channel type is analog channel. */
 610         SR_CHANNEL_ANALOG,
 611 };
 612
 613 /** Information on single channel. */
 614 struct sr_channel {
 615         /** The device this channel is attached to. */
 616         struct sr_dev_inst *sdi;
 617         /** The index of this channel, starting at 0. Logic channels will
 618          * be encoded according to this index in SR_DF_LOGIC packets. */
 619         int index;
 620         /** Channel type (SR_CHANNEL_LOGIC, ...) */
 621         int type;
 622         /** Is this channel enabled? */
 623         gboolean enabled;
 624         /** Name of channel. */
 625         char *name;
 626         /** Private data for driver use. */
 627         void *priv;
 628 };
 629
 630 /** Structure for groups of channels that have common properties. */
 631 struct sr_channel_group {
 632         /** Name of the channel group. */
 633         char *name;
 634         /** List of sr_channel structs of the channels belonging to this group. */
 635         GSList *channels;
 636         /** Private data for driver use. */
 637         void *priv;
 638 };
 639
 640 /** Used for setting or getting value of a config item. */
 641 struct sr_config {
 642         /** Config key like SR_CONF_CONN, etc. */
 643         uint32_t key;
 644         /** Key-specific data. */
 645         GVariant *data;
 646 };
 647
 648 enum sr_keytype {
 649         SR_KEY_CONFIG,
 650         SR_KEY_MQ,
 651         SR_KEY_MQFLAGS,
 652 };
 653
 654 /** Information about a key. */
 655 struct sr_key_info {
 656         /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
 657         uint32_t key;
 658         /** Data type like SR_T_STRING, etc if applicable. */
 659         int datatype;
 660         /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
 661         const char *id;
 662         /** Full capitalized name, e.g. "Serial communication". */
 663         const char *name;
 664         /** Verbose description (unused currently). */
 665         const char *description;
 666 };
 667
 668 /** Configuration capabilities. */
 669 enum sr_configcap {
 670         /** Value can be read. */
 671         SR_CONF_GET = (1UL << 31),
 672         /** Value can be written. */
 673         SR_CONF_SET = (1UL << 30),
 674         /** Possible values can be enumerated. */
 675         SR_CONF_LIST = (1UL << 29),
 676 };
 677
 678 /** Configuration keys */
 679 enum sr_configkey {
 680         /*--- Device classes ------------------------------------------------*/
 681
 682         /** The device can act as logic analyzer. */
 683         SR_CONF_LOGIC_ANALYZER = 10000,
 684
 685         /** The device can act as an oscilloscope. */
 686         SR_CONF_OSCILLOSCOPE,
 687
 688         /** The device can act as a multimeter. */
 689         SR_CONF_MULTIMETER,
 690
 691         /** The device is a demo device. */
 692         SR_CONF_DEMO_DEV,
 693
 694         /** The device can act as a sound level meter. */
 695         SR_CONF_SOUNDLEVELMETER,
 696
 697         /** The device can measure temperature. */
 698         SR_CONF_THERMOMETER,
 699
 700         /** The device can measure humidity. */
 701         SR_CONF_HYGROMETER,
 702
 703         /** The device can measure energy consumption. */
 704         SR_CONF_ENERGYMETER,
 705
 706         /** The device can act as a signal demodulator. */
 707         SR_CONF_DEMODULATOR,
 708
 709         /** The device can act as a programmable power supply. */
 710         SR_CONF_POWER_SUPPLY,
 711
 712         /** The device can act as an LCR meter. */
 713         SR_CONF_LCRMETER,
 714
 715         /** The device can act as an electronic load. */
 716         SR_CONF_ELECTRONIC_LOAD,
 717
 718         /** The device can act as a scale. */
 719         SR_CONF_SCALE,
 720
 721         /** The device can act as a function generator. */
 722         SR_CONF_SIGNAL_GENERATOR,
 723
 724         /** The device can measure power. */
 725         SR_CONF_POWERMETER,
 726
 727         /**
 728          * The device can switch between multiple sources, e.g. a relay actuator
 729          * or multiplexer.
 730          */
 731         SR_CONF_MULTIPLEXER,
 732
 733         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 734
 735         /*--- Driver scan options -------------------------------------------*/
 736
 737         /**
 738          * Specification on how to connect to a device.
 739          *
 740          * In combination with SR_CONF_SERIALCOMM, this is a serial port in
 741          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 742          * Otherwise this specifies a USB device, either in the form of
 743          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 744          * @verbatim <vendorid>.<productid> @endverbatim
 745          * (hexadecimal, e.g. 1d6b.0001).
 746          */
 747         SR_CONF_CONN = 20000,
 748
 749         /**
 750          * Serial communication specification, in the form:
 751          *
 752          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 753          *
 754          * Example: 9600/8n1
 755          *
 756          * The string may also be followed by one or more special settings,
 757          * in the form "/key=value". Supported keys and their values are:
 758          *
 759          * rts    0,1    set the port's RTS pin to low or high
 760          * dtr    0,1    set the port's DTR pin to low or high
 761          * flow   0      no flow control
 762          *        1      hardware-based (RTS/CTS) flow control
 763          *        2      software-based (XON/XOFF) flow control
 764          *
 765          * This is always an optional parameter, since a driver typically
 766          * knows the speed at which the device wants to communicate.
 767          */
 768         SR_CONF_SERIALCOMM,
 769
 770         /**
 771          * Modbus slave address specification.
 772          *
 773          * This is always an optional parameter, since a driver typically
 774          * knows the default slave address of the device.
 775          */
 776         SR_CONF_MODBUSADDR,
 777
 778         /**
 779          * User specified forced driver attachment to unknown devices.
 780          *
 781          * By design the interpretation of the string depends on the
 782          * specific driver. It typically would be either a replacement
 783          * '*IDN?' response value, or a sub-driver name. But could also
 784          * be anything else and totally arbitrary.
 785          */
 786         SR_CONF_FORCE_DETECT,
 787
 788         /**
 789          * Override builtin probe names from user specs.
 790          *
 791          * Users may want to override the names which are assigned to
 792          * probes during scan (these usually match the vendor's labels
 793          * on the device). This avoids the interactive tedium of
 794          * changing channel names after device creation and before
 795          * protocol decoder attachment. Think of IEEE488 recorders or
 796          * parallel computer bus loggers. The scan option eliminates
 797          * the issue of looking up previously assigned names before
 798          * renaming a channel (see sigrok-cli -C), which depends on
 799          * the device as well as the application, and is undesirable.
 800          * The scan option is limited to those drivers which implement
 801          * support for it, but works identically across those drivers.
 802          *
 803          * The value is a string, either a comma separated list of
 804          * probe names, or an alias for a typical set of names.
 805          */
 806         SR_CONF_PROBE_NAMES,
 807
 808         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 809
 810         /*--- Device (or channel group) configuration -----------------------*/
 811
 812         /** The device supports setting its samplerate, in Hz. */
 813         SR_CONF_SAMPLERATE = 30000,
 814
 815         /** The device supports setting a pre/post-trigger capture ratio. */
 816         SR_CONF_CAPTURE_RATIO,
 817
 818         /** The device supports setting a pattern (pattern generator mode). */
 819         SR_CONF_PATTERN_MODE,
 820
 821         /** The device supports run-length encoding (RLE). */
 822         SR_CONF_RLE,
 823
 824         /** The device supports setting trigger slope. */
 825         SR_CONF_TRIGGER_SLOPE,
 826
 827         /** The device supports averaging. */
 828         SR_CONF_AVERAGING,
 829
 830         /**
 831          * The device supports setting number of samples to be
 832          * averaged over.
 833          */
 834         SR_CONF_AVG_SAMPLES,
 835
 836         /** Trigger source. */
 837         SR_CONF_TRIGGER_SOURCE,
 838
 839         /** Horizontal trigger position. */
 840         SR_CONF_HORIZ_TRIGGERPOS,
 841
 842         /** Buffer size. */
 843         SR_CONF_BUFFERSIZE,
 844
 845         /** Time base. */
 846         SR_CONF_TIMEBASE,
 847
 848         /** Filter. */
 849         SR_CONF_FILTER,
 850
 851         /** Volts/div. */
 852         SR_CONF_VDIV,
 853
 854         /** Coupling. */
 855         SR_CONF_COUPLING,
 856
 857         /** Trigger matches. */
 858         SR_CONF_TRIGGER_MATCH,
 859
 860         /** The device supports setting its sample interval, in ms. */
 861         SR_CONF_SAMPLE_INTERVAL,
 862
 863         /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
 864         SR_CONF_NUM_HDIV,
 865
 866         /** Number of vertical divisions, as related to SR_CONF_VDIV. */
 867         SR_CONF_NUM_VDIV,
 868
 869         /** Sound pressure level frequency weighting. */
 870         SR_CONF_SPL_WEIGHT_FREQ,
 871
 872         /** Sound pressure level time weighting. */
 873         SR_CONF_SPL_WEIGHT_TIME,
 874
 875         /** Sound pressure level measurement range. */
 876         SR_CONF_SPL_MEASUREMENT_RANGE,
 877
 878         /** Max hold mode. */
 879         SR_CONF_HOLD_MAX,
 880
 881         /** Min hold mode. */
 882         SR_CONF_HOLD_MIN,
 883
 884         /** Logic low-high threshold range. */
 885         SR_CONF_VOLTAGE_THRESHOLD,
 886
 887         /** The device supports using an external clock. */
 888         SR_CONF_EXTERNAL_CLOCK,
 889
 890         /**
 891          * The device supports swapping channels. Typical this is between
 892          * buffered and unbuffered channels.
 893          */
 894         SR_CONF_SWAP,
 895
 896         /** Center frequency.
 897          * The input signal is downmixed by this frequency before the ADC
 898          * anti-aliasing filter.
 899          */
 900         SR_CONF_CENTER_FREQUENCY,
 901
 902         /** The device supports setting the number of logic channels. */
 903         SR_CONF_NUM_LOGIC_CHANNELS,
 904
 905         /** The device supports setting the number of analog channels. */
 906         SR_CONF_NUM_ANALOG_CHANNELS,
 907
 908         /**
 909          * Current voltage.
 910          * @arg type: double
 911          * @arg get: get measured voltage
 912          */
 913         SR_CONF_VOLTAGE,
 914
 915         /**
 916          * Maximum target voltage.
 917          * @arg type: double
 918          * @arg get: get target voltage
 919          * @arg set: change target voltage
 920          */
 921         SR_CONF_VOLTAGE_TARGET,
 922
 923         /**
 924          * Current current.
 925          * @arg type: double
 926          * @arg get: get measured current
 927          */
 928         SR_CONF_CURRENT,
 929
 930         /**
 931          * Current limit.
 932          * @arg type: double
 933          * @arg get: get current limit
 934          * @arg set: change current limit
 935          */
 936         SR_CONF_CURRENT_LIMIT,
 937
 938         /**
 939          * Enabling/disabling channel.
 940          * @arg type: boolean
 941          * @arg get: @b true if currently enabled
 942          * @arg set: enable/disable
 943          */
 944         SR_CONF_ENABLED,
 945
 946         /**
 947          * Channel configuration.
 948          * @arg type: string
 949          * @arg get: get current setting
 950          * @arg set: change current setting
 951          * @arg list: array of possible values
 952          */
 953         SR_CONF_CHANNEL_CONFIG,
 954
 955         /**
 956          * Over-voltage protection (OVP) feature
 957          * @arg type: boolean
 958          * @arg get: @b true if currently enabled
 959          * @arg set: enable/disable
 960          */
 961         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
 962
 963         /**
 964          * Over-voltage protection (OVP) active
 965          * @arg type: boolean
 966          * @arg get: @b true if device has activated OVP, i.e. the output voltage
 967          *      exceeds the over-voltage protection threshold.
 968          */
 969         SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
 970
 971         /**
 972          * Over-voltage protection (OVP) threshold
 973          * @arg type: double (voltage)
 974          * @arg get: get current threshold
 975          * @arg set: set new threshold
 976          */
 977         SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
 978
 979         /**
 980          * Over-current protection (OCP) feature
 981          * @arg type: boolean
 982          * @arg get: @b true if currently enabled
 983          * @arg set: enable/disable
 984          */
 985         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
 986
 987         /**
 988          * Over-current protection (OCP) active
 989          * @arg type: boolean
 990          * @arg get: @b true if device has activated OCP, i.e. the current current
 991          *      exceeds the over-current protection threshold.
 992          */
 993         SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
 994
 995         /**
 996          * Over-current protection (OCP) threshold
 997          * @arg type: double (current)
 998          * @arg get: get current threshold
 999          * @arg set: set new threshold
1000          */
1001         SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
1002
1003         /** Choice of clock edge for external clock ("r" or "f"). */
1004         SR_CONF_CLOCK_EDGE,
1005
1006         /** Amplitude of a source without strictly-defined MQ. */
1007         SR_CONF_AMPLITUDE,
1008
1009         /**
1010          * Channel regulation
1011          * get: "CV", "CC" or "UR", denoting constant voltage, constant current
1012          *      or unregulated.
1013          *      "CC-" denotes a power supply in current sink mode (e.g. HP 66xxB).
1014          *      "" is used when there is no regulation, e.g. the output is disabled.
1015          */
1016         SR_CONF_REGULATION,
1017
1018         /** Over-temperature protection (OTP) */
1019         SR_CONF_OVER_TEMPERATURE_PROTECTION,
1020
1021         /** Output frequency in Hz. */
1022         SR_CONF_OUTPUT_FREQUENCY,
1023
1024         /** Output frequency target in Hz. */
1025         SR_CONF_OUTPUT_FREQUENCY_TARGET,
1026
1027         /** Measured quantity. */
1028         SR_CONF_MEASURED_QUANTITY,
1029
1030         /** Equivalent circuit model. */
1031         SR_CONF_EQUIV_CIRCUIT_MODEL,
1032
1033         /** Over-temperature protection (OTP) active. */
1034         SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
1035
1036         /** Under-voltage condition. */
1037         SR_CONF_UNDER_VOLTAGE_CONDITION,
1038
1039         /** Under-voltage condition active. */
1040         SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE,
1041
1042         /** Trigger level. */
1043         SR_CONF_TRIGGER_LEVEL,
1044
1045         /** Under-voltage condition threshold. */
1046         SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD,
1047
1048         /**
1049          * Which external clock source to use if the device supports
1050          * multiple external clock channels.
1051          */
1052         SR_CONF_EXTERNAL_CLOCK_SOURCE,
1053
1054         /** Offset of a source without strictly-defined MQ. */
1055         SR_CONF_OFFSET,
1056
1057         /** The device supports setting a pattern for the logic trigger. */
1058         SR_CONF_TRIGGER_PATTERN,
1059
1060         /** High resolution mode. */
1061         SR_CONF_HIGH_RESOLUTION,
1062
1063         /** Peak detection. */
1064         SR_CONF_PEAK_DETECTION,
1065
1066         /** Logic threshold: predefined levels (TTL, ECL, CMOS, etc). */
1067         SR_CONF_LOGIC_THRESHOLD,
1068
1069         /** Logic threshold: custom numerical value. */
1070         SR_CONF_LOGIC_THRESHOLD_CUSTOM,
1071
1072         /** The measurement range of a DMM or the output range of a power supply. */
1073         SR_CONF_RANGE,
1074
1075         /** The number of digits (e.g. for a DMM). */
1076         SR_CONF_DIGITS,
1077
1078         /** Phase of a source signal. */
1079         SR_CONF_PHASE,
1080
1081         /** Duty cycle of a source signal. */
1082         SR_CONF_DUTY_CYCLE,
1083
1084         /**
1085          * Current power.
1086          * @arg type: double
1087          * @arg get: get measured power
1088          */
1089         SR_CONF_POWER,
1090
1091         /**
1092          * Power target.
1093          * @arg type: double
1094          * @arg get: get power target
1095          * @arg set: change power target
1096          */
1097         SR_CONF_POWER_TARGET,
1098
1099         /**
1100          * Resistance target.
1101          * @arg type: double
1102          * @arg get: get resistance target
1103          * @arg set: change resistance target
1104          */
1105         SR_CONF_RESISTANCE_TARGET,
1106
1107         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1108
1109         /*--- Special stuff -------------------------------------------------*/
1110
1111         /** Session filename. */
1112         SR_CONF_SESSIONFILE = 40000,
1113
1114         /** The device supports specifying a capturefile to inject. */
1115         SR_CONF_CAPTUREFILE,
1116
1117         /** The device supports specifying the capturefile unit size. */
1118         SR_CONF_CAPTURE_UNITSIZE,
1119
1120         /** Power off the device. */
1121         SR_CONF_POWER_OFF,
1122
1123         /**
1124          * Data source for acquisition. If not present, acquisition from
1125          * the device is always "live", i.e. acquisition starts when the
1126          * frontend asks and the results are sent out as soon as possible.
1127          *
1128          * If present, it indicates that either the device has no live
1129          * acquisition capability (for example a pure data logger), or
1130          * there is a choice. sr_config_list() returns those choices.
1131          *
1132          * In any case if a device has live acquisition capabilities, it
1133          * is always the default.
1134          */
1135         SR_CONF_DATA_SOURCE,
1136
1137         /** The device supports setting a probe factor. */
1138         SR_CONF_PROBE_FACTOR,
1139
1140         /** Number of powerline cycles for ADC integration time. */
1141         SR_CONF_ADC_POWERLINE_CYCLES,
1142
1143         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1144
1145         /*--- Acquisition modes, sample limiting ----------------------------*/
1146
1147         /**
1148          * The device supports setting a sample time limit (how long
1149          * the sample acquisition should run, in ms).
1150          */
1151         SR_CONF_LIMIT_MSEC = 50000,
1152
1153         /**
1154          * The device supports setting a sample number limit (how many
1155          * samples should be acquired).
1156          */
1157         SR_CONF_LIMIT_SAMPLES,
1158
1159         /**
1160          * The device supports setting a frame limit (how many
1161          * frames should be acquired).
1162          */
1163         SR_CONF_LIMIT_FRAMES,
1164
1165         /**
1166          * The device supports continuous sampling. Neither a time limit
1167          * nor a sample number limit has to be supplied, it will just acquire
1168          * samples continuously, until explicitly stopped by a certain command.
1169          */
1170         SR_CONF_CONTINUOUS,
1171
1172         /** The device has internal storage, into which data is logged. This
1173          * starts or stops the internal logging. */
1174         SR_CONF_DATALOG,
1175
1176         /** Device mode for multi-function devices. */
1177         SR_CONF_DEVICE_MODE,
1178
1179         /** Self test mode. */
1180         SR_CONF_TEST_MODE,
1181
1182         /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1183 };
1184
1185 /**
1186  * Opaque structure representing a libsigrok device instance.
1187  *
1188  * None of the fields of this structure are meant to be accessed directly.
1189  */
1190 struct sr_dev_inst;
1191
1192 /** Types of device instance, struct sr_dev_inst.type */
1193 enum sr_dev_inst_type {
1194         /** Device instance type for USB devices. */
1195         SR_INST_USB = 10000,
1196         /** Device instance type for serial port devices. */
1197         SR_INST_SERIAL,
1198         /** Device instance type for SCPI devices. */
1199         SR_INST_SCPI,
1200         /** Device-instance type for user-created "devices". */
1201         SR_INST_USER,
1202         /** Device instance type for Modbus devices. */
1203         SR_INST_MODBUS,
1204 };
1205
1206 /** Device instance status, struct sr_dev_inst.status */
1207 enum sr_dev_inst_status {
1208         /** The device instance was not found. */
1209         SR_ST_NOT_FOUND = 10000,
1210         /** The device instance was found, but is still booting. */
1211         SR_ST_INITIALIZING,
1212         /** The device instance is live, but not in use. */
1213         SR_ST_INACTIVE,
1214         /** The device instance is actively in use in a session. */
1215         SR_ST_ACTIVE,
1216         /** The device is winding down its session. */
1217         SR_ST_STOPPING,
1218 };
1219
1220 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1221 struct sr_dev_driver {
1222         /* Driver-specific */
1223         /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1224         const char *name;
1225         /** Long name. Verbose driver name shown to user. */
1226         const char *longname;
1227         /** API version (currently 1).  */
1228         int api_version;
1229         /** Called when driver is loaded, e.g. program startup. */
1230         int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1231         /** Called before driver is unloaded.
1232          *  Driver must free all resources held by it. */
1233         int (*cleanup) (const struct sr_dev_driver *driver);
1234         /** Scan for devices. Driver should do all initialisation required.
1235          *  Can be called several times, e.g. with different port options.
1236          *  @retval NULL Error or no devices found.
1237          *  @retval other GSList of a struct sr_dev_inst for each device.
1238          *                Must be freed by caller!
1239          */
1240         GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1241         /** Get list of device instances the driver knows about.
1242          *  @returns NULL or GSList of a struct sr_dev_inst for each device.
1243          *           Must not be freed by caller!
1244          */
1245         GSList *(*dev_list) (const struct sr_dev_driver *driver);
1246         /** Clear list of devices the driver knows about. */
1247         int (*dev_clear) (const struct sr_dev_driver *driver);
1248         /** Query value of a configuration key in driver or given device instance.
1249          *  @see sr_config_get().
1250          */
1251         int (*config_get) (uint32_t key, GVariant **data,
1252                         const struct sr_dev_inst *sdi,
1253                         const struct sr_channel_group *cg);
1254         /** Set value of a configuration key in driver or a given device instance.
1255          *  @see sr_config_set(). */
1256         int (*config_set) (uint32_t key, GVariant *data,
1257                         const struct sr_dev_inst *sdi,
1258                         const struct sr_channel_group *cg);
1259         /** Channel status change.
1260          *  @see sr_dev_channel_enable(). */
1261         int (*config_channel_set) (const struct sr_dev_inst *sdi,
1262                         struct sr_channel *ch, unsigned int changes);
1263         /** Apply configuration settings to the device hardware.
1264          *  @see sr_config_commit().*/
1265         int (*config_commit) (const struct sr_dev_inst *sdi);
1266         /** List all possible values for a configuration key in a device instance.
1267          *  @see sr_config_list().
1268          */
1269         int (*config_list) (uint32_t key, GVariant **data,
1270                         const struct sr_dev_inst *sdi,
1271                         const struct sr_channel_group *cg);
1272
1273         /* Device-specific */
1274         /** Open device */
1275         int (*dev_open) (struct sr_dev_inst *sdi);
1276         /** Close device */
1277         int (*dev_close) (struct sr_dev_inst *sdi);
1278         /** Begin data acquisition on the specified device. */
1279         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi);
1280         /** End data acquisition on the specified device. */
1281         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi);
1282
1283         /* Dynamic */
1284         /** Device driver context, considered private. Initialized by init(). */
1285         void *context;
1286 };
1287
1288 /** Serial port descriptor. */
1289 struct sr_serial_port {
1290         /** The OS dependent name of the serial port. */
1291         char *name;
1292         /** An end user friendly description for the serial port. */
1293         char *description;
1294 };
1295
1296 #include <libsigrok/proto.h>
1297 #include <libsigrok/version.h>
1298
1299 #ifdef __cplusplus
1300 }
1301 #endif
1302
1303 #endif