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