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