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