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