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