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