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