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 };
 149
 150 struct sr_rational {
 151         /* numerator */
 152         uint64_t p;
 153         /* denominator */
 154         uint64_t q;
 155 };
 156
 157 /* sr_datafeed_packet.type values */
 158 enum {
 159         SR_DF_HEADER,
 160         SR_DF_END,
 161         SR_DF_TRIGGER,
 162         SR_DF_LOGIC,
 163         SR_DF_META_LOGIC,
 164         SR_DF_ANALOG,
 165         SR_DF_META_ANALOG,
 166         SR_DF_FRAME_BEGIN,
 167         SR_DF_FRAME_END,
 168 };
 169
 170 /* sr_datafeed_analog.unit values */
 171 enum {
 172         SR_UNIT_VOLTAGE,
 173 };
 174
 175 struct sr_datafeed_packet {
 176         uint16_t type;
 177         void *payload;
 178 };
 179
 180 struct sr_datafeed_header {
 181         int feed_version;
 182         struct timeval starttime;
 183 };
 184
 185 struct sr_datafeed_meta_logic {
 186         int num_probes;
 187         uint64_t samplerate;
 188 };
 189
 190 struct sr_datafeed_logic {
 191         uint64_t length;
 192         uint16_t unitsize;
 193         void *data;
 194 };
 195
 196 struct sr_datafeed_meta_analog {
 197         int num_probes;
 198 };
 199
 200 struct sr_datafeed_analog {
 201         int num_samples;
 202         int unit;
 203         float *data;
 204 };
 205
 206 struct sr_input {
 207         struct sr_input_format *format;
 208         char *param;
 209         struct sr_dev *vdev;
 210 };
 211
 212 struct sr_input_format {
 213         char *id;
 214         char *description;
 215         int (*format_match) (const char *filename);
 216         int (*init) (struct sr_input *in);
 217         int (*loadfile) (struct sr_input *in, const char *filename);
 218 };
 219
 220 struct sr_output {
 221         struct sr_output_format *format;
 222         struct sr_dev *dev;
 223         char *param;
 224         void *internal;
 225 };
 226
 227 struct sr_output_format {
 228         char *id;
 229         char *description;
 230         int df_type;
 231         int (*init) (struct sr_output *o);
 232         int (*data) (struct sr_output *o, const uint8_t *data_in,
 233                      uint64_t length_in, uint8_t **data_out,
 234                      uint64_t *length_out);
 235         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
 236                       uint64_t *length_out);
 237 };
 238
 239 struct sr_datastore {
 240         /* Size in bytes of the number of units stored in this datastore */
 241         int ds_unitsize;
 242         unsigned int num_units; /* TODO: uint64_t */
 243         GSList *chunklist;
 244 };
 245
 246 /*
 247  * This represents a generic device connected to the system.
 248  * For device-specific information, ask the driver. The driver_index refers
 249  * to the device index within that driver; it may be handling more than one
 250  * device. All relevant driver calls take a dev_index parameter for this.
 251  */
 252 struct sr_dev {
 253         /* Which driver handles this device */
 254         struct sr_dev_driver *driver;
 255         /* A driver may handle multiple devices of the same type */
 256         int driver_index;
 257         /* List of struct sr_probe* */
 258         GSList *probes;
 259         /* Data acquired by this device, if any */
 260         struct sr_datastore *datastore;
 261 };
 262
 263 enum {
 264         SR_PROBE_TYPE_LOGIC,
 265 };
 266
 267 struct sr_probe {
 268         int index;
 269         int type;
 270         gboolean enabled;
 271         char *name;
 272         char *trigger;
 273 };
 274
 275 /* Hardware driver capabilities */
 276 enum {
 277         SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 278
 279         /*--- Device classes ------------------------------------------------*/
 280
 281         /** The device can act as logic analyzer. */
 282         SR_HWCAP_LOGIC_ANALYZER,
 283
 284         /** The device can act as an oscilloscope. */
 285         SR_HWCAP_OSCILLOSCOPE,
 286
 287         /*--- Device types --------------------------------------------------*/
 288
 289         /** The device is demo device. */
 290         SR_HWCAP_DEMO_DEV,
 291
 292         /*--- Device options ------------------------------------------------*/
 293
 294         /** The device supports setting/changing its samplerate. */
 295         SR_HWCAP_SAMPLERATE,
 296
 297         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 298         /** The device supports setting a probe mask. */
 299         SR_HWCAP_PROBECONFIG,
 300
 301         /** The device supports setting a pre/post-trigger capture ratio. */
 302         SR_HWCAP_CAPTURE_RATIO,
 303
 304         /* TODO? */
 305         /** The device supports setting a pattern (pattern generator mode). */
 306         SR_HWCAP_PATTERN_MODE,
 307
 308         /** The device supports Run Length Encoding. */
 309         SR_HWCAP_RLE,
 310
 311         /** The device supports setting trigger slope. */
 312         SR_HWCAP_TRIGGER_SLOPE,
 313
 314         /** Trigger source. */
 315         SR_HWCAP_TRIGGER_SOURCE,
 316
 317         /** Horizontal trigger position */
 318         SR_HWCAP_HORIZ_TRIGGERPOS,
 319
 320         /** Buffer size. */
 321         SR_HWCAP_BUFFERSIZE,
 322
 323         /** Time base. */
 324         SR_HWCAP_TIMEBASE,
 325
 326         /** Filter. */
 327         SR_HWCAP_FILTER,
 328
 329         /** Volts/div. */
 330         SR_HWCAP_VDIV,
 331
 332         /** Coupling. */
 333         SR_HWCAP_COUPLING,
 334
 335         /*--- Special stuff -------------------------------------------------*/
 336
 337         /* TODO: Better description. */
 338         /** The device supports specifying a capturefile to inject. */
 339         SR_HWCAP_CAPTUREFILE,
 340
 341         /* TODO: Better description. */
 342         /** The device supports specifying the capturefile unit size. */
 343         SR_HWCAP_CAPTURE_UNITSIZE,
 344
 345         /* TODO: Better description. */
 346         /** The device supports setting the number of probes. */
 347         SR_HWCAP_CAPTURE_NUM_PROBES,
 348
 349         /*--- Acquisition modes ---------------------------------------------*/
 350
 351         /**
 352          * The device supports setting a sample time limit, i.e. how long the
 353          * sample acquisition should run (in ms).
 354          */
 355         SR_HWCAP_LIMIT_MSEC,
 356
 357         /**
 358          * The device supports setting a sample number limit, i.e. how many
 359          * samples should be acquired.
 360          */
 361         SR_HWCAP_LIMIT_SAMPLES,
 362
 363         /**
 364          * The device supports setting a frame limit, i.e. how many
 365          * frames should be acquired.
 366          */
 367         SR_HWCAP_LIMIT_FRAMES,
 368
 369         /**
 370          * The device supports continuous sampling, i.e. neither a time limit
 371          * nor a sample number limit has to be supplied, it will just acquire
 372          * samples continuously, until explicitly stopped by a certain command.
 373          */
 374         SR_HWCAP_CONTINUOUS,
 375
 376 };
 377
 378 struct sr_hwcap_option {
 379         int hwcap;
 380         int type;
 381         char *description;
 382         char *shortname;
 383 };
 384
 385 struct sr_dev_inst {
 386         int index;
 387         int status;
 388         int inst_type;
 389         char *vendor;
 390         char *model;
 391         char *version;
 392         void *priv;
 393 };
 394
 395 /* sr_dev_inst types */
 396 enum {
 397         /** Device instance type for USB devices. */
 398         SR_INST_USB,
 399         /** Device instance type for serial port devices. */
 400         SR_INST_SERIAL,
 401 };
 402
 403 /* Device instance status */
 404 enum {
 405         SR_ST_NOT_FOUND,
 406         /* Found, but still booting */
 407         SR_ST_INITIALIZING,
 408         /* Live, but not in use */
 409         SR_ST_INACTIVE,
 410         /* Actively in use in a session */
 411         SR_ST_ACTIVE,
 412 };
 413
 414 /*
 415  * TODO: This sucks, you just kinda have to "know" the returned type.
 416  * TODO: Need a DI to return the number of trigger stages supported.
 417  */
 418
 419 /* Device info IDs */
 420 enum {
 421         /* struct sr_dev_inst for this specific device */
 422         SR_DI_INST,
 423         /* The number of probes connected to this device */
 424         SR_DI_NUM_PROBES,
 425         /* The probe names on this device */
 426         SR_DI_PROBE_NAMES,
 427         /* Samplerates supported by this device, (struct sr_samplerates) */
 428         SR_DI_SAMPLERATES,
 429         /* Types of logic trigger supported, out of "01crf" (char *) */
 430         SR_DI_TRIGGER_TYPES,
 431         /* The currently set samplerate in Hz (uint64_t) */
 432         SR_DI_CUR_SAMPLERATE,
 433         /* Supported patterns (in pattern generator mode) */
 434         SR_DI_PATTERNS,
 435         /* Supported buffer sizes */
 436         SR_DI_BUFFERSIZES,
 437         /* Supported time bases */
 438         SR_DI_TIMEBASES,
 439         /* Supported trigger sources */
 440         SR_DI_TRIGGER_SOURCES,
 441         /* Supported filter targets */
 442         SR_DI_FILTERS,
 443         /* Valid volts/div values */
 444         SR_DI_VDIVS,
 445         /* Coupling options */
 446         SR_DI_COUPLING,
 447 };
 448
 449 /*
 450  * A device supports either a range of samplerates with steps of a given
 451  * granularity, or is limited to a set of defined samplerates. Use either
 452  * step or list, but not both.
 453  */
 454 struct sr_samplerates {
 455         uint64_t low;
 456         uint64_t high;
 457         uint64_t step;
 458         const uint64_t *list;
 459 };
 460
 461 struct sr_dev_driver {
 462         /* Driver-specific */
 463         char *name;
 464         char *longname;
 465         int api_version;
 466         int (*init) (const char *devinfo);
 467         int (*cleanup) (void);
 468
 469         /* Device-specific */
 470         int (*dev_open) (int dev_index);
 471         int (*dev_close) (int dev_index);
 472         const void *(*dev_info_get) (int dev_index, int dev_info_id);
 473         int (*dev_status_get) (int dev_index);
 474         const int *(*hwcap_get_all) (void);
 475         int (*dev_config_set) (int dev_index, int hwcap, const void *value);
 476         int (*dev_acquisition_start) (int dev_index, void *session_dev_id);
 477         int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
 478 };
 479
 480 struct sr_session {
 481         /* List of struct sr_dev* */
 482         GSList *devs;
 483         /* list of sr_receive_data_callback_t */
 484         GSList *datafeed_callbacks;
 485         GTimeVal starttime;
 486         gboolean running;
 487 };
 488
 489 #include "sigrok-proto.h"
 490
 491 #ifdef __cplusplus
 492 }
 493 #endif
 494
 495 #endif