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