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