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