libsigrok.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 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 };
  74
  75 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
  76 #define SR_MAX_PROBENAME_LEN 32
  77
  78 /* Handy little macros */
  79 #define SR_HZ(n)  (n)
  80 #define SR_KHZ(n) ((n) * 1000)
  81 #define SR_MHZ(n) ((n) * 1000000)
  82 #define SR_GHZ(n) ((n) * 1000000000)
  83
  84 #define SR_HZ_TO_NS(n) (1000000000 / (n))
  85
  86 /** libsigrok loglevels. */
  87 enum {
  88         SR_LOG_NONE = 0, /**< Output no messages at all. */
  89         SR_LOG_ERR  = 1, /**< Output error messages. */
  90         SR_LOG_WARN = 2, /**< Output warnings. */
  91         SR_LOG_INFO = 3, /**< Output informational messages. */
  92         SR_LOG_DBG  = 4, /**< Output debug messages. */
  93         SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
  94 };
  95
  96 /*
  97  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
  98  *
  99  * Variables and functions marked 'static' are private already and don't
 100  * need SR_PRIV. However, functions which are not static (because they need
 101  * to be used in other libsigrok-internal files) but are also not meant to
 102  * be part of the public libsigrok API, must use SR_PRIV.
 103  *
 104  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 105  *
 106  * This feature is not available on MinGW/Windows, as it is a feature of
 107  * ELF files and MinGW/Windows uses PE files.
 108  *
 109  * Details: http://gcc.gnu.org/wiki/Visibility
 110  */
 111
 112 /* Marks public libsigrok API symbols. */
 113 #ifndef _WIN32
 114 #define SR_API __attribute__((visibility("default")))
 115 #else
 116 #define SR_API
 117 #endif
 118
 119 /* Marks private, non-public libsigrok symbols (not part of the API). */
 120 #ifndef _WIN32
 121 #define SR_PRIV __attribute__((visibility("hidden")))
 122 #else
 123 #define SR_PRIV
 124 #endif
 125
 126 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
 127
 128 /** Data types used by hardware drivers for dev_config_set(). */
 129 enum {
 130         SR_T_UINT64 = 10000,
 131         SR_T_CHAR,
 132         SR_T_BOOL,
 133         SR_T_FLOAT,
 134         SR_T_RATIONAL_PERIOD,
 135         SR_T_RATIONAL_VOLT,
 136         SR_T_KEYVALUE,
 137 };
 138
 139 /** Rational number data type, containing numerator and denominator values. */
 140 struct sr_rational {
 141         /** Numerator of the rational number. */
 142         uint64_t p;
 143         /** Denominator of the rational number. */
 144         uint64_t q;
 145 };
 146
 147 /** Value for sr_datafeed_packet.type. */
 148 enum {
 149         SR_DF_HEADER = 10000,
 150         SR_DF_END,
 151         SR_DF_TRIGGER,
 152         SR_DF_LOGIC,
 153         SR_DF_META_LOGIC,
 154         SR_DF_ANALOG,
 155         SR_DF_META_ANALOG,
 156         SR_DF_FRAME_BEGIN,
 157         SR_DF_FRAME_END,
 158 };
 159
 160 /** Values for sr_datafeed_analog.mq. */
 161 enum {
 162         SR_MQ_VOLTAGE = 10000,
 163         SR_MQ_CURRENT,
 164         SR_MQ_RESISTANCE,
 165         SR_MQ_CAPACITANCE,
 166         SR_MQ_TEMPERATURE,
 167         SR_MQ_FREQUENCY,
 168         SR_MQ_DUTY_CYCLE,
 169         SR_MQ_CONTINUITY,
 170         SR_MQ_PULSE_WIDTH,
 171         SR_MQ_CONDUCTANCE,
 172         /** Electrical power, usually in W, or dBm. */
 173         SR_MQ_POWER,
 174         /** Gain (a transistor's gain, or hFE, for example). */
 175         SR_MQ_GAIN,
 176         /** Logarithmic representation of sound pressure relative to a
 177          * reference value. */
 178         SR_MQ_SOUND_PRESSURE_LEVEL,
 179         SR_MQ_CARBON_MONOXIDE,
 180 };
 181
 182 /** Values for sr_datafeed_analog.unit. */
 183 enum {
 184         SR_UNIT_VOLT = 10000,
 185         SR_UNIT_AMPERE,
 186         SR_UNIT_OHM,
 187         SR_UNIT_FARAD,
 188         SR_UNIT_KELVIN,
 189         SR_UNIT_CELSIUS,
 190         SR_UNIT_FAHRENHEIT,
 191         SR_UNIT_HERTZ,
 192         SR_UNIT_PERCENTAGE,
 193         SR_UNIT_BOOLEAN,
 194         SR_UNIT_SECOND,
 195         /** Unit of conductance, the inverse of resistance. */
 196         SR_UNIT_SIEMENS,
 197         /**
 198          * An absolute measurement of power, in decibels, referenced to
 199          * 1 milliwatt (dBu).
 200          */
 201         SR_UNIT_DECIBEL_MW,
 202         /** Voltage in decibel, referenced to 1 volt (dBV). */
 203         SR_UNIT_DECIBEL_VOLT,
 204         /**
 205          * Measurements that intrinsically do not have units attached, such
 206          * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
 207          * a unitless quantity, for example.
 208          */
 209         SR_UNIT_UNITLESS,
 210         /** Sound pressure level relative so 20 micropascals. */
 211         SR_UNIT_DECIBEL_SPL,
 212         SR_UNIT_CONCENTRATION,
 213 };
 214
 215 /** Values for sr_datafeed_analog.flags. */
 216 enum {
 217         /** Voltage measurement is alternating current (AC). */
 218         SR_MQFLAG_AC = 0x01,
 219         /** Voltage measurement is direct current (DC). */
 220         SR_MQFLAG_DC = 0x02,
 221         /** This is a true RMS measurement. */
 222         SR_MQFLAG_RMS = 0x04,
 223         /** Value is voltage drop across a diode, or NAN. */
 224         SR_MQFLAG_DIODE = 0x08,
 225         /** Device is in "hold" mode (repeating the last measurement). */
 226         SR_MQFLAG_HOLD = 0x10,
 227         /** Device is in "max" mode, only updating upon a new max value. */
 228         SR_MQFLAG_MAX = 0x20,
 229         /** Device is in "min" mode, only updating upon a new min value. */
 230         SR_MQFLAG_MIN = 0x40,
 231         /** Device is in autoranging mode. */
 232         SR_MQFLAG_AUTORANGE = 0x80,
 233         /** Device is in relative mode. */
 234         SR_MQFLAG_RELATIVE = 0x100,
 235         /** Sound pressure level is A-weighted in the frequency domain,
 236          * according to IEC 61672:2003. */
 237         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
 238         /** Sound pressure level is C-weighted in the frequency domain,
 239          * according to IEC 61672:2003. */
 240         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
 241         /** Sound pressure level is Z-weighted (i.e. not at all) in the
 242          * frequency domain, according to IEC 61672:2003. */
 243         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
 244         /** Sound pressure level is not weighted in the frequency domain,
 245          * albeit without standards-defined low and high frequency limits. */
 246         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
 247         /** Sound pressure level measurement is S-weighted (1s) in the
 248          * time domain. */
 249         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
 250         /** Sound pressure level measurement is F-weighted (125ms) in the
 251          * time domain. */
 252         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
 253         /** Sound pressure level is time-averaged (LAT), also known as
 254          * Equivalent Continuous A-weighted Sound Level (LEQ). */
 255         SR_MQFLAG_SPL_LAT = 0x8000,
 256         /** Sound pressure level represented as a percentage of measurements
 257          * that were over a preset alarm level. */
 258         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 259 };
 260
 261 struct sr_context;
 262
 263 struct sr_datafeed_packet {
 264         uint16_t type;
 265         void *payload;
 266 };
 267
 268 struct sr_datafeed_header {
 269         int feed_version;
 270         struct timeval starttime;
 271 };
 272
 273 struct sr_datafeed_meta_logic {
 274         int num_probes;
 275         uint64_t samplerate;
 276 };
 277
 278 struct sr_datafeed_logic {
 279         uint64_t length;
 280         uint16_t unitsize;
 281         void *data;
 282 };
 283
 284 struct sr_datafeed_meta_analog {
 285         int num_probes;
 286 };
 287
 288 struct sr_datafeed_analog {
 289         int num_samples;
 290         /** Measured quantity (voltage, current, temperature, and so on). */
 291         int mq;
 292         /** Unit in which the MQ is measured. */
 293         int unit;
 294         /** Bitmap with extra information about the MQ. */
 295         uint64_t mqflags;
 296         /** The analog value. */
 297         float *data;
 298 };
 299
 300 struct sr_input {
 301         struct sr_input_format *format;
 302         GHashTable *param;
 303         struct sr_dev_inst *sdi;
 304         void *internal;
 305 };
 306
 307 struct sr_input_format {
 308         char *id;
 309         char *description;
 310         int (*format_match) (const char *filename);
 311         int (*init) (struct sr_input *in);
 312         int (*loadfile) (struct sr_input *in, const char *filename);
 313 };
 314
 315 struct sr_output {
 316         struct sr_output_format *format;
 317         struct sr_dev_inst *sdi;
 318         char *param;
 319         void *internal;
 320 };
 321
 322 struct sr_output_format {
 323         char *id;
 324         char *description;
 325         int df_type;
 326         int (*init) (struct sr_output *o);
 327         int (*data) (struct sr_output *o, const uint8_t *data_in,
 328                      uint64_t length_in, uint8_t **data_out,
 329                      uint64_t *length_out);
 330         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
 331                       uint64_t *length_out);
 332         GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
 333                         struct sr_datafeed_packet *packet);
 334         int (*cleanup) (struct sr_output *o);
 335 };
 336
 337 struct sr_datastore {
 338         /** Size in bytes of the number of units stored in this datastore. */
 339         int ds_unitsize;
 340         unsigned int num_units; /* TODO: uint64_t */
 341         GSList *chunklist;
 342 };
 343
 344 /*
 345  * This represents a generic device connected to the system.
 346  * For device-specific information, ask the driver. The driver_index refers
 347  * to the device index within that driver; it may be handling more than one
 348  * device. All relevant driver calls take a dev_index parameter for this.
 349  */
 350 struct sr_dev {
 351         /** Which driver handles this device. */
 352         struct sr_dev_driver *driver;
 353         /** A driver may handle multiple devices of the same type. */
 354         int driver_index;
 355         /** List of struct sr_probe pointers. */
 356         GSList *probes;
 357         /** Data acquired by this device, if any. */
 358         struct sr_datastore *datastore;
 359 };
 360
 361 enum {
 362         SR_PROBE_LOGIC = 10000,
 363         SR_PROBE_ANALOG,
 364 };
 365
 366 struct sr_probe {
 367         int index;
 368         int type;
 369         gboolean enabled;
 370         char *name;
 371         char *trigger;
 372 };
 373
 374 struct sr_hwopt {
 375         int hwopt;
 376         const void *value;
 377 };
 378
 379 /** Hardware driver options. */
 380 enum {
 381         /**
 382          * Some drivers cannot detect the exact model they're talking to
 383          * (may be phased out).
 384          */
 385         SR_HWOPT_MODEL = 10000,
 386
 387         /**
 388          * Specification on how to connect to a device.
 389          *
 390          * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
 391          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 392          * Otherwise this specifies a USB device, either in the form of
 393          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 394          * @verbatim <vendorid>.<productid> @endverbatim
 395          * (hexadecimal, e.g. 1d6b.0001).
 396          */
 397         SR_HWOPT_CONN,
 398
 399         /**
 400          * Serial communication specification, in the form:
 401          *
 402          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 403          *
 404          * Example: 9600/8n1
 405          *
 406          * This is always an optional parameter, since a driver typically
 407          * knows the speed at which the device wants to communicate.
 408          */
 409         SR_HWOPT_SERIALCOMM,
 410 };
 411
 412 /** Hardware device capabilities. */
 413 enum {
 414         /*--- Device classes ------------------------------------------------*/
 415
 416         /** The device can act as logic analyzer. */
 417         SR_HWCAP_LOGIC_ANALYZER = 10000,
 418
 419         /** The device can act as an oscilloscope. */
 420         SR_HWCAP_OSCILLOSCOPE,
 421
 422         /** The device can act as a multimeter. */
 423         SR_HWCAP_MULTIMETER,
 424
 425         /** The device is a demo device. */
 426         SR_HWCAP_DEMO_DEV,
 427
 428         /** The device can act as a sound level meter. */
 429         SR_HWCAP_SOUNDLEVELMETER,
 430
 431         /** The device can measure temperature. */
 432         SR_HWCAP_THERMOMETER,
 433
 434         /** The device can measure humidity. */
 435         SR_HWCAP_HYGROMETER,
 436
 437         /*--- Device configuration ------------------------------------------*/
 438
 439         /** The device supports setting/changing its samplerate. */
 440         SR_HWCAP_SAMPLERATE = 20000,
 441
 442         /** The device supports setting a pre/post-trigger capture ratio. */
 443         SR_HWCAP_CAPTURE_RATIO,
 444
 445         /* TODO? */
 446         /** The device supports setting a pattern (pattern generator mode). */
 447         SR_HWCAP_PATTERN_MODE,
 448
 449         /** The device supports Run Length Encoding. */
 450         SR_HWCAP_RLE,
 451
 452         /** The device supports setting trigger slope. */
 453         SR_HWCAP_TRIGGER_SLOPE,
 454
 455         /** Trigger source. */
 456         SR_HWCAP_TRIGGER_SOURCE,
 457
 458         /** Horizontal trigger position. */
 459         SR_HWCAP_HORIZ_TRIGGERPOS,
 460
 461         /** Buffer size. */
 462         SR_HWCAP_BUFFERSIZE,
 463
 464         /** Time base. */
 465         SR_HWCAP_TIMEBASE,
 466
 467         /** Filter. */
 468         SR_HWCAP_FILTER,
 469
 470         /** Volts/div. */
 471         SR_HWCAP_VDIV,
 472
 473         /** Coupling. */
 474         SR_HWCAP_COUPLING,
 475
 476         /*--- Special stuff -------------------------------------------------*/
 477
 478         /** Session filename. */
 479         SR_HWCAP_SESSIONFILE = 30000,
 480
 481         /* TODO: Better description. */
 482         /** The device supports specifying a capturefile to inject. */
 483         SR_HWCAP_CAPTUREFILE,
 484
 485         /* TODO: Better description. */
 486         /** The device supports specifying the capturefile unit size. */
 487         SR_HWCAP_CAPTURE_UNITSIZE,
 488
 489         /* TODO: Better description. */
 490         /** The device supports setting the number of probes. */
 491         SR_HWCAP_CAPTURE_NUM_PROBES,
 492
 493         /*--- Acquisition modes ---------------------------------------------*/
 494
 495         /**
 496          * The device supports setting a sample time limit (how long
 497          * the sample acquisition should run, in ms).
 498          */
 499         SR_HWCAP_LIMIT_MSEC = 40000,
 500
 501         /**
 502          * The device supports setting a sample number limit (how many
 503          * samples should be acquired).
 504          */
 505         SR_HWCAP_LIMIT_SAMPLES,
 506
 507         /**
 508          * The device supports setting a frame limit (how many
 509          * frames should be acquired).
 510          */
 511         SR_HWCAP_LIMIT_FRAMES,
 512
 513         /**
 514          * The device supports continuous sampling. Neither a time limit
 515          * nor a sample number limit has to be supplied, it will just acquire
 516          * samples continuously, until explicitly stopped by a certain command.
 517          */
 518         SR_HWCAP_CONTINUOUS,
 519 };
 520
 521 struct sr_hwcap_option {
 522         int hwcap;
 523         int type;
 524         char *description;
 525         char *shortname;
 526 };
 527
 528 struct sr_dev_inst {
 529         struct sr_dev_driver *driver;
 530         int index;
 531         int status;
 532         int inst_type;
 533         char *vendor;
 534         char *model;
 535         char *version;
 536         GSList *probes;
 537         void *priv;
 538 };
 539
 540 /** Types of device instances (sr_dev_inst). */
 541 enum {
 542         /** Device instance type for USB devices. */
 543         SR_INST_USB = 10000,
 544         /** Device instance type for serial port devices. */
 545         SR_INST_SERIAL,
 546 };
 547
 548 /** Device instance status. */
 549 enum {
 550         /** The device instance was not found. */
 551         SR_ST_NOT_FOUND = 10000,
 552         /** The device instance was found, but is still booting. */
 553         SR_ST_INITIALIZING,
 554         /** The device instance is live, but not in use. */
 555         SR_ST_INACTIVE,
 556         /** The device instance is actively in use in a session. */
 557         SR_ST_ACTIVE,
 558         /** The device is winding down its session. */
 559         SR_ST_STOPPING,
 560 };
 561
 562 /*
 563  * TODO: This sucks, you just kinda have to "know" the returned type.
 564  * TODO: Need a DI to return the number of trigger stages supported.
 565  */
 566
 567 /** Device info IDs. */
 568 enum {
 569         /** A list of options supported by the driver. */
 570         SR_DI_HWOPTS = 10000,
 571         /** A list of capabilities supported by the device. */
 572         SR_DI_HWCAPS,
 573         /** The number of probes connected to this device. */
 574         SR_DI_NUM_PROBES,
 575         /** The probe names on this device. */
 576         SR_DI_PROBE_NAMES,
 577         /** Samplerates supported by this device (struct sr_samplerates). */
 578         SR_DI_SAMPLERATES,
 579         /** Types of logic trigger supported, out of "01crf" (char *). */
 580         SR_DI_TRIGGER_TYPES,
 581         /** The currently set samplerate in Hz (uint64_t). */
 582         SR_DI_CUR_SAMPLERATE,
 583         /** Supported patterns (in pattern generator mode). */
 584         SR_DI_PATTERNS,
 585         /** Supported buffer sizes. */
 586         SR_DI_BUFFERSIZES,
 587         /** Supported time bases. */
 588         SR_DI_TIMEBASES,
 589         /** Supported trigger sources. */
 590         SR_DI_TRIGGER_SOURCES,
 591         /** Supported filter targets. */
 592         SR_DI_FILTERS,
 593         /** Valid volts/div values. */
 594         SR_DI_VDIVS,
 595         /** Coupling options. */
 596         SR_DI_COUPLING,
 597 };
 598
 599 /*
 600  * A device supports either a range of samplerates with steps of a given
 601  * granularity, or is limited to a set of defined samplerates. Use either
 602  * step or list, but not both.
 603  */
 604 struct sr_samplerates {
 605         uint64_t low;
 606         uint64_t high;
 607         uint64_t step;
 608         const uint64_t *list;
 609 };
 610
 611 struct sr_dev_driver {
 612         /* Driver-specific */
 613         char *name;
 614         char *longname;
 615         int api_version;
 616         int (*init) (struct sr_context *sr_ctx);
 617         int (*cleanup) (void);
 618         GSList *(*scan) (GSList *options);
 619         GSList *(*dev_list) (void);
 620         int (*dev_clear) (void);
 621
 622         /* Device-specific */
 623         int (*dev_open) (struct sr_dev_inst *sdi);
 624         int (*dev_close) (struct sr_dev_inst *sdi);
 625         int (*info_get) (int info_id, const void **data,
 626                         const struct sr_dev_inst *sdi);
 627         int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
 628                         const void *value);
 629         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
 630                         void *cb_data);
 631         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
 632                         void *cb_data);
 633
 634         /* Dynamic */
 635         void *priv;
 636 };
 637
 638 struct sr_session {
 639         /** List of struct sr_dev pointers. */
 640         GSList *devs;
 641         /** List of sr_receive_data_callback_t items. */
 642         GSList *datafeed_callbacks;
 643         GTimeVal starttime;
 644
 645         unsigned int num_sources;
 646
 647         /*
 648          * Both "sources" and "pollfds" are of the same size and contain pairs
 649          * of descriptor and callback function. We can not embed the GPollFD
 650          * into the source struct since we want to be able to pass the array
 651          * of all poll descriptors to g_poll().
 652          */
 653         struct source *sources;
 654         GPollFD *pollfds;
 655         int source_timeout;
 656 };
 657
 658 #include "proto.h"
 659 #include "version.h"
 660
 661 #ifdef __cplusplus
 662 }
 663 #endif
 664
 665 #endif