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