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