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