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
  78         /*
  79          * Note: When adding entries here, don't forget to also update the
  80          * sr_strerror() and sr_strerror_name() functions in error.c.
  81          */
  82 };
  83
  84 #define SR_MAX_CHANNELNAME_LEN 32
  85
  86 /* Handy little macros */
  87 #define SR_HZ(n)  (n)
  88 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
  89 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
  90 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
  91
  92 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
  93
  94 /** libsigrok loglevels. */
  95 enum sr_loglevel {
  96         SR_LOG_NONE = 0, /**< Output no messages at all. */
  97         SR_LOG_ERR  = 1, /**< Output error messages. */
  98         SR_LOG_WARN = 2, /**< Output warnings. */
  99         SR_LOG_INFO = 3, /**< Output informational messages. */
 100         SR_LOG_DBG  = 4, /**< Output debug messages. */
 101         SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
 102 };
 103
 104 /*
 105  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
 106  *
 107  * Variables and functions marked 'static' are private already and don't
 108  * need SR_PRIV. However, functions which are not static (because they need
 109  * to be used in other libsigrok-internal files) but are also not meant to
 110  * be part of the public libsigrok API, must use SR_PRIV.
 111  *
 112  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 113  *
 114  * This feature is not available on MinGW/Windows, as it is a feature of
 115  * ELF files and MinGW/Windows uses PE files.
 116  *
 117  * Details: http://gcc.gnu.org/wiki/Visibility
 118  */
 119
 120 /* Marks public libsigrok API symbols. */
 121 #ifndef _WIN32
 122 #define SR_API __attribute__((visibility("default")))
 123 #else
 124 #define SR_API
 125 #endif
 126
 127 /* Marks private, non-public libsigrok symbols (not part of the API). */
 128 #ifndef _WIN32
 129 #define SR_PRIV __attribute__((visibility("hidden")))
 130 #else
 131 #define SR_PRIV
 132 #endif
 133
 134 /** Type definition for callback function for data reception. */
 135 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
 136
 137 /** Data types used by sr_config_info(). */
 138 enum sr_datatype {
 139         SR_T_UINT64 = 10000,
 140         SR_T_STRING,
 141         SR_T_BOOL,
 142         SR_T_FLOAT,
 143         SR_T_RATIONAL_PERIOD,
 144         SR_T_RATIONAL_VOLT,
 145         SR_T_KEYVALUE,
 146         SR_T_UINT64_RANGE,
 147         SR_T_DOUBLE_RANGE,
 148         SR_T_INT32,
 149 };
 150
 151 /** Value for sr_datafeed_packet.type. */
 152 enum sr_packettype {
 153         /** Payload is sr_datafeed_header. */
 154         SR_DF_HEADER = 10000,
 155         /** End of stream (no further data). */
 156         SR_DF_END,
 157         /** Payload is struct sr_datafeed_meta */
 158         SR_DF_META,
 159         /** The trigger matched at this point in the data feed. No payload. */
 160         SR_DF_TRIGGER,
 161         /** Payload is struct sr_datafeed_logic. */
 162         SR_DF_LOGIC,
 163         /** Payload is struct sr_datafeed_analog. */
 164         SR_DF_ANALOG,
 165         /** Beginning of frame. No payload. */
 166         SR_DF_FRAME_BEGIN,
 167         /** End of frame. No payload. */
 168         SR_DF_FRAME_END,
 169 };
 170
 171 /** Measured quantity, sr_datafeed_analog.mq. */
 172 enum sr_mq {
 173         SR_MQ_VOLTAGE = 10000,
 174         SR_MQ_CURRENT,
 175         SR_MQ_RESISTANCE,
 176         SR_MQ_CAPACITANCE,
 177         SR_MQ_TEMPERATURE,
 178         SR_MQ_FREQUENCY,
 179         /** Duty cycle, e.g. on/off ratio. */
 180         SR_MQ_DUTY_CYCLE,
 181         /** Continuity test. */
 182         SR_MQ_CONTINUITY,
 183         SR_MQ_PULSE_WIDTH,
 184         SR_MQ_CONDUCTANCE,
 185         /** Electrical power, usually in W, or dBm. */
 186         SR_MQ_POWER,
 187         /** Gain (a transistor's gain, or hFE, for example). */
 188         SR_MQ_GAIN,
 189         /** Logarithmic representation of sound pressure relative to a
 190          * reference value. */
 191         SR_MQ_SOUND_PRESSURE_LEVEL,
 192         /** Carbon monoxide level */
 193         SR_MQ_CARBON_MONOXIDE,
 194         /** Humidity */
 195         SR_MQ_RELATIVE_HUMIDITY,
 196         /** Time */
 197         SR_MQ_TIME,
 198         /** Wind speed */
 199         SR_MQ_WIND_SPEED,
 200         /** Pressure */
 201         SR_MQ_PRESSURE,
 202 };
 203
 204 /** Unit of measured quantity, sr_datafeed_analog.unit. */
 205 enum sr_unit {
 206         /** Volt */
 207         SR_UNIT_VOLT = 10000,
 208         /** Ampere (current). */
 209         SR_UNIT_AMPERE,
 210         /** Ohm (resistance). */
 211         SR_UNIT_OHM,
 212         /** Farad (capacity). */
 213         SR_UNIT_FARAD,
 214         /** Kelvin (temperature). */
 215         SR_UNIT_KELVIN,
 216         /** Degrees Celsius (temperature). */
 217         SR_UNIT_CELSIUS,
 218         /** Degrees Fahrenheit (temperature). */
 219         SR_UNIT_FAHRENHEIT,
 220         /** Hertz (frequency, 1/s, [Hz]). */
 221         SR_UNIT_HERTZ,
 222         /** Percent value. */
 223         SR_UNIT_PERCENTAGE,
 224         /** Boolean value. */
 225         SR_UNIT_BOOLEAN,
 226         /** Time in seconds. */
 227         SR_UNIT_SECOND,
 228         /** Unit of conductance, the inverse of resistance. */
 229         SR_UNIT_SIEMENS,
 230         /**
 231          * An absolute measurement of power, in decibels, referenced to
 232          * 1 milliwatt (dBu).
 233          */
 234         SR_UNIT_DECIBEL_MW,
 235         /** Voltage in decibel, referenced to 1 volt (dBV). */
 236         SR_UNIT_DECIBEL_VOLT,
 237         /**
 238          * Measurements that intrinsically do not have units attached, such
 239          * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
 240          * a unitless quantity, for example.
 241          */
 242         SR_UNIT_UNITLESS,
 243         /** Sound pressure level, in decibels, relative to 20 micropascals. */
 244         SR_UNIT_DECIBEL_SPL,
 245         /**
 246          * Normalized (0 to 1) concentration of a substance or compound with 0
 247          * representing a concentration of 0%, and 1 being 100%. This is
 248          * represented as the fraction of number of particles of the substance.
 249          */
 250         SR_UNIT_CONCENTRATION,
 251         /** Revolutions per minute. */
 252         SR_UNIT_REVOLUTIONS_PER_MINUTE,
 253         /** Apparent power [VA]. */
 254         SR_UNIT_VOLT_AMPERE,
 255         /** Real power [W]. */
 256         SR_UNIT_WATT,
 257         /** Consumption [Wh]. */
 258         SR_UNIT_WATT_HOUR,
 259         /** Wind speed in meters per second. */
 260         SR_UNIT_METER_SECOND,
 261         /** Pressure in hectopascal */
 262         SR_UNIT_HECTOPASCAL,
 263         /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
 264         SR_UNIT_HUMIDITY_293K,
 265 };
 266
 267 /** Values for sr_datafeed_analog.flags. */
 268 enum sr_mqflag {
 269         /** Voltage measurement is alternating current (AC). */
 270         SR_MQFLAG_AC = 0x01,
 271         /** Voltage measurement is direct current (DC). */
 272         SR_MQFLAG_DC = 0x02,
 273         /** This is a true RMS measurement. */
 274         SR_MQFLAG_RMS = 0x04,
 275         /** Value is voltage drop across a diode, or NAN. */
 276         SR_MQFLAG_DIODE = 0x08,
 277         /** Device is in "hold" mode (repeating the last measurement). */
 278         SR_MQFLAG_HOLD = 0x10,
 279         /** Device is in "max" mode, only updating upon a new max value. */
 280         SR_MQFLAG_MAX = 0x20,
 281         /** Device is in "min" mode, only updating upon a new min value. */
 282         SR_MQFLAG_MIN = 0x40,
 283         /** Device is in autoranging mode. */
 284         SR_MQFLAG_AUTORANGE = 0x80,
 285         /** Device is in relative mode. */
 286         SR_MQFLAG_RELATIVE = 0x100,
 287         /** Sound pressure level is A-weighted in the frequency domain,
 288          * according to IEC 61672:2003. */
 289         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
 290         /** Sound pressure level is C-weighted in the frequency domain,
 291          * according to IEC 61672:2003. */
 292         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
 293         /** Sound pressure level is Z-weighted (i.e. not at all) in the
 294          * frequency domain, according to IEC 61672:2003. */
 295         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
 296         /** Sound pressure level is not weighted in the frequency domain,
 297          * albeit without standards-defined low and high frequency limits. */
 298         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
 299         /** Sound pressure level measurement is S-weighted (1s) in the
 300          * time domain. */
 301         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
 302         /** Sound pressure level measurement is F-weighted (125ms) in the
 303          * time domain. */
 304         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
 305         /** Sound pressure level is time-averaged (LAT), also known as
 306          * Equivalent Continuous A-weighted Sound Level (LEQ). */
 307         SR_MQFLAG_SPL_LAT = 0x8000,
 308         /** Sound pressure level represented as a percentage of measurements
 309          * that were over a preset alarm level. */
 310         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 311         /** Time is duration (as opposed to epoch, ...). */
 312         SR_MQFLAG_DURATION = 0x20000,
 313         /** Device is in "avg" mode, averaging upon each new value. */
 314         SR_MQFLAG_AVG = 0x40000,
 315 };
 316
 317 enum sr_trigger_matches {
 318         SR_TRIGGER_ZERO = 1,
 319         SR_TRIGGER_ONE,
 320         SR_TRIGGER_RISING,
 321         SR_TRIGGER_FALLING,
 322         SR_TRIGGER_EDGE,
 323         SR_TRIGGER_OVER,
 324         SR_TRIGGER_UNDER,
 325 };
 326
 327 /** The representation of a trigger, consisting of one or more stages
 328  * containing one or more matches on a channel.
 329  */
 330 struct sr_trigger {
 331         /** A name for this trigger. This may be NULL if none is needed. */
 332         char *name;
 333         /** List of pointers to struct sr_trigger_stage. */
 334         GSList *stages;
 335 };
 336
 337 /** A trigger stage. */
 338 struct sr_trigger_stage {
 339         /** Starts at 0. */
 340         int stage;
 341         /** List of pointers to struct sr_trigger_match. */
 342         GSList *matches;
 343 };
 344
 345 /** A channel to match and what to match it on. */
 346 struct sr_trigger_match {
 347         /** The channel to trigger on. */
 348         struct sr_channel *channel;
 349         /** The trigger match to use.
 350          * For logic channels, only the following matches may be used:
 351          * SR_TRIGGER_ZERO
 352          * SR_TRIGGER_ONE
 353          * SR_TRIGGER_RISING
 354          * SR_TRIGGER_FALLING
 355          * SR_TRIGGER_EDGE
 356          *
 357          * For analog channels, only these matches may be used:
 358          * SR_TRIGGER_RISING
 359          * SR_TRIGGER_FALLING
 360          * SR_TRIGGER_OVER
 361          * SR_TRIGGER_UNDER
 362          *
 363          */
 364         int match;
 365         /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
 366          * this contains the value to compare against. */
 367         float value;
 368 };
 369
 370 /**
 371  * @struct sr_context
 372  * Opaque structure representing a libsigrok context.
 373  *
 374  * None of the fields of this structure are meant to be accessed directly.
 375  *
 376  * @see sr_init(), sr_exit().
 377  */
 378 struct sr_context;
 379
 380 /**
 381  * @struct sr_session
 382  * Opaque structure representing a libsigrok session.
 383  *
 384  * None of the fields of this structure are meant to be accessed directly.
 385  *
 386  * @see sr_session_new(), sr_session_destroy().
 387  */
 388 struct sr_session;
 389
 390 /** Packet in a sigrok data feed. */
 391 struct sr_datafeed_packet {
 392         uint16_t type;
 393         const void *payload;
 394 };
 395
 396 /** Header of a sigrok data feed. */
 397 struct sr_datafeed_header {
 398         int feed_version;
 399         struct timeval starttime;
 400 };
 401
 402 /** Datafeed payload for type SR_DF_META. */
 403 struct sr_datafeed_meta {
 404         GSList *config;
 405 };
 406
 407 /** Logic datafeed payload for type SR_DF_LOGIC. */
 408 struct sr_datafeed_logic {
 409         uint64_t length;
 410         uint16_t unitsize;
 411         void *data;
 412 };
 413
 414 /** Analog datafeed payload for type SR_DF_ANALOG. */
 415 struct sr_datafeed_analog {
 416         /** The channels for which data is included in this packet. */
 417         GSList *channels;
 418         /** Number of samples in data */
 419         int num_samples;
 420         /** Measured quantity (voltage, current, temperature, and so on).
 421          *  Use SR_MQ_VOLTAGE, ... */
 422         int mq;
 423         /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
 424         int unit;
 425         /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
 426         uint64_t mqflags;
 427         /** The analog value(s). The data is interleaved according to
 428          * the channels list. */
 429         float *data;
 430 };
 431
 432 /** Generic option struct used by various subsystems. */
 433 struct sr_option {
 434         /* Short name suitable for commandline usage, [a-z0-9-]. */
 435         char *id;
 436         /* Short name suitable for GUI usage, can contain UTF-8. */
 437         char *name;
 438         /* Description of the option, in a sentence. */
 439         char *desc;
 440         /* Default value for this option. */
 441         GVariant *def;
 442         /* List of possible values, if this is an option with few values. */
 443         GSList *values;
 444 };
 445
 446 struct sr_input;
 447 struct sr_input_module;
 448 struct sr_output;
 449 struct sr_output_module;
 450
 451 /** Constants for channel type. */
 452 enum sr_channeltype {
 453         /** Channel type is logic channel. */
 454         SR_CHANNEL_LOGIC = 10000,
 455         /** Channel type is analog channel. */
 456         SR_CHANNEL_ANALOG,
 457 };
 458
 459 /** Information on single channel. */
 460 struct sr_channel {
 461         /** The index of this channel, starting at 0. Logic channels will
 462          * be encoded according to this index in SR_DF_LOGIC packets. */
 463         int index;
 464         /** Channel type (SR_CHANNEL_LOGIC, ...) */
 465         int type;
 466         /** Is this channel enabled? */
 467         gboolean enabled;
 468         /** Name of channel. */
 469         char *name;
 470 };
 471
 472 /** Structure for groups of channels that have common properties. */
 473 struct sr_channel_group {
 474         /** Name of the channel group. */
 475         char *name;
 476         /** List of sr_channel structs of the channels belonging to this group. */
 477         GSList *channels;
 478         /** Private data for driver use. */
 479         void *priv;
 480 };
 481
 482 /** Used for setting or getting value of a config item. */
 483 struct sr_config {
 484         /** Config key like SR_CONF_CONN, etc. */
 485         int key;
 486         /** Key-specific data. */
 487         GVariant *data;
 488 };
 489
 490 /** Information about a config key. */
 491 struct sr_config_info {
 492         /** Config key like SR_CONF_CONN, etc. */
 493         int key;
 494         /** Data type like SR_T_STRING, etc. */
 495         int datatype;
 496         /** Id string, e.g. "serialcomm". */
 497         char *id;
 498         /** Name, e.g. "Serial communication". */
 499         char *name;
 500         /** Verbose description (unused currently). */
 501         char *description;
 502 };
 503
 504 /** Constants for device classes */
 505 enum sr_configkey {
 506         /*--- Device classes ------------------------------------------------*/
 507
 508         /** The device can act as logic analyzer. */
 509         SR_CONF_LOGIC_ANALYZER = 10000,
 510
 511         /** The device can act as an oscilloscope. */
 512         SR_CONF_OSCILLOSCOPE,
 513
 514         /** The device can act as a multimeter. */
 515         SR_CONF_MULTIMETER,
 516
 517         /** The device is a demo device. */
 518         SR_CONF_DEMO_DEV,
 519
 520         /** The device can act as a sound level meter. */
 521         SR_CONF_SOUNDLEVELMETER,
 522
 523         /** The device can measure temperature. */
 524         SR_CONF_THERMOMETER,
 525
 526         /** The device can measure humidity. */
 527         SR_CONF_HYGROMETER,
 528
 529         /** The device can measure energy consumption. */
 530         SR_CONF_ENERGYMETER,
 531
 532         /** The device can demodulate signals. */
 533         SR_CONF_DEMODULATOR,
 534
 535         /** Programmable power supply. */
 536         SR_CONF_POWER_SUPPLY,
 537
 538         /*--- Driver scan options -------------------------------------------*/
 539
 540         /**
 541          * Specification on how to connect to a device.
 542          *
 543          * In combination with SR_CONF_SERIALCOMM, this is a serial port in
 544          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 545          * Otherwise this specifies a USB device, either in the form of
 546          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 547          * @verbatim <vendorid>.<productid> @endverbatim
 548          * (hexadecimal, e.g. 1d6b.0001).
 549          */
 550         SR_CONF_CONN = 20000,
 551
 552         /**
 553          * Serial communication specification, in the form:
 554          *
 555          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 556          *
 557          * Example: 9600/8n1
 558          *
 559          * The string may also be followed by one or more special settings,
 560          * in the form "/key=value". Supported keys and their values are:
 561          *
 562          * rts    0,1    set the port's RTS pin to low or high
 563          * dtr    0,1    set the port's DTR pin to low or high
 564          * flow   0      no flow control
 565          *        1      hardware-based (RTS/CTS) flow control
 566          *        2      software-based (XON/XOFF) flow control
 567          *
 568          * This is always an optional parameter, since a driver typically
 569          * knows the speed at which the device wants to communicate.
 570          */
 571         SR_CONF_SERIALCOMM,
 572
 573         /*--- Device configuration ------------------------------------------*/
 574
 575         /** The device supports setting its samplerate, in Hz. */
 576         SR_CONF_SAMPLERATE = 30000,
 577
 578         /** The device supports setting a pre/post-trigger capture ratio. */
 579         SR_CONF_CAPTURE_RATIO,
 580
 581         /** The device supports setting a pattern (pattern generator mode). */
 582         SR_CONF_PATTERN_MODE,
 583
 584         /** The device supports Run Length Encoding. */
 585         SR_CONF_RLE,
 586
 587         /** The device supports setting trigger slope. */
 588         SR_CONF_TRIGGER_SLOPE,
 589
 590         /** Trigger source. */
 591         SR_CONF_TRIGGER_SOURCE,
 592
 593         /** Horizontal trigger position. */
 594         SR_CONF_HORIZ_TRIGGERPOS,
 595
 596         /** Buffer size. */
 597         SR_CONF_BUFFERSIZE,
 598
 599         /** Time base. */
 600         SR_CONF_TIMEBASE,
 601
 602         /** Filter. */
 603         SR_CONF_FILTER,
 604
 605         /** Volts/div. */
 606         SR_CONF_VDIV,
 607
 608         /** Coupling. */
 609         SR_CONF_COUPLING,
 610
 611         /** Trigger matches.  */
 612         SR_CONF_TRIGGER_MATCH,
 613
 614         /** The device supports setting its sample interval, in ms. */
 615         SR_CONF_SAMPLE_INTERVAL,
 616
 617         /** Number of timebases, as related to SR_CONF_TIMEBASE.  */
 618         SR_CONF_NUM_TIMEBASE,
 619
 620         /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
 621         SR_CONF_NUM_VDIV,
 622
 623         /** Sound pressure level frequency weighting.  */
 624         SR_CONF_SPL_WEIGHT_FREQ,
 625
 626         /** Sound pressure level time weighting.  */
 627         SR_CONF_SPL_WEIGHT_TIME,
 628
 629         /** Sound pressure level measurement range.  */
 630         SR_CONF_SPL_MEASUREMENT_RANGE,
 631
 632         /** Max hold mode. */
 633         SR_CONF_HOLD_MAX,
 634
 635         /** Min hold mode. */
 636         SR_CONF_HOLD_MIN,
 637
 638         /** Logic low-high threshold range. */
 639         SR_CONF_VOLTAGE_THRESHOLD,
 640
 641         /** The device supports using an external clock. */
 642         SR_CONF_EXTERNAL_CLOCK,
 643
 644         /**
 645          * The device supports swapping channels. Typical this is between
 646          * buffered and unbuffered channels.
 647          */
 648         SR_CONF_SWAP,
 649
 650         /** Center frequency.
 651          * The input signal is downmixed by this frequency before the ADC
 652          * anti-aliasing filter.
 653          */
 654         SR_CONF_CENTER_FREQUENCY,
 655
 656         /** The device supports setting the number of logic channels. */
 657         SR_CONF_NUM_LOGIC_CHANNELS,
 658
 659         /** The device supports setting the number of analog channels. */
 660         SR_CONF_NUM_ANALOG_CHANNELS,
 661
 662         /** Output voltage. */
 663         SR_CONF_OUTPUT_VOLTAGE,
 664
 665         /** Maximum output voltage. */
 666         SR_CONF_OUTPUT_VOLTAGE_MAX,
 667
 668         /** Output current. */
 669         SR_CONF_OUTPUT_CURRENT,
 670
 671         /** Maximum output current. */
 672         SR_CONF_OUTPUT_CURRENT_MAX,
 673
 674         /** Enabling/disabling output. */
 675         SR_CONF_OUTPUT_ENABLED,
 676
 677         /** Channel output configuration. */
 678         SR_CONF_OUTPUT_CHANNEL,
 679
 680         /** Over-voltage protection (OVP) */
 681         SR_CONF_OVER_VOLTAGE_PROTECTION,
 682
 683         /** Over-current protection (OCP) */
 684         SR_CONF_OVER_CURRENT_PROTECTION,
 685
 686         /** Choice of clock edge for external clock ("r" or "f"). */
 687         SR_CONF_CLOCK_EDGE,
 688
 689         /** Amplitude of a source without strictly-defined MQ. */
 690         SR_CONF_AMPLITUDE,
 691
 692         /*--- Special stuff -------------------------------------------------*/
 693
 694         /** Scan options supported by the driver. */
 695         SR_CONF_SCAN_OPTIONS = 40000,
 696
 697         /** Device options for a particular device. */
 698         SR_CONF_DEVICE_OPTIONS,
 699
 700         /** Session filename. */
 701         SR_CONF_SESSIONFILE,
 702
 703         /** The device supports specifying a capturefile to inject. */
 704         SR_CONF_CAPTUREFILE,
 705
 706         /** The device supports specifying the capturefile unit size. */
 707         SR_CONF_CAPTURE_UNITSIZE,
 708
 709         /** Power off the device. */
 710         SR_CONF_POWER_OFF,
 711
 712         /**
 713          * Data source for acquisition. If not present, acquisition from
 714          * the device is always "live", i.e. acquisition starts when the
 715          * frontend asks and the results are sent out as soon as possible.
 716          *
 717          * If present, it indicates that either the device has no live
 718          * acquisition capability (for example a pure data logger), or
 719          * there is a choice. sr_config_list() returns those choices.
 720          *
 721          * In any case if a device has live acquisition capabilities, it
 722          * is always the default.
 723          */
 724         SR_CONF_DATA_SOURCE,
 725
 726         /*--- Acquisition modes ---------------------------------------------*/
 727
 728         /**
 729          * The device supports setting a sample time limit (how long
 730          * the sample acquisition should run, in ms).
 731          */
 732         SR_CONF_LIMIT_MSEC = 50000,
 733
 734         /**
 735          * The device supports setting a sample number limit (how many
 736          * samples should be acquired).
 737          */
 738         SR_CONF_LIMIT_SAMPLES,
 739
 740         /**
 741          * The device supports setting a frame limit (how many
 742          * frames should be acquired).
 743          */
 744         SR_CONF_LIMIT_FRAMES,
 745
 746         /**
 747          * The device supports continuous sampling. Neither a time limit
 748          * nor a sample number limit has to be supplied, it will just acquire
 749          * samples continuously, until explicitly stopped by a certain command.
 750          */
 751         SR_CONF_CONTINUOUS,
 752
 753         /** The device has internal storage, into which data is logged. This
 754          * starts or stops the internal logging. */
 755         SR_CONF_DATALOG,
 756
 757         /** Device mode for multi-function devices. */
 758         SR_CONF_DEVICE_MODE,
 759
 760         /** Self test mode. */
 761         SR_CONF_TEST_MODE,
 762 };
 763
 764 /** Device instance data
 765  */
 766 struct sr_dev_inst {
 767         /** Device driver. */
 768         struct sr_dev_driver *driver;
 769         /** Index of device in driver. */
 770         int index;
 771         /** Device instance status. SR_ST_NOT_FOUND, etc. */
 772         int status;
 773         /** Device instance type. SR_INST_USB, etc. */
 774         int inst_type;
 775         /** Device vendor. */
 776         char *vendor;
 777         /** Device model. */
 778         char *model;
 779         /** Device version. */
 780         char *version;
 781         /** List of channels. */
 782         GSList *channels;
 783         /** List of sr_channel_group structs */
 784         GSList *channel_groups;
 785         /** Device instance connection data (used?) */
 786         void *conn;
 787         /** Device instance private data (used?) */
 788         void *priv;
 789         /** Session to which this device is currently assigned. */
 790         struct sr_session *session;
 791 };
 792
 793 /** Types of device instance, struct sr_dev_inst.type */
 794 enum sr_dev_inst_type {
 795         /** Device instance type for USB devices. */
 796         SR_INST_USB = 10000,
 797         /** Device instance type for serial port devices. */
 798         SR_INST_SERIAL,
 799         /** Device instance type for SCPI devices. */
 800         SR_INST_SCPI,
 801 };
 802
 803 /** Device instance status, struct sr_dev_inst.status */
 804 enum sr_dev_inst_status {
 805         /** The device instance was not found. */
 806         SR_ST_NOT_FOUND = 10000,
 807         /** The device instance was found, but is still booting. */
 808         SR_ST_INITIALIZING,
 809         /** The device instance is live, but not in use. */
 810         SR_ST_INACTIVE,
 811         /** The device instance is actively in use in a session. */
 812         SR_ST_ACTIVE,
 813         /** The device is winding down its session. */
 814         SR_ST_STOPPING,
 815 };
 816
 817 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
 818 struct sr_dev_driver {
 819         /* Driver-specific */
 820         /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
 821         char *name;
 822         /** Long name. Verbose driver name shown to user. */
 823         char *longname;
 824         /** API version (currently 1).  */
 825         int api_version;
 826         /** Called when driver is loaded, e.g. program startup. */
 827         int (*init) (struct sr_context *sr_ctx);
 828         /** Called before driver is unloaded.
 829          *  Driver must free all resouces held by it. */
 830         int (*cleanup) (void);
 831         /** Scan for devices. Driver should do all initialisation required.
 832          *  Can be called several times, e.g. with different port options.
 833          *  \retval NULL Error or no devices found.
 834          *  \retval other GSList of a struct sr_dev_inst for each device.
 835          *                Must be freed by caller!
 836          */
 837         GSList *(*scan) (GSList *options);
 838         /** Get list of device instances the driver knows about.
 839          *  \returns NULL or GSList of a struct sr_dev_inst for each device.
 840          *           Must not be freed by caller!
 841          */
 842         GSList *(*dev_list) (void);
 843         /** Clear list of devices the driver knows about. */
 844         int (*dev_clear) (void);
 845         /** Query value of a configuration key in driver or given device instance.
 846          *  @see sr_config_get().
 847          */
 848         int (*config_get) (int id, GVariant **data,
 849                         const struct sr_dev_inst *sdi,
 850                         const struct sr_channel_group *cg);
 851         /** Set value of a configuration key in driver or a given device instance.
 852          *  @see sr_config_set(). */
 853         int (*config_set) (int id, GVariant *data,
 854                         const struct sr_dev_inst *sdi,
 855                         const struct sr_channel_group *cg);
 856         /** Channel status change.
 857          *  @see sr_dev_channel_enable(). */
 858         int (*config_channel_set) (const struct sr_dev_inst *sdi,
 859                         struct sr_channel *ch, unsigned int changes);
 860         /** Apply configuration settings to the device hardware.
 861          *  @see sr_config_commit().*/
 862         int (*config_commit) (const struct sr_dev_inst *sdi);
 863         /** List all possible values for a configuration key in a device instance.
 864          *  @see sr_config_list().
 865          */
 866         int (*config_list) (int info_id, GVariant **data,
 867                         const struct sr_dev_inst *sdi,
 868                         const struct sr_channel_group *cg);
 869
 870         /* Device-specific */
 871         /** Open device */
 872         int (*dev_open) (struct sr_dev_inst *sdi);
 873         /** Close device */
 874         int (*dev_close) (struct sr_dev_inst *sdi);
 875         /** Begin data acquisition on the specified device. */
 876         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
 877                         void *cb_data);
 878         /** End data acquisition on the specified device. */
 879         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
 880                         void *cb_data);
 881
 882         /* Dynamic */
 883         /** Device driver private data. Initialized by init(). */
 884         void *priv;
 885 };
 886
 887 /**
 888  * @struct sr_session
 889  *
 890  * Opaque data structure representing a libsigrok session. None of the fields
 891  * of this structure are meant to be accessed directly.
 892  */
 893 struct sr_session;
 894
 895 #include "proto.h"
 896 #include "version.h"
 897
 898 #ifdef __cplusplus
 899 }
 900 #endif
 901
 902 #endif