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