sigrok.h.in

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