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