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