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