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