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