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