include/libsigrok/libsigrok.h

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