include/libsigrok/libsigrok.h

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