sigrok.h.in

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 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 SIGROK_SIGROK_H
  21 #define SIGROK_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 #ifdef HAVE_LIBUSB_1_0
  29 #include <libusb.h>
  30 #endif
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #define SIGROK_MAJOR_VERSION @SIGROK_MAJOR_VERSION@
  37 #define SIGROK_MINOR_VERSION @SIGROK_MINOR_VERSION@
  38 #define SIGROK_MICRO_VERSION @SIGROK_MICRO_VERSION@
  39 #define SIGROK_VERSION       "@SIGROK_VERSION@"
  40
  41 /*
  42  * Status/error codes returned by libsigrok functions.
  43  *
  44  * All possible return codes of libsigrok functions must be listed here.
  45  * Functions should never return hardcoded numbers as status, but rather
  46  * use these #defines instead. All error codes are negative numbers.
  47  *
  48  * The error codes are globally unique in libsigrok, i.e. if one of the
  49  * libsigrok functions returns a "malloc error" it must be exactly the same
  50  * return value as used by all other functions to indicate "malloc error".
  51  * There must be no functions which indicate two different errors via the
  52  * same return code.
  53  *
  54  * Also, for compatibility reasons, no defined return codes are ever removed
  55  * or reused for different #defines later. You can only add new #defines and
  56  * return codes, but never remove or redefine existing ones.
  57  */
  58 #define SR_OK                 0 /* No error */
  59 #define SR_ERR               -1 /* Generic/unspecified error */
  60 #define SR_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
  61 #define SR_ERR_ARG           -3 /* Function argument error */
  62 #define SR_ERR_SAMPLERATE    -4 /* Incorrect samplerate */
  63
  64 #define SR_MAX_NUM_PROBES       64 /* Limited by uint64_t. */
  65 #define SR_MAX_PROBENAME_LEN    32
  66
  67 /* Handy little macros */
  68 #define SR_HZ(n)  (n)
  69 #define SR_KHZ(n) ((n) * 1000)
  70 #define SR_MHZ(n) ((n) * 1000000)
  71 #define SR_GHZ(n) ((n) * 1000000000)
  72
  73 #define SR_HZ_TO_NS(n) (1000000000 / (n))
  74
  75 /* libsigrok loglevels. */
  76 #define SR_LOG_NONE      0
  77 #define SR_LOG_ERR       1
  78 #define SR_LOG_WARN      2
  79 #define SR_LOG_INFO      3
  80 #define SR_LOG_DBG       4
  81 #define SR_LOG_SPEW      5
  82
  83 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
  84
  85 /* Data types used by hardware plugins for set_configuration() */
  86 enum {
  87         SR_T_UINT64,
  88         SR_T_CHAR,
  89         SR_T_NULL,
  90 };
  91
  92 #if 0
  93 /* (Unused) protocol decoder stack entry */
  94 struct sr_protocol {
  95         char *name;
  96         int id;
  97         int stackindex;
  98 };
  99 #endif
 100
 101 /* sr_datafeed_packet.type values */
 102 enum {
 103         SR_DF_HEADER,
 104         SR_DF_END,
 105         SR_DF_TRIGGER,
 106         SR_DF_LOGIC,
 107         SR_DF_ANALOG,
 108         SR_DF_PD,
 109 };
 110
 111 struct sr_datafeed_packet {
 112         uint16_t type;
 113         /* timeoffset since start, in picoseconds */
 114         uint64_t timeoffset;
 115         /* duration of data in this packet, in picoseconds */
 116         uint64_t duration;
 117         void *payload;
 118 };
 119
 120 struct sr_datafeed_header {
 121         int feed_version;
 122         struct timeval starttime;
 123         uint64_t samplerate;
 124         int num_analog_probes;
 125         int num_logic_probes;
 126 };
 127
 128 struct sr_datafeed_logic {
 129         uint64_t length;
 130         uint16_t unitsize;
 131         void *data;
 132 };
 133
 134 struct sr_datafeed_pd {
 135         char *protocol;
 136         char *annotation;
 137         unsigned char *data;
 138 };
 139
 140 #if defined(HAVE_LA_ALSA)
 141 struct sr_analog_probe {
 142         uint8_t att;
 143         uint8_t res;    /* Needs to be a power of 2, FIXME */
 144         uint16_t val;   /* Max hardware ADC width is 16bits */
 145 };
 146
 147 struct sr_analog_sample {
 148         uint8_t num_probes; /* Max hardware probes is 256 */
 149         struct sr_analog_probe probes[];
 150 };
 151 #endif
 152
 153 struct sr_input {
 154         struct sr_input_format *format;
 155         char *param;
 156         struct sr_device *vdevice;
 157 };
 158
 159 struct sr_input_format {
 160         char *id;
 161         char *description;
 162         int (*format_match) (const char *filename);
 163         int (*init) (struct sr_input *in);
 164         int (*loadfile) (struct sr_input *in, const char *filename);
 165 };
 166
 167 struct sr_output {
 168         struct sr_output_format *format;
 169         struct sr_device *device;
 170         char *param;
 171         void *internal;
 172 };
 173
 174 struct sr_output_format {
 175         char *id;
 176         char *description;
 177         int df_type;
 178         int (*init) (struct sr_output *o);
 179         int (*data) (struct sr_output *o, const char *data_in,
 180                      uint64_t length_in, char **data_out, uint64_t *length_out);
 181         int (*event) (struct sr_output *o, int event_type, char **data_out,
 182                       uint64_t *length_out);
 183 };
 184
 185 #if 0
 186 struct sr_analyzer {
 187         char *name;
 188         char *filename;
 189         /*
 190          * TODO: Parameters? If so, configured plugins need another struct.
 191          * TODO: Input and output format?
 192          */
 193 };
 194 #endif
 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 plugin. The plugin_index refers
 206  * to the device index within that plugin; it may be handling more than one
 207  * device. All relevant plugin calls take a device_index parameter for this.
 208  */
 209 struct sr_device {
 210         /* Which plugin handles this device */
 211         struct sr_device_plugin *plugin;
 212         /* A plugin may handle multiple devices of the same type */
 213         int plugin_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         SR_PROBE_TYPE_ANALOG,
 223 };
 224
 225 struct sr_probe {
 226         int index;
 227         int type;
 228         gboolean enabled;
 229         char *name;
 230         char *trigger;
 231 };
 232
 233 /* TODO: Get rid of this global variable. */
 234 extern GSList *devices;
 235
 236 /* Hardware plugin capabilities */
 237 enum {
 238         SR_HWCAP_DUMMY,             /* Used to terminate lists */
 239
 240         /*--- Device classes ------------------------------------------------*/
 241
 242         /** The device can act as logic analyzer. */
 243         SR_HWCAP_LOGIC_ANALYZER,
 244
 245         /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
 246
 247         /*--- Device options ------------------------------------------------*/
 248
 249         /** The device supports setting/changing its samplerate. */
 250         SR_HWCAP_SAMPLERATE,
 251
 252         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 253         /** The device supports setting a probe mask. */
 254         SR_HWCAP_PROBECONFIG,
 255
 256         /** The device supports setting a pre/post-trigger capture ratio. */
 257         SR_HWCAP_CAPTURE_RATIO,
 258
 259         /* TODO? */
 260         /** The device supports setting a pattern (pattern generator mode). */
 261         SR_HWCAP_PATTERN_MODE,
 262
 263         /** The device supports Run Length Encoding. */
 264         SR_HWCAP_RLE,
 265
 266         /*--- Special stuff -------------------------------------------------*/
 267
 268         /* TODO: Better description. */
 269         /** The device supports specifying a capturefile to inject. */
 270         SR_HWCAP_CAPTUREFILE,
 271
 272         /* TODO: Better description. */
 273         /** The device supports specifying the capturefile unit size. */
 274         SR_HWCAP_CAPTURE_UNITSIZE,
 275
 276         /* TODO: Better description. */
 277         /** The device supports setting the number of probes. */
 278         SR_HWCAP_CAPTURE_NUM_PROBES,
 279
 280         /*--- Acquisition modes ---------------------------------------------*/
 281
 282         /**
 283          * The device supports setting a sample time limit, i.e. how long the
 284          * sample acquisition should run (in ms).
 285          */
 286         SR_HWCAP_LIMIT_MSEC,
 287
 288         /**
 289          * The device supports setting a sample number limit, i.e. how many
 290          * samples should be acquired.
 291          */
 292         SR_HWCAP_LIMIT_SAMPLES,
 293
 294         /**
 295          * The device supports continuous sampling, i.e. neither a time limit
 296          * nor a sample number limit has to be supplied, it will just acquire
 297          * samples continuously, until explicitly stopped by a certain command.
 298          */
 299         SR_HWCAP_CONTINUOUS,
 300
 301         /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
 302 };
 303
 304 struct sr_hwcap_option {
 305         int capability;
 306         int type;
 307         char *description;
 308         char *shortname;
 309 };
 310
 311 struct sr_device_instance {
 312         int index;
 313         int status;
 314         int instance_type;
 315         char *vendor;
 316         char *model;
 317         char *version;
 318         void *priv;
 319         union {
 320                 struct sr_usb_device_instance *usb;
 321                 struct sr_serial_device_instance *serial;
 322         };
 323 };
 324
 325 /* sr_device_instance types */
 326 enum {
 327         SR_USB_INSTANCE,
 328         SR_SERIAL_INSTANCE,
 329 };
 330
 331 #ifdef HAVE_LIBUSB_1_0
 332 struct sr_usb_device_instance {
 333         uint8_t bus;
 334         uint8_t address;
 335         struct libusb_device_handle *devhdl;
 336 };
 337 #endif
 338
 339 struct sr_serial_device_instance {
 340         char *port;
 341         int fd;
 342 };
 343
 344 /* Device instance status */
 345 enum {
 346         SR_ST_NOT_FOUND,
 347         /* Found, but still booting */
 348         SR_ST_INITIALIZING,
 349         /* Live, but not in use */
 350         SR_ST_INACTIVE,
 351         /* Actively in use in a session */
 352         SR_ST_ACTIVE,
 353 };
 354
 355 /*
 356  * TODO: This sucks, you just kinda have to "know" the returned type.
 357  * TODO: Need a DI to return the number of trigger stages supported.
 358  */
 359
 360 /* Device info IDs */
 361 enum {
 362         /* struct sr_device_instance for this specific device */
 363         SR_DI_INSTANCE,
 364         /* The number of probes connected to this device */
 365         SR_DI_NUM_PROBES,
 366         /* Samplerates supported by this device, (struct sr_samplerates) */
 367         SR_DI_SAMPLERATES,
 368         /* Types of trigger supported, out of "01crf" (char *) */
 369         SR_DI_TRIGGER_TYPES,
 370         /* The currently set samplerate in Hz (uint64_t) */
 371         SR_DI_CUR_SAMPLERATE,
 372         /* Supported pattern generator modes */
 373         SR_DI_PATTERNMODES,
 374 };
 375
 376 /*
 377  * A device supports either a range of samplerates with steps of a given
 378  * granularity, or is limited to a set of defined samplerates. Use either
 379  * step or list, but not both.
 380  */
 381 struct sr_samplerates {
 382         uint64_t low;
 383         uint64_t high;
 384         uint64_t step;
 385         uint64_t *list;
 386 };
 387
 388 struct sr_device_plugin {
 389         /* Plugin-specific */
 390         char *name;
 391         char *longname;
 392         int api_version;
 393         int (*init) (const char *deviceinfo);
 394         void (*cleanup) (void);
 395
 396         /* Device-specific */
 397         int (*opendev) (int device_index);
 398         int (*closedev) (int device_index);
 399         void *(*get_device_info) (int device_index, int device_info_id);
 400         int (*get_status) (int device_index);
 401         int *(*get_capabilities) (void);
 402         int (*set_configuration) (int device_index, int capability, void *value);
 403         int (*start_acquisition) (int device_index, gpointer session_device_id);
 404         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 405 };
 406
 407 struct sr_session {
 408         /* List of struct sr_device* */
 409         GSList *devices;
 410         /* List of struct analyzer* */
 411         GSList *analyzers;
 412         /* list of sr_receive_data_callback */
 413         GSList *datafeed_callbacks;
 414         GTimeVal starttime;
 415         gboolean running;
 416 };
 417
 418 #include "sigrok-proto.h"
 419
 420 #ifdef __cplusplus
 421 }
 422 #endif
 423
 424 #endif