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