include/libsigrok/libsigrok.h

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