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