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