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_SIGROK_H
  21 #define LIBSIGROK_SIGROK_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
  77         /*
  78          * Note: When adding entries here, don't forget to also update the
  79          * sr_strerror() and sr_strerror_name() functions in error.c.
  80          */
  81 };
  82
  83 #define SR_MAX_PROBENAME_LEN 32
  84
  85 /* Handy little macros */
  86 #define SR_HZ(n)  (n)
  87 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
  88 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
  89 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
  90
  91 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
  92
  93 /** libsigrok loglevels. */
  94 enum {
  95         SR_LOG_NONE = 0, /**< Output no messages at all. */
  96         SR_LOG_ERR  = 1, /**< Output error messages. */
  97         SR_LOG_WARN = 2, /**< Output warnings. */
  98         SR_LOG_INFO = 3, /**< Output informational messages. */
  99         SR_LOG_DBG  = 4, /**< Output debug messages. */
 100         SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
 101 };
 102
 103 /*
 104  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
 105  *
 106  * Variables and functions marked 'static' are private already and don't
 107  * need SR_PRIV. However, functions which are not static (because they need
 108  * to be used in other libsigrok-internal files) but are also not meant to
 109  * be part of the public libsigrok API, must use SR_PRIV.
 110  *
 111  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 112  *
 113  * This feature is not available on MinGW/Windows, as it is a feature of
 114  * ELF files and MinGW/Windows uses PE files.
 115  *
 116  * Details: http://gcc.gnu.org/wiki/Visibility
 117  */
 118
 119 /* Marks public libsigrok API symbols. */
 120 #ifndef _WIN32
 121 #define SR_API __attribute__((visibility("default")))
 122 #else
 123 #define SR_API
 124 #endif
 125
 126 /* Marks private, non-public libsigrok symbols (not part of the API). */
 127 #ifndef _WIN32
 128 #define SR_PRIV __attribute__((visibility("hidden")))
 129 #else
 130 #define SR_PRIV
 131 #endif
 132
 133 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
 134
 135 /** Data types used by sr_config_info(). */
 136 enum {
 137         SR_T_UINT64 = 10000,
 138         SR_T_CHAR,
 139         SR_T_BOOL,
 140         SR_T_FLOAT,
 141         SR_T_RATIONAL_PERIOD,
 142         SR_T_RATIONAL_VOLT,
 143         SR_T_KEYVALUE,
 144         SR_T_UINT64_RANGE,
 145         SR_T_DOUBLE_RANGE,
 146 };
 147
 148 /** Value for sr_datafeed_packet.type. */
 149 enum {
 150         SR_DF_HEADER = 10000,
 151         SR_DF_END,
 152         SR_DF_META,
 153         SR_DF_TRIGGER,
 154         SR_DF_LOGIC,
 155         SR_DF_ANALOG,
 156         SR_DF_FRAME_BEGIN,
 157         SR_DF_FRAME_END,
 158 };
 159
 160 /** Values for sr_datafeed_analog.mq. */
 161 enum {
 162         SR_MQ_VOLTAGE = 10000,
 163         SR_MQ_CURRENT,
 164         SR_MQ_RESISTANCE,
 165         SR_MQ_CAPACITANCE,
 166         SR_MQ_TEMPERATURE,
 167         SR_MQ_FREQUENCY,
 168         SR_MQ_DUTY_CYCLE,
 169         SR_MQ_CONTINUITY,
 170         SR_MQ_PULSE_WIDTH,
 171         SR_MQ_CONDUCTANCE,
 172         /** Electrical power, usually in W, or dBm. */
 173         SR_MQ_POWER,
 174         /** Gain (a transistor's gain, or hFE, for example). */
 175         SR_MQ_GAIN,
 176         /** Logarithmic representation of sound pressure relative to a
 177          * reference value. */
 178         SR_MQ_SOUND_PRESSURE_LEVEL,
 179         SR_MQ_CARBON_MONOXIDE,
 180         SR_MQ_RELATIVE_HUMIDITY,
 181 };
 182
 183 /** Values for sr_datafeed_analog.unit. */
 184 enum {
 185         SR_UNIT_VOLT = 10000,
 186         SR_UNIT_AMPERE,
 187         SR_UNIT_OHM,
 188         SR_UNIT_FARAD,
 189         SR_UNIT_KELVIN,
 190         SR_UNIT_CELSIUS,
 191         SR_UNIT_FAHRENHEIT,
 192         SR_UNIT_HERTZ,
 193         SR_UNIT_PERCENTAGE,
 194         SR_UNIT_BOOLEAN,
 195         SR_UNIT_SECOND,
 196         /** Unit of conductance, the inverse of resistance. */
 197         SR_UNIT_SIEMENS,
 198         /**
 199          * An absolute measurement of power, in decibels, referenced to
 200          * 1 milliwatt (dBu).
 201          */
 202         SR_UNIT_DECIBEL_MW,
 203         /** Voltage in decibel, referenced to 1 volt (dBV). */
 204         SR_UNIT_DECIBEL_VOLT,
 205         /**
 206          * Measurements that intrinsically do not have units attached, such
 207          * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
 208          * a unitless quantity, for example.
 209          */
 210         SR_UNIT_UNITLESS,
 211         /** Sound pressure level relative so 20 micropascals. */
 212         SR_UNIT_DECIBEL_SPL,
 213         /**
 214          * Normalized (0 to 1) concentration of a substance or compound with 0
 215          * representing a concentration of 0%, and 1 being 100%. This is
 216          * represented as the fraction of number of particles of the substance.
 217          */
 218         SR_UNIT_CONCENTRATION,
 219 };
 220
 221 /** Values for sr_datafeed_analog.flags. */
 222 enum {
 223         /** Voltage measurement is alternating current (AC). */
 224         SR_MQFLAG_AC = 0x01,
 225         /** Voltage measurement is direct current (DC). */
 226         SR_MQFLAG_DC = 0x02,
 227         /** This is a true RMS measurement. */
 228         SR_MQFLAG_RMS = 0x04,
 229         /** Value is voltage drop across a diode, or NAN. */
 230         SR_MQFLAG_DIODE = 0x08,
 231         /** Device is in "hold" mode (repeating the last measurement). */
 232         SR_MQFLAG_HOLD = 0x10,
 233         /** Device is in "max" mode, only updating upon a new max value. */
 234         SR_MQFLAG_MAX = 0x20,
 235         /** Device is in "min" mode, only updating upon a new min value. */
 236         SR_MQFLAG_MIN = 0x40,
 237         /** Device is in autoranging mode. */
 238         SR_MQFLAG_AUTORANGE = 0x80,
 239         /** Device is in relative mode. */
 240         SR_MQFLAG_RELATIVE = 0x100,
 241         /** Sound pressure level is A-weighted in the frequency domain,
 242          * according to IEC 61672:2003. */
 243         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
 244         /** Sound pressure level is C-weighted in the frequency domain,
 245          * according to IEC 61672:2003. */
 246         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
 247         /** Sound pressure level is Z-weighted (i.e. not at all) in the
 248          * frequency domain, according to IEC 61672:2003. */
 249         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
 250         /** Sound pressure level is not weighted in the frequency domain,
 251          * albeit without standards-defined low and high frequency limits. */
 252         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
 253         /** Sound pressure level measurement is S-weighted (1s) in the
 254          * time domain. */
 255         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
 256         /** Sound pressure level measurement is F-weighted (125ms) in the
 257          * time domain. */
 258         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
 259         /** Sound pressure level is time-averaged (LAT), also known as
 260          * Equivalent Continuous A-weighted Sound Level (LEQ). */
 261         SR_MQFLAG_SPL_LAT = 0x8000,
 262         /** Sound pressure level represented as a percentage of measurements
 263          * that were over a preset alarm level. */
 264         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 265 };
 266
 267 struct sr_context;
 268
 269 struct sr_datafeed_packet {
 270         uint16_t type;
 271         const void *payload;
 272 };
 273
 274 struct sr_datafeed_header {
 275         int feed_version;
 276         struct timeval starttime;
 277 };
 278
 279 struct sr_datafeed_meta {
 280         GSList *config;
 281 };
 282
 283 struct sr_datafeed_logic {
 284         uint64_t length;
 285         uint16_t unitsize;
 286         void *data;
 287 };
 288
 289 struct sr_datafeed_analog {
 290         /** The probes for which data is included in this packet. */
 291         GSList *probes;
 292         int num_samples;
 293         /** Measured quantity (voltage, current, temperature, and so on). */
 294         int mq;
 295         /** Unit in which the MQ is measured. */
 296         int unit;
 297         /** Bitmap with extra information about the MQ. */
 298         uint64_t mqflags;
 299         /** The analog value(s). The data is interleaved according to
 300          * the probes list. */
 301         float *data;
 302 };
 303
 304 /** Input (file) format struct. */
 305 struct sr_input {
 306         /**
 307          * A pointer to this input format's 'struct sr_input_format'.
 308          * The frontend can use this to call the module's callbacks.
 309          */
 310         struct sr_input_format *format;
 311
 312         GHashTable *param;
 313
 314         struct sr_dev_inst *sdi;
 315
 316         void *internal;
 317 };
 318
 319 struct sr_input_format {
 320         /** The unique ID for this input format. Must not be NULL. */
 321         char *id;
 322
 323         /**
 324          * A short description of the input format, which can (for example)
 325          * be displayed to the user by frontends. Must not be NULL.
 326          */
 327         char *description;
 328
 329         /**
 330          * Check if this input module can load and parse the specified file.
 331          *
 332          * @param filename The name (and path) of the file to check.
 333          *
 334          * @return TRUE if this module knows the format, FALSE if it doesn't.
 335          */
 336         int (*format_match) (const char *filename);
 337
 338         /**
 339          * Initialize the input module.
 340          *
 341          * @param in A pointer to a valid 'struct sr_input' that the caller
 342          *           has to allocate and provide to this function. It is also
 343          *           the responsibility of the caller to free it later.
 344          * @param filename The name (and path) of the file to use.
 345          *
 346          * @return SR_OK upon success, a negative error code upon failure.
 347          */
 348         int (*init) (struct sr_input *in, const char *filename);
 349
 350         /**
 351          * Load a file, parsing the input according to the file's format.
 352          *
 353          * This function will send datafeed packets to the session bus, so
 354          * the calling frontend must have registered its session callbacks
 355          * beforehand.
 356          *
 357          * The packet types sent across the session bus by this function must
 358          * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
 359          * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
 360          * if appropriate.
 361          *
 362          * @param in A pointer to a valid 'struct sr_input' that the caller
 363          *           has to allocate and provide to this function. It is also
 364          *           the responsibility of the caller to free it later.
 365          * @param filename The name (and path) of the file to use.
 366          *
 367          * @return SR_OK upon success, a negative error code upon failure.
 368          */
 369         int (*loadfile) (struct sr_input *in, const char *filename);
 370 };
 371
 372 /** Output (file) format struct. */
 373 struct sr_output {
 374         /**
 375          * A pointer to this output format's 'struct sr_output_format'.
 376          * The frontend can use this to call the module's callbacks.
 377          */
 378         struct sr_output_format *format;
 379
 380         /**
 381          * The device for which this output module is creating output. This
 382          * can be used by the module to find out probe names and numbers.
 383          */
 384         struct sr_dev_inst *sdi;
 385
 386         /**
 387          * An optional parameter which the frontend can pass in to the
 388          * output module. How the string is interpreted is entirely up to
 389          * the module.
 390          */
 391         char *param;
 392
 393         /**
 394          * A generic pointer which can be used by the module to keep internal
 395          * state between calls into its callback functions.
 396          *
 397          * For example, the module might store a pointer to a chunk of output
 398          * there, and only flush it when it reaches a certain size.
 399          */
 400         void *internal;
 401 };
 402
 403 struct sr_output_format {
 404         /**
 405          * A unique ID for this output format. Must not be NULL.
 406          *
 407          * It can be used by frontends to select this output format for use.
 408          *
 409          * For example, calling sigrok-cli with <code>-O hex</code> will
 410          * select the hexadecimal text output format.
 411          */
 412         char *id;
 413
 414         /**
 415          * A short description of the output format. Must not be NULL.
 416          *
 417          * This can be displayed by frontends, e.g. when selecting the output
 418          * format for saving a file.
 419          */
 420         char *description;
 421
 422         int df_type;
 423
 424         /**
 425          * This function is called once, at the beginning of an output stream.
 426          *
 427          * The device struct will be available in the output struct passed in,
 428          * as well as the param field -- which may be NULL or an empty string,
 429          * if no parameter was passed.
 430          *
 431          * The module can use this to initialize itself, create a struct for
 432          * keeping state and storing it in the <code>internal</code> field.
 433          *
 434          * @param o Pointer to the respective 'struct sr_output'.
 435          *
 436          * @return SR_OK upon success, a negative error code otherwise.
 437          */
 438         int (*init) (struct sr_output *o);
 439
 440         /**
 441          * Whenever a chunk of data comes in, it will be passed to the
 442          * output module via this function. The <code>data_in</code> and
 443          * <code>length_in</code> values refers to this data; the module
 444          * must not alter or g_free() this buffer.
 445          *
 446          * The function must allocate a buffer for storing its output, and
 447          * pass along a pointer to this buffer in the <code>data_out</code>
 448          * parameter, as well as storing the length of the buffer in
 449          * <code>length_out</code>. The calling frontend will g_free()
 450          * this buffer when it's done with it.
 451          *
 452          * IMPORTANT: The memory allocation much happen using a glib memory
 453          * allocation call (not a "normal" malloc) since g_free() will be
 454          * used to free the memory!
 455          *
 456          * If there is no output, this function MUST store NULL in the
 457          * <code>data_out</code> parameter, so the caller knows not to try
 458          * and g_free() it.
 459          *
 460          * Note: This API call is obsolete, use receive() instead.
 461          *
 462          * @param o Pointer to the respective 'struct sr_output'.
 463          * @param data_in Pointer to the input data buffer.
 464          * @param length_in Length of the input.
 465          * @param data_out Pointer to the allocated output buffer.
 466          * @param length_out Length (in bytes) of the output.
 467          *
 468          * @return SR_OK upon success, a negative error code otherwise.
 469          */
 470         int (*data) (struct sr_output *o, const uint8_t *data_in,
 471                      uint64_t length_in, uint8_t **data_out,
 472                      uint64_t *length_out);
 473
 474         /**
 475          * This function is called when an event occurs in the datafeed
 476          * which the output module may need to be aware of. No data is
 477          * passed in, only the fact that the event occurs. The following
 478          * events can currently be passed in:
 479          *
 480          *  - SR_DF_TRIGGER: At this point in the datafeed, the trigger
 481          *    matched. The output module may mark this in some way, e.g. by
 482          *    plotting a red line on a graph.
 483          *
 484          *  - SR_DF_END: This marks the end of the datafeed. No more calls
 485          *    into the output module will be done, so this is a good time to
 486          *    free up any memory used to keep state, for example.
 487          *
 488          * Any output generated by this function must have a reference to
 489          * it stored in the <code>data_out</code> and <code>length_out</code>
 490          * parameters, or NULL if no output was generated.
 491          *
 492          * Note: This API call is obsolete, use receive() instead.
 493          *
 494          * @param o Pointer to the respective 'struct sr_output'.
 495          * @param event_type Type of event that occured.
 496          * @param data_out Pointer to the allocated output buffer.
 497          * @param length_out Length (in bytes) of the output.
 498          *
 499          * @return SR_OK upon success, a negative error code otherwise.
 500          */
 501         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
 502                         uint64_t *length_out);
 503
 504         /**
 505          * This function is passed a copy of every packed in the data feed.
 506          * Any output generated by the output module in response to the
 507          * packet should be returned in a newly allocated GString
 508          * <code>out</code>, which will be freed by the caller.
 509          *
 510          * Packets not of interest to the output module can just be ignored,
 511          * and the <code>out</code> parameter set to NULL.
 512          *
 513          * @param o Pointer to the respective 'struct sr_output'.
 514          * @param sdi The device instance that generated the packet.
 515          * @param packet The complete packet.
 516          * @param out A pointer where a GString * should be stored if
 517          * the module generates output, or NULL if not.
 518          *
 519          * @return SR_OK upon success, a negative error code otherwise.
 520          */
 521         int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
 522                         const struct sr_datafeed_packet *packet, GString **out);
 523
 524         /**
 525          * This function is called after the caller is finished using
 526          * the output module, and can be used to free any internal
 527          * resources the module may keep.
 528          *
 529          * @return SR_OK upon success, a negative error code otherwise.
 530          */
 531         int (*cleanup) (struct sr_output *o);
 532 };
 533
 534 enum {
 535         SR_PROBE_LOGIC = 10000,
 536         SR_PROBE_ANALOG,
 537 };
 538
 539 struct sr_probe {
 540         /* The index field will go: use g_slist_length(sdi->probes) instead. */
 541         int index;
 542         int type;
 543         gboolean enabled;
 544         char *name;
 545         char *trigger;
 546 };
 547
 548 struct sr_config {
 549         int key;
 550         GVariant *data;
 551 };
 552
 553 struct sr_config_info {
 554         int key;
 555         int datatype;
 556         char *id;
 557         char *name;
 558         char *description;
 559 };
 560
 561 enum {
 562         /*--- Device classes ------------------------------------------------*/
 563
 564         /** The device can act as logic analyzer. */
 565         SR_CONF_LOGIC_ANALYZER = 10000,
 566
 567         /** The device can act as an oscilloscope. */
 568         SR_CONF_OSCILLOSCOPE,
 569
 570         /** The device can act as a multimeter. */
 571         SR_CONF_MULTIMETER,
 572
 573         /** The device is a demo device. */
 574         SR_CONF_DEMO_DEV,
 575
 576         /** The device can act as a sound level meter. */
 577         SR_CONF_SOUNDLEVELMETER,
 578
 579         /** The device can measure temperature. */
 580         SR_CONF_THERMOMETER,
 581
 582         /** The device can measure humidity. */
 583         SR_CONF_HYGROMETER,
 584
 585         /*--- Driver scan options -------------------------------------------*/
 586
 587         /**
 588          * Specification on how to connect to a device.
 589          *
 590          * In combination with SR_CONF_SERIALCOMM, this is a serial port in
 591          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 592          * Otherwise this specifies a USB device, either in the form of
 593          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 594          * @verbatim <vendorid>.<productid> @endverbatim
 595          * (hexadecimal, e.g. 1d6b.0001).
 596          */
 597         SR_CONF_CONN = 20000,
 598
 599         /**
 600          * Serial communication specification, in the form:
 601          *
 602          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 603          *
 604          * Example: 9600/8n1
 605          *
 606          * The string may also be followed by one or more special settings,
 607          * in the form "/key=value". Supported keys and their values are:
 608          *
 609          * rts    0,1    set the port's RTS pin to low or high
 610          * dtr    0,1    set the port's DTR pin to low or high
 611          * flow   0      no flow control
 612          *        1      hardware-based (RTS/CTS) flow control
 613          *        2      software-based (XON/XOFF) flow control
 614          *
 615          * This is always an optional parameter, since a driver typically
 616          * knows the speed at which the device wants to communicate.
 617          */
 618         SR_CONF_SERIALCOMM,
 619
 620         /*--- Device configuration ------------------------------------------*/
 621
 622         /** The device supports setting its samplerate, in Hz. */
 623         SR_CONF_SAMPLERATE = 30000,
 624
 625         /** The device supports setting a pre/post-trigger capture ratio. */
 626         SR_CONF_CAPTURE_RATIO,
 627
 628         /** The device supports setting a pattern (pattern generator mode). */
 629         SR_CONF_PATTERN_MODE,
 630
 631         /** The devices supports using a external clock. */
 632         SR_CONF_EXTERNAL_CLOCK,
 633
 634         /** The device supports swapping channels. Typical this is between
 635          *  buffered and unbuffered channels.
 636          */
 637         SR_CONF_SWAP,
 638
 639         /** The device supports Run Length Encoding. */
 640         SR_CONF_RLE,
 641
 642         /** The device supports setting trigger slope. */
 643         SR_CONF_TRIGGER_SLOPE,
 644
 645         /** Trigger source. */
 646         SR_CONF_TRIGGER_SOURCE,
 647
 648         /** Horizontal trigger position. */
 649         SR_CONF_HORIZ_TRIGGERPOS,
 650
 651         /** Buffer size. */
 652         SR_CONF_BUFFERSIZE,
 653
 654         /** Time base. */
 655         SR_CONF_TIMEBASE,
 656
 657         /** Filter. */
 658         SR_CONF_FILTER,
 659
 660         /** Volts/div. */
 661         SR_CONF_VDIV,
 662
 663         /** Coupling. */
 664         SR_CONF_COUPLING,
 665
 666         /** Trigger types.  */
 667         SR_CONF_TRIGGER_TYPE,
 668
 669         /** The device supports setting its sample interval, in ms. */
 670         SR_CONF_SAMPLE_INTERVAL,
 671
 672         /** Number of timebases, as related to SR_CONF_TIMEBASE.  */
 673         SR_CONF_NUM_TIMEBASE,
 674
 675         /** Number of vertical divisions, as related to SR_CONF_VDIV.  */
 676         SR_CONF_NUM_VDIV,
 677
 678         /** Sound pressure level frequency weighting.  */
 679         SR_CONF_SPL_WEIGHT_FREQ,
 680
 681         /** Sound pressure level time weighting.  */
 682         SR_CONF_SPL_WEIGHT_TIME,
 683
 684         /** Sound pressure level measurement range.  */
 685         SR_CONF_SPL_MEASUREMENT_RANGE,
 686
 687         /** Max hold mode. */
 688         SR_CONF_HOLD_MAX,
 689
 690         /** Min hold mode. */
 691         SR_CONF_HOLD_MIN,
 692
 693         /** Logic low-high threshold range. */
 694         SR_CONF_VOLTAGE_THRESHOLD,
 695
 696         /*--- Special stuff -------------------------------------------------*/
 697
 698         /** Scan options supported by the driver. */
 699         SR_CONF_SCAN_OPTIONS = 40000,
 700
 701         /** Device options for a particular device. */
 702         SR_CONF_DEVICE_OPTIONS,
 703
 704         /** Session filename. */
 705         SR_CONF_SESSIONFILE,
 706
 707         /** The device supports specifying a capturefile to inject. */
 708         SR_CONF_CAPTUREFILE,
 709
 710         /** The device supports specifying the capturefile unit size. */
 711         SR_CONF_CAPTURE_UNITSIZE,
 712
 713         /** The device supports setting the number of probes. */
 714         SR_CONF_CAPTURE_NUM_PROBES,
 715
 716         /** Power off the device. */
 717         SR_CONF_POWER_OFF,
 718
 719         /** Data source for acquisition. If not present, acquisition from
 720          * the device is always "live", i.e. acquisition starts when the
 721          * frontend asks and the results are sent out as soon as possible.
 722          *
 723          * If present, it indicates that either the device has no live
 724          * acquisition capability (for example a pure data logger), or
 725          * there is a choice. sr_config_list() returns those choices.
 726          *
 727          * In any case if a device has live acquisition capabilities, it
 728          * is always the default. */
 729         SR_CONF_DATA_SOURCE,
 730
 731         /*--- Acquisition modes ---------------------------------------------*/
 732
 733         /**
 734          * The device supports setting a sample time limit (how long
 735          * the sample acquisition should run, in ms).
 736          */
 737         SR_CONF_LIMIT_MSEC = 50000,
 738
 739         /**
 740          * The device supports setting a sample number limit (how many
 741          * samples should be acquired).
 742          */
 743         SR_CONF_LIMIT_SAMPLES,
 744
 745         /**
 746          * The device supports setting a frame limit (how many
 747          * frames should be acquired).
 748          */
 749         SR_CONF_LIMIT_FRAMES,
 750
 751         /**
 752          * The device supports continuous sampling. Neither a time limit
 753          * nor a sample number limit has to be supplied, it will just acquire
 754          * samples continuously, until explicitly stopped by a certain command.
 755          */
 756         SR_CONF_CONTINUOUS,
 757
 758         /** The device has internal storage, into which data is logged. This
 759          * starts or stops the internal logging. */
 760         SR_CONF_DATALOG,
 761 };
 762
 763 struct sr_dev_inst {
 764         struct sr_dev_driver *driver;
 765         int index;
 766         int status;
 767         int inst_type;
 768         char *vendor;
 769         char *model;
 770         char *version;
 771         GSList *probes;
 772         void *conn;
 773         void *priv;
 774 };
 775
 776 /** Types of device instances (sr_dev_inst). */
 777 enum {
 778         /** Device instance type for USB devices. */
 779         SR_INST_USB = 10000,
 780         /** Device instance type for serial port devices. */
 781         SR_INST_SERIAL,
 782 };
 783
 784 /** Device instance status. */
 785 enum {
 786         /** The device instance was not found. */
 787         SR_ST_NOT_FOUND = 10000,
 788         /** The device instance was found, but is still booting. */
 789         SR_ST_INITIALIZING,
 790         /** The device instance is live, but not in use. */
 791         SR_ST_INACTIVE,
 792         /** The device instance is actively in use in a session. */
 793         SR_ST_ACTIVE,
 794         /** The device is winding down its session. */
 795         SR_ST_STOPPING,
 796 };
 797
 798 struct sr_dev_driver {
 799         /* Driver-specific */
 800         char *name;
 801         char *longname;
 802         int api_version;
 803         int (*init) (struct sr_context *sr_ctx);
 804         int (*cleanup) (void);
 805         GSList *(*scan) (GSList *options);
 806         GSList *(*dev_list) (void);
 807         int (*dev_clear) (void);
 808         int (*config_get) (int id, GVariant **data,
 809                         const struct sr_dev_inst *sdi);
 810         int (*config_set) (int id, GVariant *data,
 811                         const struct sr_dev_inst *sdi);
 812         int (*config_list) (int info_id, GVariant **data,
 813                         const struct sr_dev_inst *sdi);
 814
 815         /* Device-specific */
 816         int (*dev_open) (struct sr_dev_inst *sdi);
 817         int (*dev_close) (struct sr_dev_inst *sdi);
 818         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
 819                         void *cb_data);
 820         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
 821                         void *cb_data);
 822
 823         /* Dynamic */
 824         void *priv;
 825 };
 826
 827 struct sr_session {
 828         /** List of struct sr_dev pointers. */
 829         GSList *devs;
 830         /** List of struct datafeed_callback pointers. */
 831         GSList *datafeed_callbacks;
 832         GTimeVal starttime;
 833         gboolean running;
 834
 835         unsigned int num_sources;
 836
 837         /*
 838          * Both "sources" and "pollfds" are of the same size and contain pairs
 839          * of descriptor and callback function. We can not embed the GPollFD
 840          * into the source struct since we want to be able to pass the array
 841          * of all poll descriptors to g_poll().
 842          */
 843         struct source *sources;
 844         GPollFD *pollfds;
 845         int source_timeout;
 846
 847         /*
 848          * These are our synchronization primitives for stopping the session in
 849          * an async fashion. We need to make sure the session is stopped from
 850          * within the session thread itself.
 851          */
 852         GMutex stop_mutex;
 853         gboolean abort_session;
 854 };
 855
 856 #include "proto.h"
 857 #include "version.h"
 858
 859 #ifdef __cplusplus
 860 }
 861 #endif
 862
 863 #endif