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  * Details: http://gcc.gnu.org/wiki/Visibility
 119  */
 120
 121 /* Marks public libsigrok API symbols. */
 122 #define SR_API __attribute__((visibility("default")))
 123
 124 /* Marks private, non-public libsigrok symbols (not part of the API). */
 125 #define SR_PRIV __attribute__((visibility("hidden")))
 126
 127 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
 128
 129 /* Data types used by hardware drivers for dev_config_set() */
 130 enum {
 131         SR_T_UINT64,
 132         SR_T_CHAR,
 133         SR_T_BOOL,
 134 };
 135
 136 /* sr_datafeed_packet.type values */
 137 enum {
 138         SR_DF_HEADER,
 139         SR_DF_END,
 140         SR_DF_TRIGGER,
 141         SR_DF_LOGIC,
 142         SR_DF_PD,
 143 };
 144
 145 struct sr_datafeed_packet {
 146         uint16_t type;
 147         void *payload;
 148 };
 149
 150 struct sr_datafeed_header {
 151         int feed_version;
 152         struct timeval starttime;
 153         uint64_t samplerate;
 154         int num_logic_probes;
 155 };
 156
 157 struct sr_datafeed_logic {
 158         uint64_t length;
 159         uint16_t unitsize;
 160         void *data;
 161 };
 162
 163 struct sr_input {
 164         struct sr_input_format *format;
 165         char *param;
 166         struct sr_dev *vdev;
 167 };
 168
 169 struct sr_input_format {
 170         char *id;
 171         char *description;
 172         int (*format_match) (const char *filename);
 173         int (*init) (struct sr_input *in);
 174         int (*loadfile) (struct sr_input *in, const char *filename);
 175 };
 176
 177 struct sr_output {
 178         struct sr_output_format *format;
 179         struct sr_dev *dev;
 180         char *param;
 181         void *internal;
 182 };
 183
 184 struct sr_output_format {
 185         char *id;
 186         char *description;
 187         int df_type;
 188         int (*init) (struct sr_output *o);
 189         int (*data) (struct sr_output *o, const uint8_t *data_in,
 190                      uint64_t length_in, uint8_t **data_out,
 191                      uint64_t *length_out);
 192         int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
 193                       uint64_t *length_out);
 194 };
 195
 196 struct sr_datastore {
 197         /* Size in bytes of the number of units stored in this datastore */
 198         int ds_unitsize;
 199         unsigned int num_units; /* TODO: uint64_t */
 200         GSList *chunklist;
 201 };
 202
 203 /*
 204  * This represents a generic device connected to the system.
 205  * For device-specific information, ask the driver. The driver_index refers
 206  * to the device index within that driver; it may be handling more than one
 207  * device. All relevant driver calls take a dev_index parameter for this.
 208  */
 209 struct sr_dev {
 210         /* Which driver handles this device */
 211         struct sr_dev_driver *driver;
 212         /* A driver may handle multiple devices of the same type */
 213         int driver_index;
 214         /* List of struct sr_probe* */
 215         GSList *probes;
 216         /* Data acquired by this device, if any */
 217         struct sr_datastore *datastore;
 218 };
 219
 220 enum {
 221         SR_PROBE_TYPE_LOGIC,
 222 };
 223
 224 struct sr_probe {
 225         int index;
 226         int type;
 227         gboolean enabled;
 228         char *name;
 229         char *trigger;
 230 };
 231
 232 /* Hardware driver capabilities */
 233 enum {
 234         SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 235
 236         /*--- Device classes ------------------------------------------------*/
 237
 238         /** The device can act as logic analyzer. */
 239         SR_HWCAP_LOGIC_ANALYZER,
 240
 241         /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
 242
 243         /*--- Device types --------------------------------------------------*/
 244
 245         /** The device is demo device. */
 246         SR_HWCAP_DEMO_DEV,
 247
 248         /*--- Device options ------------------------------------------------*/
 249
 250         /** The device supports setting/changing its samplerate. */
 251         SR_HWCAP_SAMPLERATE,
 252
 253         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 254         /** The device supports setting a probe mask. */
 255         SR_HWCAP_PROBECONFIG,
 256
 257         /** The device supports setting a pre/post-trigger capture ratio. */
 258         SR_HWCAP_CAPTURE_RATIO,
 259
 260         /* TODO? */
 261         /** The device supports setting a pattern (pattern generator mode). */
 262         SR_HWCAP_PATTERN_MODE,
 263
 264         /** The device supports Run Length Encoding. */
 265         SR_HWCAP_RLE,
 266
 267         /*--- Special stuff -------------------------------------------------*/
 268
 269         /* TODO: Better description. */
 270         /** The device supports specifying a capturefile to inject. */
 271         SR_HWCAP_CAPTUREFILE,
 272
 273         /* TODO: Better description. */
 274         /** The device supports specifying the capturefile unit size. */
 275         SR_HWCAP_CAPTURE_UNITSIZE,
 276
 277         /* TODO: Better description. */
 278         /** The device supports setting the number of probes. */
 279         SR_HWCAP_CAPTURE_NUM_PROBES,
 280
 281         /*--- Acquisition modes ---------------------------------------------*/
 282
 283         /**
 284          * The device supports setting a sample time limit, i.e. how long the
 285          * sample acquisition should run (in ms).
 286          */
 287         SR_HWCAP_LIMIT_MSEC,
 288
 289         /**
 290          * The device supports setting a sample number limit, i.e. how many
 291          * samples should be acquired.
 292          */
 293         SR_HWCAP_LIMIT_SAMPLES,
 294
 295         /**
 296          * The device supports continuous sampling, i.e. neither a time limit
 297          * nor a sample number limit has to be supplied, it will just acquire
 298          * samples continuously, until explicitly stopped by a certain command.
 299          */
 300         SR_HWCAP_CONTINUOUS,
 301
 302         /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
 303 };
 304
 305 struct sr_hwcap_option {
 306         int hwcap;
 307         int type;
 308         char *description;
 309         char *shortname;
 310 };
 311
 312 struct sr_dev_inst {
 313         int index;
 314         int status;
 315         int inst_type;
 316         char *vendor;
 317         char *model;
 318         char *version;
 319         void *priv;
 320 };
 321
 322 /* sr_dev_inst types */
 323 enum {
 324         /** Device instance type for USB devices. */
 325         SR_INST_USB,
 326         /** Device instance type for serial port devices. */
 327         SR_INST_SERIAL,
 328 };
 329
 330 /* Device instance status */
 331 enum {
 332         SR_ST_NOT_FOUND,
 333         /* Found, but still booting */
 334         SR_ST_INITIALIZING,
 335         /* Live, but not in use */
 336         SR_ST_INACTIVE,
 337         /* Actively in use in a session */
 338         SR_ST_ACTIVE,
 339 };
 340
 341 /*
 342  * TODO: This sucks, you just kinda have to "know" the returned type.
 343  * TODO: Need a DI to return the number of trigger stages supported.
 344  */
 345
 346 /* Device info IDs */
 347 enum {
 348         /* struct sr_dev_inst for this specific device */
 349         SR_DI_INST,
 350         /* The number of probes connected to this device */
 351         SR_DI_NUM_PROBES,
 352         /* The probe names on this device */
 353         SR_DI_PROBE_NAMES,
 354         /* Samplerates supported by this device, (struct sr_samplerates) */
 355         SR_DI_SAMPLERATES,
 356         /* Types of trigger supported, out of "01crf" (char *) */
 357         SR_DI_TRIGGER_TYPES,
 358         /* The currently set samplerate in Hz (uint64_t) */
 359         SR_DI_CUR_SAMPLERATE,
 360         /* Supported patterns (in pattern generator mode) */
 361         SR_DI_PATTERNS,
 362 };
 363
 364 /*
 365  * A device supports either a range of samplerates with steps of a given
 366  * granularity, or is limited to a set of defined samplerates. Use either
 367  * step or list, but not both.
 368  */
 369 struct sr_samplerates {
 370         uint64_t low;
 371         uint64_t high;
 372         uint64_t step;
 373         uint64_t *list;
 374 };
 375
 376 struct sr_dev_driver {
 377         /* Driver-specific */
 378         char *name;
 379         char *longname;
 380         int api_version;
 381         int (*init) (const char *devinfo);
 382         int (*cleanup) (void);
 383
 384         /* Device-specific */
 385         int (*dev_open) (int dev_index);
 386         int (*dev_close) (int dev_index);
 387         void *(*dev_info_get) (int dev_index, int dev_info_id);
 388         int (*dev_status_get) (int dev_index);
 389         int *(*hwcap_get_all) (void);
 390         int (*dev_config_set) (int dev_index, int hwcap, void *value);
 391         int (*dev_acquisition_start) (int dev_index, void *session_dev_id);
 392         int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
 393 };
 394
 395 struct sr_session {
 396         /* List of struct sr_dev* */
 397         GSList *devs;
 398         /* list of sr_receive_data_callback_t */
 399         GSList *datafeed_callbacks;
 400         GTimeVal starttime;
 401         gboolean running;
 402 };
 403
 404 #include "sigrok-proto.h"
 405
 406 #ifdef __cplusplus
 407 }
 408 #endif
 409
 410 #endif