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 #if defined(HAVE_LA_ALSA)
 121 struct sr_analog_probe {
 122         uint8_t att;
 123         uint8_t res;    /* Needs to be a power of 2, FIXME */
 124         uint16_t val;   /* Max hardware ADC width is 16bits */
 125 };
 126
 127 struct sr_analog_sample {
 128         uint8_t num_probes; /* Max hardware probes is 256 */
 129         struct sr_analog_probe probes[];
 130 };
 131 #endif
 132
 133 struct sr_input {
 134         struct sr_input_format *format;
 135         char *param;
 136         struct sr_device *vdevice;
 137 };
 138
 139 struct sr_input_format {
 140         char *id;
 141         char *description;
 142         int (*format_match) (const char *filename);
 143         int (*init) (struct sr_input *in);
 144         int (*loadfile) (struct sr_input *in, const char *filename);
 145 };
 146
 147 struct sr_output {
 148         struct sr_output_format *format;
 149         struct sr_device *device;
 150         char *param;
 151         void *internal;
 152 };
 153
 154 struct sr_output_format {
 155         char *id;
 156         char *description;
 157         int df_type;
 158         int (*init) (struct sr_output *o);
 159         int (*data) (struct sr_output *o, const char *data_in,
 160                      uint64_t length_in, char **data_out, uint64_t *length_out);
 161         int (*event) (struct sr_output *o, int event_type, char **data_out,
 162                       uint64_t *length_out);
 163 };
 164
 165 struct sr_datastore {
 166         /* Size in bytes of the number of units stored in this datastore */
 167         int ds_unitsize;
 168         unsigned int num_units; /* TODO: uint64_t */
 169         GSList *chunklist;
 170 };
 171
 172 /*
 173  * This represents a generic device connected to the system.
 174  * For device-specific information, ask the plugin. The plugin_index refers
 175  * to the device index within that plugin; it may be handling more than one
 176  * device. All relevant plugin calls take a device_index parameter for this.
 177  */
 178 struct sr_device {
 179         /* Which plugin handles this device */
 180         struct sr_device_plugin *plugin;
 181         /* A plugin may handle multiple devices of the same type */
 182         int plugin_index;
 183         /* List of struct sr_probe* */
 184         GSList *probes;
 185         /* Data acquired by this device, if any */
 186         struct sr_datastore *datastore;
 187 };
 188
 189 enum {
 190         SR_PROBE_TYPE_LOGIC,
 191         SR_PROBE_TYPE_ANALOG,
 192 };
 193
 194 struct sr_probe {
 195         int index;
 196         int type;
 197         gboolean enabled;
 198         char *name;
 199         char *trigger;
 200 };
 201
 202 /* Hardware plugin capabilities */
 203 enum {
 204         SR_HWCAP_DUMMY,             /* Used to terminate lists */
 205
 206         /*--- Device classes ------------------------------------------------*/
 207
 208         /** The device can act as logic analyzer. */
 209         SR_HWCAP_LOGIC_ANALYZER,
 210
 211         /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
 212
 213         /*--- Device options ------------------------------------------------*/
 214
 215         /** The device supports setting/changing its samplerate. */
 216         SR_HWCAP_SAMPLERATE,
 217
 218         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 219         /** The device supports setting a probe mask. */
 220         SR_HWCAP_PROBECONFIG,
 221
 222         /** The device supports setting a pre/post-trigger capture ratio. */
 223         SR_HWCAP_CAPTURE_RATIO,
 224
 225         /* TODO? */
 226         /** The device supports setting a pattern (pattern generator mode). */
 227         SR_HWCAP_PATTERN_MODE,
 228
 229         /** The device supports Run Length Encoding. */
 230         SR_HWCAP_RLE,
 231
 232         /*--- Special stuff -------------------------------------------------*/
 233
 234         /* TODO: Better description. */
 235         /** The device supports specifying a capturefile to inject. */
 236         SR_HWCAP_CAPTUREFILE,
 237
 238         /* TODO: Better description. */
 239         /** The device supports specifying the capturefile unit size. */
 240         SR_HWCAP_CAPTURE_UNITSIZE,
 241
 242         /* TODO: Better description. */
 243         /** The device supports setting the number of probes. */
 244         SR_HWCAP_CAPTURE_NUM_PROBES,
 245
 246         /*--- Acquisition modes ---------------------------------------------*/
 247
 248         /**
 249          * The device supports setting a sample time limit, i.e. how long the
 250          * sample acquisition should run (in ms).
 251          */
 252         SR_HWCAP_LIMIT_MSEC,
 253
 254         /**
 255          * The device supports setting a sample number limit, i.e. how many
 256          * samples should be acquired.
 257          */
 258         SR_HWCAP_LIMIT_SAMPLES,
 259
 260         /**
 261          * The device supports continuous sampling, i.e. neither a time limit
 262          * nor a sample number limit has to be supplied, it will just acquire
 263          * samples continuously, until explicitly stopped by a certain command.
 264          */
 265         SR_HWCAP_CONTINUOUS,
 266
 267         /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
 268 };
 269
 270 struct sr_hwcap_option {
 271         int capability;
 272         int type;
 273         char *description;
 274         char *shortname;
 275 };
 276
 277 struct sr_device_instance {
 278         int index;
 279         int status;
 280         int instance_type;
 281         char *vendor;
 282         char *model;
 283         char *version;
 284         void *priv;
 285         union {
 286                 struct sr_usb_device_instance *usb;
 287                 struct sr_serial_device_instance *serial;
 288         };
 289 };
 290
 291 /* sr_device_instance types */
 292 enum {
 293         SR_USB_INSTANCE,
 294         SR_SERIAL_INSTANCE,
 295 };
 296
 297 #ifdef HAVE_LIBUSB_1_0
 298 struct sr_usb_device_instance {
 299         uint8_t bus;
 300         uint8_t address;
 301         struct libusb_device_handle *devhdl;
 302 };
 303 #endif
 304
 305 struct sr_serial_device_instance {
 306         char *port;
 307         int fd;
 308 };
 309
 310 /* Device instance status */
 311 enum {
 312         SR_ST_NOT_FOUND,
 313         /* Found, but still booting */
 314         SR_ST_INITIALIZING,
 315         /* Live, but not in use */
 316         SR_ST_INACTIVE,
 317         /* Actively in use in a session */
 318         SR_ST_ACTIVE,
 319 };
 320
 321 /*
 322  * TODO: This sucks, you just kinda have to "know" the returned type.
 323  * TODO: Need a DI to return the number of trigger stages supported.
 324  */
 325
 326 /* Device info IDs */
 327 enum {
 328         /* struct sr_device_instance for this specific device */
 329         SR_DI_INSTANCE,
 330         /* The number of probes connected to this device */
 331         SR_DI_NUM_PROBES,
 332         /* The probe names on this device */
 333         SR_DI_PROBE_NAMES,
 334         /* Samplerates supported by this device, (struct sr_samplerates) */
 335         SR_DI_SAMPLERATES,
 336         /* Types of trigger supported, out of "01crf" (char *) */
 337         SR_DI_TRIGGER_TYPES,
 338         /* The currently set samplerate in Hz (uint64_t) */
 339         SR_DI_CUR_SAMPLERATE,
 340         /* Supported pattern generator modes */
 341         SR_DI_PATTERNMODES,
 342 };
 343
 344 /*
 345  * A device supports either a range of samplerates with steps of a given
 346  * granularity, or is limited to a set of defined samplerates. Use either
 347  * step or list, but not both.
 348  */
 349 struct sr_samplerates {
 350         uint64_t low;
 351         uint64_t high;
 352         uint64_t step;
 353         uint64_t *list;
 354 };
 355
 356 struct sr_device_plugin {
 357         /* Plugin-specific */
 358         char *name;
 359         char *longname;
 360         int api_version;
 361         int (*init) (const char *deviceinfo);
 362         void (*cleanup) (void);
 363
 364         /* Device-specific */
 365         int (*opendev) (int device_index);
 366         int (*closedev) (int device_index);
 367         void *(*get_device_info) (int device_index, int device_info_id);
 368         int (*get_status) (int device_index);
 369         int *(*get_capabilities) (void);
 370         int (*set_configuration) (int device_index, int capability, void *value);
 371         int (*start_acquisition) (int device_index, gpointer session_device_id);
 372         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 373 };
 374
 375 struct sr_session {
 376         /* List of struct sr_device* */
 377         GSList *devices;
 378         /* List of struct analyzer* */
 379         GSList *analyzers;
 380         /* list of sr_receive_data_callback */
 381         GSList *datafeed_callbacks;
 382         GTimeVal starttime;
 383         gboolean running;
 384 };
 385
 386 #include "sigrok-proto.h"
 387
 388 #ifdef __cplusplus
 389 }
 390 #endif
 391
 392 #endif