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