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,
 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,
 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,
 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 };
 180
 181 /** Values for sr_datafeed_analog.unit. */
 182 enum {
 183         SR_UNIT_VOLT,
 184         SR_UNIT_AMPERE,
 185         SR_UNIT_OHM,
 186         SR_UNIT_FARAD,
 187         SR_UNIT_KELVIN,
 188         SR_UNIT_CELSIUS,
 189         SR_UNIT_FAHRENHEIT,
 190         SR_UNIT_HERTZ,
 191         SR_UNIT_PERCENTAGE,
 192         SR_UNIT_BOOLEAN,
 193         SR_UNIT_SECOND,
 194         /** Unit of conductance, the inverse of resistance. */
 195         SR_UNIT_SIEMENS,
 196         /**
 197          * An absolute measurement of power, in decibels, referenced to
 198          * 1 milliwatt (dBu).
 199          */
 200         SR_UNIT_DECIBEL_MW,
 201         /** Voltage in decibel, referenced to 1 volt (dBV). */
 202         SR_UNIT_DECIBEL_VOLT,
 203         /**
 204          * Measurements that intrinsically do not have units attached, such
 205          * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
 206          * a unitless quantity, for example.
 207          */
 208         SR_UNIT_UNITLESS,
 209         /** Sound pressure level relative so 20 micropascals. */
 210         SR_UNIT_DECIBEL_SPL,
 211 };
 212
 213 /** Values for sr_datafeed_analog.flags. */
 214 enum {
 215         /** Voltage measurement is alternating current (AC). */
 216         SR_MQFLAG_AC = 0x01,
 217         /** Voltage measurement is direct current (DC). */
 218         SR_MQFLAG_DC = 0x02,
 219         /** This is a true RMS measurement. */
 220         SR_MQFLAG_RMS = 0x04,
 221         /** Value is voltage drop across a diode, or NAN. */
 222         SR_MQFLAG_DIODE = 0x08,
 223         /** Device is in "hold" mode (repeating the last measurement). */
 224         SR_MQFLAG_HOLD = 0x10,
 225         /** Device is in "max" mode, only updating upon a new max value. */
 226         SR_MQFLAG_MAX = 0x20,
 227         /** Device is in "min" mode, only updating upon a new min value. */
 228         SR_MQFLAG_MIN = 0x40,
 229         /** Device is in autoranging mode. */
 230         SR_MQFLAG_AUTORANGE = 0x80,
 231         /** Device is in relative mode. */
 232         SR_MQFLAG_RELATIVE = 0x100,
 233         /** Sound pressure level is A-weighted in the frequency domain,
 234          * according to IRC 61672:2003. */
 235         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
 236         /** Sound pressure level is C-weighted in the frequency domain,
 237          * according to IRC 61672:2003. */
 238         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
 239         /** Sound pressure level is Z-weighted (i.e. not at all) in the
 240          * frequency domain, according to IRC 61672:2003. */
 241         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
 242         /** Sound pressure level is not weighted in the frequency domain,
 243          * albeit without standards-defined low and high frequency limits. */
 244         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
 245         /** Sound pressure level measurement is S-weighted (1s) in the
 246          * time domain. */
 247         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
 248         /** Sound pressure level measurement is F-weighted (125ms) in the
 249          * time domain. */
 250         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
 251         /** Sound pressure level is time-averaged (LAT), also known as
 252          * Equivalent Continuous A-weighted Sound Level (LEQ). */
 253         SR_MQFLAG_SPL_LAT = 0x8000,
 254         /** Sound pressure level represented as a percentage of measurements
 255          * that were over a preset alarm level. */
 256         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 257 };
 258
 259 struct sr_context;
 260
 261 struct sr_datafeed_packet {
 262         uint16_t type;
 263         void *payload;
 264 };
 265
 266 struct sr_datafeed_header {
 267         int feed_version;
 268         struct timeval starttime;
 269 };
 270
 271 struct sr_datafeed_meta_logic {
 272         int num_probes;
 273         uint64_t samplerate;
 274 };
 275
 276 struct sr_datafeed_logic {
 277         uint64_t length;
 278         uint16_t unitsize;
 279         void *data;
 280 };
 281
 282 struct sr_datafeed_meta_analog {
 283         int num_probes;
 284 };
 285
 286 struct sr_datafeed_analog {
 287         int num_samples;
 288         /** Measured quantity (voltage, current, temperature, and so on). */
 289         int mq;
 290         /** Unit in which the MQ is measured. */
 291         int unit;
 292         /** Bitmap with extra information about the MQ. */
 293         uint64_t mqflags;
 294         /** The analog value. */
 295         float *data;
 296 };
 297
 298 struct sr_input {
 299         struct sr_input_format *format;
 300         GHashTable *param;
 301         struct sr_dev_inst *sdi;
 302         void *internal;
 303 };
 304
 305 struct sr_input_format {
 306         char *id;
 307         char *description;
 308         int (*format_match) (const char *filename);
 309         int (*init) (struct sr_input *in);
 310         int (*loadfile) (struct sr_input *in, const char *filename);
 311 };
 312
 313 struct sr_output {
 314         struct sr_output_format *format;
 315         struct sr_dev_inst *sdi;
 316         char *param;
 317         void *internal;
 318 };
 319
 320 struct sr_output_format {
 321         char *id;
 322         char *description;
 323         int df_type;
 324         int (*init) (struct sr_output *o);
 325         int (*data) (struct sr_output *o, const uint8_t *data_in,
 326                      uint64_t length_in, uint8_t **data_out,
 327                      uint64_t *length_out);
 328         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
 329                       uint64_t *length_out);
 330         GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
 331                         struct sr_datafeed_packet *packet);
 332         int (*cleanup) (struct sr_output *o);
 333 };
 334
 335 struct sr_datastore {
 336         /** Size in bytes of the number of units stored in this datastore. */
 337         int ds_unitsize;
 338         unsigned int num_units; /* TODO: uint64_t */
 339         GSList *chunklist;
 340 };
 341
 342 /*
 343  * This represents a generic device connected to the system.
 344  * For device-specific information, ask the driver. The driver_index refers
 345  * to the device index within that driver; it may be handling more than one
 346  * device. All relevant driver calls take a dev_index parameter for this.
 347  */
 348 struct sr_dev {
 349         /** Which driver handles this device. */
 350         struct sr_dev_driver *driver;
 351         /** A driver may handle multiple devices of the same type. */
 352         int driver_index;
 353         /** List of struct sr_probe pointers. */
 354         GSList *probes;
 355         /** Data acquired by this device, if any. */
 356         struct sr_datastore *datastore;
 357 };
 358
 359 enum {
 360         SR_PROBE_LOGIC,
 361         SR_PROBE_ANALOG,
 362 };
 363
 364 struct sr_probe {
 365         int index;
 366         int type;
 367         gboolean enabled;
 368         char *name;
 369         char *trigger;
 370 };
 371
 372 struct sr_hwopt {
 373         int hwopt;
 374         const void *value;
 375 };
 376
 377 /** Hardware driver options. */
 378 enum {
 379         /** Used to terminate lists. */
 380         SR_HWOPT_DUMMY = 0, /* Must be 0! */
 381
 382         /**
 383          * Some drivers cannot detect the exact model they're talking to
 384          * (may be phased out).
 385          */
 386         SR_HWOPT_MODEL,
 387
 388         /**
 389          * Specification on how to connect to a device.
 390          *
 391          * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
 392          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 393          * Otherwise this specifies a USB device, either in the form of
 394          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 395          * @verbatim <vendorid>.<productid> @endverbatim
 396          * (hexadecimal, e.g. 1d6b.0001).
 397          */
 398         SR_HWOPT_CONN,
 399
 400         /**
 401          * Serial communication specification, in the form:
 402          *
 403          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 404          *
 405          * Example: 9600/8n1
 406          *
 407          * This is always an optional parameter, since a driver typically
 408          * knows the speed at which the device wants to communicate.
 409          */
 410         SR_HWOPT_SERIALCOMM,
 411 };
 412
 413 /** Hardware device capabilities. */
 414 enum {
 415         /** Used to terminate lists. */
 416         SR_HWCAP_DUMMY = 0, /* Must be 0! */
 417
 418         /*--- Device classes ------------------------------------------------*/
 419
 420         /** The device can act as logic analyzer. */
 421         SR_HWCAP_LOGIC_ANALYZER,
 422
 423         /** The device can act as an oscilloscope. */
 424         SR_HWCAP_OSCILLOSCOPE,
 425
 426         /** The device can act as a multimeter. */
 427         SR_HWCAP_MULTIMETER,
 428
 429         /** The device is a demo device. */
 430         SR_HWCAP_DEMO_DEV,
 431
 432         /** The device can act as a sound level meter. */
 433         SR_HWCAP_SOUNDLEVELMETER,
 434
 435         /*--- Device configuration ------------------------------------------*/
 436
 437         /** The device supports setting/changing its samplerate. */
 438         SR_HWCAP_SAMPLERATE,
 439
 440         /** The device supports setting a pre/post-trigger capture ratio. */
 441         SR_HWCAP_CAPTURE_RATIO,
 442
 443         /* TODO? */
 444         /** The device supports setting a pattern (pattern generator mode). */
 445         SR_HWCAP_PATTERN_MODE,
 446
 447         /** The device supports Run Length Encoding. */
 448         SR_HWCAP_RLE,
 449
 450         /** The device supports setting trigger slope. */
 451         SR_HWCAP_TRIGGER_SLOPE,
 452
 453         /** Trigger source. */
 454         SR_HWCAP_TRIGGER_SOURCE,
 455
 456         /** Horizontal trigger position. */
 457         SR_HWCAP_HORIZ_TRIGGERPOS,
 458
 459         /** Buffer size. */
 460         SR_HWCAP_BUFFERSIZE,
 461
 462         /** Time base. */
 463         SR_HWCAP_TIMEBASE,
 464
 465         /** Filter. */
 466         SR_HWCAP_FILTER,
 467
 468         /** Volts/div. */
 469         SR_HWCAP_VDIV,
 470
 471         /** Coupling. */
 472         SR_HWCAP_COUPLING,
 473
 474
 475         /*--- Special stuff -------------------------------------------------*/
 476
 477         /** Session filename. */
 478         SR_HWCAP_SESSIONFILE,
 479
 480         /* TODO: Better description. */
 481         /** The device supports specifying a capturefile to inject. */
 482         SR_HWCAP_CAPTUREFILE,
 483
 484         /* TODO: Better description. */
 485         /** The device supports specifying the capturefile unit size. */
 486         SR_HWCAP_CAPTURE_UNITSIZE,
 487
 488         /* TODO: Better description. */
 489         /** The device supports setting the number of probes. */
 490         SR_HWCAP_CAPTURE_NUM_PROBES,
 491
 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,
 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
 522 struct sr_hwcap_option {
 523         int hwcap;
 524         int type;
 525         char *description;
 526         char *shortname;
 527 };
 528
 529 struct sr_dev_inst {
 530         struct sr_dev_driver *driver;
 531         int index;
 532         int status;
 533         int inst_type;
 534         char *vendor;
 535         char *model;
 536         char *version;
 537         GSList *probes;
 538         void *priv;
 539 };
 540
 541 /** Types of device instances (sr_dev_inst). */
 542 enum {
 543         /** Device instance type for USB devices. */
 544         SR_INST_USB,
 545         /** Device instance type for serial port devices. */
 546         SR_INST_SERIAL,
 547 };
 548
 549 /** Device instance status. */
 550 enum {
 551         /** The device instance was not found. */
 552         SR_ST_NOT_FOUND,
 553         /** The device instance was found, but is still booting. */
 554         SR_ST_INITIALIZING,
 555         /** The device instance is live, but not in use. */
 556         SR_ST_INACTIVE,
 557         /** The device instance is actively in use in a session. */
 558         SR_ST_ACTIVE,
 559 };
 560
 561 /*
 562  * TODO: This sucks, you just kinda have to "know" the returned type.
 563  * TODO: Need a DI to return the number of trigger stages supported.
 564  */
 565
 566 /** Device info IDs. */
 567 enum {
 568         /** A list of options supported by the driver. */
 569         SR_DI_HWOPTS,
 570         /** A list of capabilities supported by the device. */
 571         SR_DI_HWCAPS,
 572         /** The number of probes connected to this device. */
 573         SR_DI_NUM_PROBES,
 574         /** The probe names on this device. */
 575         SR_DI_PROBE_NAMES,
 576         /** Samplerates supported by this device (struct sr_samplerates). */
 577         SR_DI_SAMPLERATES,
 578         /** Types of logic trigger supported, out of "01crf" (char *). */
 579         SR_DI_TRIGGER_TYPES,
 580         /** The currently set samplerate in Hz (uint64_t). */
 581         SR_DI_CUR_SAMPLERATE,
 582         /** Supported patterns (in pattern generator mode). */
 583         SR_DI_PATTERNS,
 584         /** Supported buffer sizes. */
 585         SR_DI_BUFFERSIZES,
 586         /** Supported time bases. */
 587         SR_DI_TIMEBASES,
 588         /** Supported trigger sources. */
 589         SR_DI_TRIGGER_SOURCES,
 590         /** Supported filter targets. */
 591         SR_DI_FILTERS,
 592         /** Valid volts/div values. */
 593         SR_DI_VDIVS,
 594         /** Coupling options. */
 595         SR_DI_COUPLING,
 596 };
 597
 598 /*
 599  * A device supports either a range of samplerates with steps of a given
 600  * granularity, or is limited to a set of defined samplerates. Use either
 601  * step or list, but not both.
 602  */
 603 struct sr_samplerates {
 604         uint64_t low;
 605         uint64_t high;
 606         uint64_t step;
 607         const uint64_t *list;
 608 };
 609
 610 struct sr_dev_driver {
 611         /* Driver-specific */
 612         char *name;
 613         char *longname;
 614         int api_version;
 615         int (*init) (void);
 616         int (*cleanup) (void);
 617         GSList *(*scan) (GSList *options);
 618         GSList *(*dev_list) (void);
 619         int (*dev_clear) (void);
 620
 621         /* Device-specific */
 622         int (*dev_open) (struct sr_dev_inst *sdi);
 623         int (*dev_close) (struct sr_dev_inst *sdi);
 624         int (*info_get) (int info_id, const void **data,
 625                         const struct sr_dev_inst *sdi);
 626         int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
 627                         const void *value);
 628         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
 629                         void *cb_data);
 630         int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi,
 631                         void *cb_data);
 632
 633         /* Dynamic */
 634         void *priv;
 635 };
 636
 637 struct sr_session {
 638         /** List of struct sr_dev pointers. */
 639         GSList *devs;
 640         /** List of sr_receive_data_callback_t items. */
 641         GSList *datafeed_callbacks;
 642         GTimeVal starttime;
 643
 644         unsigned int num_sources;
 645
 646         /*
 647          * Both "sources" and "pollfds" are of the same size and contain pairs
 648          * of descriptor and callback function. We can not embed the GPollFD
 649          * into the source struct since we want to be able to pass the array
 650          * of all poll descriptors to g_poll().
 651          */
 652         struct source *sources;
 653         GPollFD *pollfds;
 654         int source_timeout;
 655 };
 656
 657 #include "proto.h"
 658 #include "version.h"
 659
 660 #ifdef __cplusplus
 661 }
 662 #endif
 663
 664 #endif