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