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