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