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_META,
 152         SR_DF_TRIGGER,
 153         SR_DF_LOGIC,
 154         SR_DF_ANALOG,
 155         SR_DF_FRAME_BEGIN,
 156         SR_DF_FRAME_END,
 157 };
 158
 159 /** Values for sr_datafeed_analog.mq. */
 160 enum {
 161         SR_MQ_VOLTAGE = 10000,
 162         SR_MQ_CURRENT,
 163         SR_MQ_RESISTANCE,
 164         SR_MQ_CAPACITANCE,
 165         SR_MQ_TEMPERATURE,
 166         SR_MQ_FREQUENCY,
 167         SR_MQ_DUTY_CYCLE,
 168         SR_MQ_CONTINUITY,
 169         SR_MQ_PULSE_WIDTH,
 170         SR_MQ_CONDUCTANCE,
 171         /** Electrical power, usually in W, or dBm. */
 172         SR_MQ_POWER,
 173         /** Gain (a transistor's gain, or hFE, for example). */
 174         SR_MQ_GAIN,
 175         /** Logarithmic representation of sound pressure relative to a
 176          * reference value. */
 177         SR_MQ_SOUND_PRESSURE_LEVEL,
 178         SR_MQ_CARBON_MONOXIDE,
 179         SR_MQ_RELATIVE_HUMIDITY,
 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         /**
 213          * Normalized (0 to 1) concentration of a substance or compound with 0
 214          * representing a concentration of 0%, and 1 being 100%. This is
 215          * represented as the fraction of number of particles of the substance.
 216          */
 217         SR_UNIT_CONCENTRATION,
 218 };
 219
 220 /** Values for sr_datafeed_analog.flags. */
 221 enum {
 222         /** Voltage measurement is alternating current (AC). */
 223         SR_MQFLAG_AC = 0x01,
 224         /** Voltage measurement is direct current (DC). */
 225         SR_MQFLAG_DC = 0x02,
 226         /** This is a true RMS measurement. */
 227         SR_MQFLAG_RMS = 0x04,
 228         /** Value is voltage drop across a diode, or NAN. */
 229         SR_MQFLAG_DIODE = 0x08,
 230         /** Device is in "hold" mode (repeating the last measurement). */
 231         SR_MQFLAG_HOLD = 0x10,
 232         /** Device is in "max" mode, only updating upon a new max value. */
 233         SR_MQFLAG_MAX = 0x20,
 234         /** Device is in "min" mode, only updating upon a new min value. */
 235         SR_MQFLAG_MIN = 0x40,
 236         /** Device is in autoranging mode. */
 237         SR_MQFLAG_AUTORANGE = 0x80,
 238         /** Device is in relative mode. */
 239         SR_MQFLAG_RELATIVE = 0x100,
 240         /** Sound pressure level is A-weighted in the frequency domain,
 241          * according to IEC 61672:2003. */
 242         SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
 243         /** Sound pressure level is C-weighted in the frequency domain,
 244          * according to IEC 61672:2003. */
 245         SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
 246         /** Sound pressure level is Z-weighted (i.e. not at all) in the
 247          * frequency domain, according to IEC 61672:2003. */
 248         SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
 249         /** Sound pressure level is not weighted in the frequency domain,
 250          * albeit without standards-defined low and high frequency limits. */
 251         SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
 252         /** Sound pressure level measurement is S-weighted (1s) in the
 253          * time domain. */
 254         SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
 255         /** Sound pressure level measurement is F-weighted (125ms) in the
 256          * time domain. */
 257         SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
 258         /** Sound pressure level is time-averaged (LAT), also known as
 259          * Equivalent Continuous A-weighted Sound Level (LEQ). */
 260         SR_MQFLAG_SPL_LAT = 0x8000,
 261         /** Sound pressure level represented as a percentage of measurements
 262          * that were over a preset alarm level. */
 263         SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
 264 };
 265
 266 struct sr_context;
 267
 268 struct sr_datafeed_packet {
 269         uint16_t type;
 270         const void *payload;
 271 };
 272
 273 struct sr_datafeed_header {
 274         int feed_version;
 275         struct timeval starttime;
 276 };
 277
 278 struct sr_datafeed_meta {
 279         GSList *config;
 280 };
 281
 282 struct sr_datafeed_meta_logic {
 283         int num_probes;
 284         uint64_t samplerate;
 285 };
 286
 287 struct sr_datafeed_logic {
 288         uint64_t length;
 289         uint16_t unitsize;
 290         void *data;
 291 };
 292
 293 struct sr_datafeed_meta_analog {
 294         int num_probes;
 295 };
 296
 297 struct sr_datafeed_analog {
 298         int num_samples;
 299         /** Measured quantity (voltage, current, temperature, and so on). */
 300         int mq;
 301         /** Unit in which the MQ is measured. */
 302         int unit;
 303         /** Bitmap with extra information about the MQ. */
 304         uint64_t mqflags;
 305         /** The analog value. */
 306         float *data;
 307 };
 308
 309 struct sr_input {
 310         struct sr_input_format *format;
 311         GHashTable *param;
 312         struct sr_dev_inst *sdi;
 313         void *internal;
 314 };
 315
 316 struct sr_input_format {
 317         char *id;
 318         char *description;
 319         int (*format_match) (const char *filename);
 320         int (*init) (struct sr_input *in);
 321         int (*loadfile) (struct sr_input *in, const char *filename);
 322 };
 323
 324 struct sr_output {
 325         struct sr_output_format *format;
 326         struct sr_dev_inst *sdi;
 327         char *param;
 328         void *internal;
 329 };
 330
 331 struct sr_output_format {
 332         char *id;
 333         char *description;
 334         int df_type;
 335         int (*init) (struct sr_output *o);
 336         int (*data) (struct sr_output *o, const uint8_t *data_in,
 337                      uint64_t length_in, uint8_t **data_out,
 338                      uint64_t *length_out);
 339         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
 340                       uint64_t *length_out);
 341         GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
 342                         const struct sr_datafeed_packet *packet);
 343         int (*cleanup) (struct sr_output *o);
 344 };
 345
 346 /*
 347  * This represents a generic device connected to the system.
 348  * For device-specific information, ask the driver. The driver_index refers
 349  * to the device index within that driver; it may be handling more than one
 350  * device. All relevant driver calls take a dev_index parameter for this.
 351  */
 352 struct sr_dev {
 353         /** Which driver handles this device. */
 354         struct sr_dev_driver *driver;
 355         /** A driver may handle multiple devices of the same type. */
 356         int driver_index;
 357         /** List of struct sr_probe pointers. */
 358         GSList *probes;
 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_config {
 375         int key;
 376         const void *value;
 377 };
 378
 379 struct sr_config_info {
 380         int key;
 381         int datatype;
 382         char *id;
 383         char *name;
 384         char *description;
 385 };
 386
 387 /** Hardware driver options. */
 388 enum {
 389         /**
 390          * Specification on how to connect to a device.
 391          *
 392          * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
 393          * the form which makes sense to the OS (e.g., /dev/ttyS0).
 394          * Otherwise this specifies a USB device, either in the form of
 395          * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
 396          * @verbatim <vendorid>.<productid> @endverbatim
 397          * (hexadecimal, e.g. 1d6b.0001).
 398          */
 399         SR_HWOPT_CONN = 10000,
 400
 401         /**
 402          * Serial communication specification, in the form:
 403          *
 404          *   @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
 405          *
 406          * Example: 9600/8n1
 407          *
 408          * This is always an optional parameter, since a driver typically
 409          * knows the speed at which the device wants to communicate.
 410          */
 411         SR_HWOPT_SERIALCOMM,
 412 };
 413
 414 /** Hardware device capabilities. */
 415 enum {
 416         /*--- Device classes ------------------------------------------------*/
 417
 418         /** The device can act as logic analyzer. */
 419         SR_HWCAP_LOGIC_ANALYZER = 10000,
 420
 421         /** The device can act as an oscilloscope. */
 422         SR_HWCAP_OSCILLOSCOPE,
 423
 424         /** The device can act as a multimeter. */
 425         SR_HWCAP_MULTIMETER,
 426
 427         /** The device is a demo device. */
 428         SR_HWCAP_DEMO_DEV,
 429
 430         /** The device can act as a sound level meter. */
 431         SR_HWCAP_SOUNDLEVELMETER,
 432
 433         /** The device can measure temperature. */
 434         SR_HWCAP_THERMOMETER,
 435
 436         /** The device can measure humidity. */
 437         SR_HWCAP_HYGROMETER,
 438
 439         /*--- Device configuration ------------------------------------------*/
 440
 441         /** The device supports setting/changing its samplerate. */
 442         SR_HWCAP_SAMPLERATE = 20000,
 443
 444         /** The device supports setting a pre/post-trigger capture ratio. */
 445         SR_HWCAP_CAPTURE_RATIO,
 446
 447         /* TODO? */
 448         /** The device supports setting a pattern (pattern generator mode). */
 449         SR_HWCAP_PATTERN_MODE,
 450
 451         /** The device supports Run Length Encoding. */
 452         SR_HWCAP_RLE,
 453
 454         /** The device supports setting trigger slope. */
 455         SR_HWCAP_TRIGGER_SLOPE,
 456
 457         /** Trigger source. */
 458         SR_HWCAP_TRIGGER_SOURCE,
 459
 460         /** Horizontal trigger position. */
 461         SR_HWCAP_HORIZ_TRIGGERPOS,
 462
 463         /** Buffer size. */
 464         SR_HWCAP_BUFFERSIZE,
 465
 466         /** Time base. */
 467         SR_HWCAP_TIMEBASE,
 468
 469         /** Filter. */
 470         SR_HWCAP_FILTER,
 471
 472         /** Volts/div. */
 473         SR_HWCAP_VDIV,
 474
 475         /** Coupling. */
 476         SR_HWCAP_COUPLING,
 477
 478         /*--- Special stuff -------------------------------------------------*/
 479
 480         /** Session filename. */
 481         SR_HWCAP_SESSIONFILE = 30000,
 482
 483         /* TODO: Better description. */
 484         /** The device supports specifying a capturefile to inject. */
 485         SR_HWCAP_CAPTUREFILE,
 486
 487         /* TODO: Better description. */
 488         /** The device supports specifying the capturefile unit size. */
 489         SR_HWCAP_CAPTURE_UNITSIZE,
 490
 491         /* TODO: Better description. */
 492         /** The device supports setting the number of probes. */
 493         SR_HWCAP_CAPTURE_NUM_PROBES,
 494
 495         /*--- Acquisition modes ---------------------------------------------*/
 496
 497         /**
 498          * The device supports setting a sample time limit (how long
 499          * the sample acquisition should run, in ms).
 500          */
 501         SR_HWCAP_LIMIT_MSEC = 40000,
 502
 503         /**
 504          * The device supports setting a sample number limit (how many
 505          * samples should be acquired).
 506          */
 507         SR_HWCAP_LIMIT_SAMPLES,
 508
 509         /**
 510          * The device supports setting a frame limit (how many
 511          * frames should be acquired).
 512          */
 513         SR_HWCAP_LIMIT_FRAMES,
 514
 515         /**
 516          * The device supports continuous sampling. Neither a time limit
 517          * nor a sample number limit has to be supplied, it will just acquire
 518          * samples continuously, until explicitly stopped by a certain command.
 519          */
 520         SR_HWCAP_CONTINUOUS,
 521 };
 522
 523 struct sr_dev_inst {
 524         struct sr_dev_driver *driver;
 525         int index;
 526         int status;
 527         int inst_type;
 528         char *vendor;
 529         char *model;
 530         char *version;
 531         GSList *probes;
 532         void *priv;
 533 };
 534
 535 /** Types of device instances (sr_dev_inst). */
 536 enum {
 537         /** Device instance type for USB devices. */
 538         SR_INST_USB = 10000,
 539         /** Device instance type for serial port devices. */
 540         SR_INST_SERIAL,
 541 };
 542
 543 /** Device instance status. */
 544 enum {
 545         /** The device instance was not found. */
 546         SR_ST_NOT_FOUND = 10000,
 547         /** The device instance was found, but is still booting. */
 548         SR_ST_INITIALIZING,
 549         /** The device instance is live, but not in use. */
 550         SR_ST_INACTIVE,
 551         /** The device instance is actively in use in a session. */
 552         SR_ST_ACTIVE,
 553         /** The device is winding down its session. */
 554         SR_ST_STOPPING,
 555 };
 556
 557 /*
 558  * TODO: This sucks, you just kinda have to "know" the returned type.
 559  * TODO: Need a DI to return the number of trigger stages supported.
 560  */
 561
 562 /** Device info IDs. */
 563 enum {
 564         /** A list of options supported by the driver. */
 565         SR_DI_HWOPTS = 10000,
 566         /** A list of capabilities supported by the device. */
 567         SR_DI_HWCAPS,
 568         /** Samplerates supported by this device (struct sr_samplerates). */
 569         SR_DI_SAMPLERATES,
 570         /** Types of logic trigger supported, out of "01crf" (char *). */
 571         SR_DI_TRIGGER_TYPES,
 572         /** The currently set samplerate in Hz (uint64_t). */
 573         SR_DI_CUR_SAMPLERATE,
 574         /** Supported patterns (in pattern generator mode). */
 575         SR_DI_PATTERNS,
 576         /** Supported buffer sizes. */
 577         SR_DI_BUFFERSIZES,
 578         /** Supported time bases. */
 579         SR_DI_TIMEBASES,
 580         /** Supported trigger sources. */
 581         SR_DI_TRIGGER_SOURCES,
 582         /** Supported filter targets. */
 583         SR_DI_FILTERS,
 584         /** Valid volts/div values. */
 585         SR_DI_VDIVS,
 586         /** Coupling options. */
 587         SR_DI_COUPLING,
 588 };
 589
 590 /*
 591  * A device supports either a range of samplerates with steps of a given
 592  * granularity, or is limited to a set of defined samplerates. Use either
 593  * step or list, but not both.
 594  */
 595 struct sr_samplerates {
 596         uint64_t low;
 597         uint64_t high;
 598         uint64_t step;
 599         const uint64_t *list;
 600 };
 601
 602 struct sr_dev_driver {
 603         /* Driver-specific */
 604         char *name;
 605         char *longname;
 606         int api_version;
 607         int (*init) (struct sr_context *sr_ctx);
 608         int (*cleanup) (void);
 609         GSList *(*scan) (GSList *options);
 610         GSList *(*dev_list) (void);
 611         int (*dev_clear) (void);
 612
 613         /* Device-specific */
 614         int (*dev_open) (struct sr_dev_inst *sdi);
 615         int (*dev_close) (struct sr_dev_inst *sdi);
 616         int (*info_get) (int info_id, const void **data,
 617                         const struct sr_dev_inst *sdi);
 618         int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
 619                         const void *value);
 620         int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
 621                         void *cb_data);
 622         int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
 623                         void *cb_data);
 624
 625         /* Dynamic */
 626         void *priv;
 627 };
 628
 629 struct sr_session {
 630         /** List of struct sr_dev pointers. */
 631         GSList *devs;
 632         /** List of sr_receive_data_callback_t items. */
 633         GSList *datafeed_callbacks;
 634         GTimeVal starttime;
 635
 636         unsigned int num_sources;
 637
 638         /*
 639          * Both "sources" and "pollfds" are of the same size and contain pairs
 640          * of descriptor and callback function. We can not embed the GPollFD
 641          * into the source struct since we want to be able to pass the array
 642          * of all poll descriptors to g_poll().
 643          */
 644         struct source *sources;
 645         GPollFD *pollfds;
 646         int source_timeout;
 647 };
 648
 649 #include "proto.h"
 650 #include "version.h"
 651
 652 #ifdef __cplusplus
 653 }
 654 #endif
 655
 656 #endif