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