sigrok.h.in

   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  * Package version macros (can be used for conditional compilation).
  35  */
  36
  37 /** The libsigrok package 'major' version number. */
  38 #define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@
  39
  40 /** The libsigrok package 'minor' version number. */
  41 #define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@
  42
  43 /** The libsigrok package 'micro' version number. */
  44 #define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@
  45
  46 /** The libsigrok package version ("major.minor.micro") as string. */
  47 #define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@"
  48
  49 /*
  50  * Library/libtool version macros (can be used for conditional compilation).
  51  */
  52
  53 /** The libsigrok libtool 'current' version number. */
  54 #define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@
  55
  56 /** The libsigrok libtool 'revision' version number. */
  57 #define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@
  58
  59 /** The libsigrok libtool 'age' version number. */
  60 #define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@
  61
  62 /** The libsigrok libtool version ("current:revision:age") as string. */
  63 #define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@"
  64
  65 /*
  66  * Status/error codes returned by libsigrok functions.
  67  *
  68  * All possible return codes of libsigrok functions must be listed here.
  69  * Functions should never return hardcoded numbers as status, but rather
  70  * use these #defines instead. All error codes are negative numbers.
  71  *
  72  * The error codes are globally unique in libsigrok, i.e. if one of the
  73  * libsigrok functions returns a "malloc error" it must be exactly the same
  74  * return value as used by all other functions to indicate "malloc error".
  75  * There must be no functions which indicate two different errors via the
  76  * same return code.
  77  *
  78  * Also, for compatibility reasons, no defined return codes are ever removed
  79  * or reused for different #defines later. You can only add new #defines and
  80  * return codes, but never remove or redefine existing ones.
  81  */
  82 #define SR_OK                 0 /* No error */
  83 #define SR_ERR               -1 /* Generic/unspecified error */
  84 #define SR_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
  85 #define SR_ERR_ARG           -3 /* Function argument error */
  86 #define SR_ERR_BUG           -4 /* Errors hinting at internal bugs */
  87 #define SR_ERR_SAMPLERATE    -5 /* Incorrect samplerate */
  88
  89 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
  90 #define SR_MAX_PROBENAME_LEN 32
  91
  92 /* Handy little macros */
  93 #define SR_HZ(n)  (n)
  94 #define SR_KHZ(n) ((n) * 1000)
  95 #define SR_MHZ(n) ((n) * 1000000)
  96 #define SR_GHZ(n) ((n) * 1000000000)
  97
  98 #define SR_HZ_TO_NS(n) (1000000000 / (n))
  99
 100 /* libsigrok loglevels. */
 101 #define SR_LOG_NONE           0 /**< Output no messages at all. */
 102 #define SR_LOG_ERR            1 /**< Output error messages. */
 103 #define SR_LOG_WARN           2 /**< Output warnings. */
 104 #define SR_LOG_INFO           3 /**< Output informational messages. */
 105 #define SR_LOG_DBG            4 /**< Output debug messages. */
 106 #define SR_LOG_SPEW           5 /**< Output very noisy debug messages. */
 107
 108 /*
 109  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
 110  *
 111  * Variables and functions marked 'static' are private already and don't
 112  * need SR_PRIV. However, functions which are not static (because they need
 113  * to be used in other libsigrok-internal files) but are also not meant to
 114  * be part of the public libsigrok API, must use SR_PRIV.
 115  *
 116  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
 117  *
 118  * This feature is not available on MinGW/Windows, as it is a feature of
 119  * ELF files and MinGW/Windows uses PE files.
 120  *
 121  * Details: http://gcc.gnu.org/wiki/Visibility
 122  */
 123
 124 /* Marks public libsigrok API symbols. */
 125 #ifndef _WIN32
 126 #define SR_API __attribute__((visibility("default")))
 127 #else
 128 #define SR_API
 129 #endif
 130
 131 /* Marks private, non-public libsigrok symbols (not part of the API). */
 132 #ifndef _WIN32
 133 #define SR_PRIV __attribute__((visibility("hidden")))
 134 #else
 135 #define SR_PRIV
 136 #endif
 137
 138 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
 139
 140 /* Data types used by hardware drivers for dev_config_set() */
 141 enum {
 142         SR_T_UINT64,
 143         SR_T_CHAR,
 144         SR_T_BOOL,
 145         SR_T_FLOAT,
 146         SR_T_RATIONAL_PERIOD,
 147         SR_T_RATIONAL_VOLT,
 148         SR_T_KEYVALUE,
 149 };
 150
 151 struct sr_rational {
 152         /* numerator */
 153         uint64_t p;
 154         /* denominator */
 155         uint64_t q;
 156 };
 157
 158 /* sr_datafeed_packet.type values */
 159 enum {
 160         SR_DF_HEADER,
 161         SR_DF_END,
 162         SR_DF_TRIGGER,
 163         SR_DF_LOGIC,
 164         SR_DF_META_LOGIC,
 165         SR_DF_ANALOG,
 166         SR_DF_META_ANALOG,
 167         SR_DF_FRAME_BEGIN,
 168         SR_DF_FRAME_END,
 169 };
 170
 171 /* sr_datafeed_analog.mq values */
 172 enum {
 173         SR_MQ_VOLTAGE,
 174         SR_MQ_CURRENT,
 175         SR_MQ_RESISTANCE,
 176         SR_MQ_CAPACITANCE,
 177         SR_MQ_TEMPERATURE,
 178         SR_MQ_FREQUENCY,
 179         SR_MQ_DUTY_CYCLE,
 180 };
 181
 182 /* sr_datafeed_analog.unit values */
 183 enum {
 184         SR_UNIT_VOLT,
 185         SR_UNIT_AMPERE,
 186         SR_UNIT_OHM,
 187         SR_UNIT_FARAD,
 188         SR_UNIT_CELSIUS,
 189         SR_UNIT_KELVIN,
 190         SR_UNIT_HERTZ,
 191         SR_UNIT_PERCENTAGE,
 192 };
 193
 194 struct sr_datafeed_packet {
 195         uint16_t type;
 196         void *payload;
 197 };
 198
 199 struct sr_datafeed_header {
 200         int feed_version;
 201         struct timeval starttime;
 202 };
 203
 204 struct sr_datafeed_meta_logic {
 205         int num_probes;
 206         uint64_t samplerate;
 207 };
 208
 209 struct sr_datafeed_logic {
 210         uint64_t length;
 211         uint16_t unitsize;
 212         void *data;
 213 };
 214
 215 struct sr_datafeed_meta_analog {
 216         int num_probes;
 217 };
 218
 219 struct sr_datafeed_analog {
 220         int num_samples;
 221         int mq; /* Measured quantity (e.g. voltage, current, temperature) */
 222         int unit; /* Unit in which the MQ is measured. */
 223         float *data;
 224 };
 225
 226 struct sr_input {
 227         struct sr_input_format *format;
 228         char *param;
 229         struct sr_dev *vdev;
 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 *dev;
 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 };
 258
 259 struct sr_datastore {
 260         /* Size in bytes of the number of units stored in this datastore */
 261         int ds_unitsize;
 262         unsigned int num_units; /* TODO: uint64_t */
 263         GSList *chunklist;
 264 };
 265
 266 /*
 267  * This represents a generic device connected to the system.
 268  * For device-specific information, ask the driver. The driver_index refers
 269  * to the device index within that driver; it may be handling more than one
 270  * device. All relevant driver calls take a dev_index parameter for this.
 271  */
 272 struct sr_dev {
 273         /* Which driver handles this device */
 274         struct sr_dev_driver *driver;
 275         /* A driver may handle multiple devices of the same type */
 276         int driver_index;
 277         /* List of struct sr_probe* */
 278         GSList *probes;
 279         /* Data acquired by this device, if any */
 280         struct sr_datastore *datastore;
 281 };
 282
 283 enum {
 284         SR_PROBE_TYPE_LOGIC,
 285 };
 286
 287 struct sr_probe {
 288         int index;
 289         int type;
 290         gboolean enabled;
 291         char *name;
 292         char *trigger;
 293 };
 294
 295 /* Hardware driver capabilities */
 296 enum {
 297         SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 298
 299         /*--- Device classes ------------------------------------------------*/
 300
 301         /** The device can act as logic analyzer. */
 302         SR_HWCAP_LOGIC_ANALYZER,
 303
 304         /** The device can act as an oscilloscope. */
 305         SR_HWCAP_OSCILLOSCOPE,
 306
 307         /*--- Device types --------------------------------------------------*/
 308
 309         /** The device is demo device. */
 310         SR_HWCAP_DEMO_DEV,
 311
 312         /*--- Device options ------------------------------------------------*/
 313
 314         /** The device supports setting/changing its samplerate. */
 315         SR_HWCAP_SAMPLERATE,
 316
 317         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 318         /** The device supports setting a probe mask. */
 319         SR_HWCAP_PROBECONFIG,
 320
 321         /** The device supports setting a pre/post-trigger capture ratio. */
 322         SR_HWCAP_CAPTURE_RATIO,
 323
 324         /* TODO? */
 325         /** The device supports setting a pattern (pattern generator mode). */
 326         SR_HWCAP_PATTERN_MODE,
 327
 328         /** The device supports Run Length Encoding. */
 329         SR_HWCAP_RLE,
 330
 331         /** The device supports setting trigger slope. */
 332         SR_HWCAP_TRIGGER_SLOPE,
 333
 334         /** Trigger source. */
 335         SR_HWCAP_TRIGGER_SOURCE,
 336
 337         /** Horizontal trigger position */
 338         SR_HWCAP_HORIZ_TRIGGERPOS,
 339
 340         /** Buffer size. */
 341         SR_HWCAP_BUFFERSIZE,
 342
 343         /** Time base. */
 344         SR_HWCAP_TIMEBASE,
 345
 346         /** Filter. */
 347         SR_HWCAP_FILTER,
 348
 349         /** Volts/div. */
 350         SR_HWCAP_VDIV,
 351
 352         /** Coupling. */
 353         SR_HWCAP_COUPLING,
 354
 355         /*--- Special stuff -------------------------------------------------*/
 356
 357         /* TODO: Better description. */
 358         /** The device supports specifying a capturefile to inject. */
 359         SR_HWCAP_CAPTUREFILE,
 360
 361         /* TODO: Better description. */
 362         /** The device supports specifying the capturefile unit size. */
 363         SR_HWCAP_CAPTURE_UNITSIZE,
 364
 365         /* TODO: Better description. */
 366         /** The device supports setting the number of probes. */
 367         SR_HWCAP_CAPTURE_NUM_PROBES,
 368
 369         /*--- Acquisition modes ---------------------------------------------*/
 370
 371         /**
 372          * The device supports setting a sample time limit, i.e. how long the
 373          * sample acquisition should run (in ms).
 374          */
 375         SR_HWCAP_LIMIT_MSEC,
 376
 377         /**
 378          * The device supports setting a sample number limit, i.e. how many
 379          * samples should be acquired.
 380          */
 381         SR_HWCAP_LIMIT_SAMPLES,
 382
 383         /**
 384          * The device supports setting a frame limit, i.e. how many
 385          * frames should be acquired.
 386          */
 387         SR_HWCAP_LIMIT_FRAMES,
 388
 389         /**
 390          * The device supports continuous sampling, i.e. neither a time limit
 391          * nor a sample number limit has to be supplied, it will just acquire
 392          * samples continuously, until explicitly stopped by a certain command.
 393          */
 394         SR_HWCAP_CONTINUOUS,
 395
 396 };
 397
 398 struct sr_hwcap_option {
 399         int hwcap;
 400         int type;
 401         char *description;
 402         char *shortname;
 403 };
 404
 405 struct sr_dev_inst {
 406         int index;
 407         int status;
 408         int inst_type;
 409         char *vendor;
 410         char *model;
 411         char *version;
 412         void *priv;
 413 };
 414
 415 /* sr_dev_inst types */
 416 enum {
 417         /** Device instance type for USB devices. */
 418         SR_INST_USB,
 419         /** Device instance type for serial port devices. */
 420         SR_INST_SERIAL,
 421 };
 422
 423 /* Device instance status */
 424 enum {
 425         SR_ST_NOT_FOUND,
 426         /* Found, but still booting */
 427         SR_ST_INITIALIZING,
 428         /* Live, but not in use */
 429         SR_ST_INACTIVE,
 430         /* Actively in use in a session */
 431         SR_ST_ACTIVE,
 432 };
 433
 434 /*
 435  * TODO: This sucks, you just kinda have to "know" the returned type.
 436  * TODO: Need a DI to return the number of trigger stages supported.
 437  */
 438
 439 /* Device info IDs */
 440 enum {
 441         /* struct sr_dev_inst for this specific device */
 442         SR_DI_INST,
 443         /* The number of probes connected to this device */
 444         SR_DI_NUM_PROBES,
 445         /* The probe names on this device */
 446         SR_DI_PROBE_NAMES,
 447         /* Samplerates supported by this device, (struct sr_samplerates) */
 448         SR_DI_SAMPLERATES,
 449         /* Types of logic trigger supported, out of "01crf" (char *) */
 450         SR_DI_TRIGGER_TYPES,
 451         /* The currently set samplerate in Hz (uint64_t) */
 452         SR_DI_CUR_SAMPLERATE,
 453         /* Supported patterns (in pattern generator mode) */
 454         SR_DI_PATTERNS,
 455         /* Supported buffer sizes */
 456         SR_DI_BUFFERSIZES,
 457         /* Supported time bases */
 458         SR_DI_TIMEBASES,
 459         /* Supported trigger sources */
 460         SR_DI_TRIGGER_SOURCES,
 461         /* Supported filter targets */
 462         SR_DI_FILTERS,
 463         /* Valid volts/div values */
 464         SR_DI_VDIVS,
 465         /* Coupling options */
 466         SR_DI_COUPLING,
 467 };
 468
 469 /*
 470  * A device supports either a range of samplerates with steps of a given
 471  * granularity, or is limited to a set of defined samplerates. Use either
 472  * step or list, but not both.
 473  */
 474 struct sr_samplerates {
 475         uint64_t low;
 476         uint64_t high;
 477         uint64_t step;
 478         const uint64_t *list;
 479 };
 480
 481 struct sr_dev_driver {
 482         /* Driver-specific */
 483         char *name;
 484         char *longname;
 485         int api_version;
 486         int (*init) (const char *devinfo);
 487         int (*cleanup) (void);
 488
 489         /* Device-specific */
 490         int (*dev_open) (int dev_index);
 491         int (*dev_close) (int dev_index);
 492         const void *(*dev_info_get) (int dev_index, int dev_info_id);
 493         int (*dev_status_get) (int dev_index);
 494         const int *(*hwcap_get_all) (void);
 495         int (*dev_config_set) (int dev_index, int hwcap, const void *value);
 496         int (*dev_acquisition_start) (int dev_index, void *session_dev_id);
 497         int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
 498 };
 499
 500 struct sr_session {
 501         /* List of struct sr_dev* */
 502         GSList *devs;
 503         /* list of sr_receive_data_callback_t */
 504         GSList *datafeed_callbacks;
 505         GTimeVal starttime;
 506         gboolean running;
 507 };
 508
 509 #include "sigrok-proto.h"
 510
 511 #ifdef __cplusplus
 512 }
 513 #endif
 514
 515 #endif