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