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