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