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