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 /*
  77  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
  78  *
  79  * Variables and functions marked 'static' are private already and don't
  80  * need SR_PRIV. However, functions which are not static (because they need
  81  * to be used in other libsigrok-internal files) but are also not meant to
  82  * be part of the public libsigrok API, must use SR_PRIV.
  83  *
  84  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
  85  *
  86  * Details: http://gcc.gnu.org/wiki/Visibility
  87  */
  88
  89 /* Marks public libsigrok API symbols. */
  90 #define SR_API __attribute__((visibility("default")))
  91
  92 /* Marks private, non-public libsigrok symbols (not part of the API). */
  93 #define SR_PRIV __attribute__((visibility("hidden")))
  94
  95 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
  96
  97 /* Data types used by hardware plugins for set_configuration() */
  98 enum {
  99         SR_T_UINT64,
 100         SR_T_CHAR,
 101         SR_T_BOOL,
 102 };
 103
 104 /* sr_datafeed_packet.type values */
 105 enum {
 106         SR_DF_HEADER,
 107         SR_DF_END,
 108         SR_DF_TRIGGER,
 109         SR_DF_LOGIC,
 110         SR_DF_ANALOG,
 111         SR_DF_PD,
 112 };
 113
 114 struct sr_datafeed_packet {
 115         uint16_t type;
 116         void *payload;
 117 };
 118
 119 struct sr_datafeed_header {
 120         int feed_version;
 121         struct timeval starttime;
 122         uint64_t samplerate;
 123         int num_analog_probes;
 124         int num_logic_probes;
 125 };
 126
 127 struct sr_datafeed_logic {
 128         uint64_t length;
 129         uint16_t unitsize;
 130         void *data;
 131 };
 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 = 0, /* Used to terminate lists. Must be 0! */
 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 types --------------------------------------------------*/
 214
 215         /** The device is demo device. */
 216         SR_HWCAP_DEMO_DEVICE,
 217
 218         /*--- Device options ------------------------------------------------*/
 219
 220         /** The device supports setting/changing its samplerate. */
 221         SR_HWCAP_SAMPLERATE,
 222
 223         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 224         /** The device supports setting a probe mask. */
 225         SR_HWCAP_PROBECONFIG,
 226
 227         /** The device supports setting a pre/post-trigger capture ratio. */
 228         SR_HWCAP_CAPTURE_RATIO,
 229
 230         /* TODO? */
 231         /** The device supports setting a pattern (pattern generator mode). */
 232         SR_HWCAP_PATTERN_MODE,
 233
 234         /** The device supports Run Length Encoding. */
 235         SR_HWCAP_RLE,
 236
 237         /*--- Special stuff -------------------------------------------------*/
 238
 239         /* TODO: Better description. */
 240         /** The device supports specifying a capturefile to inject. */
 241         SR_HWCAP_CAPTUREFILE,
 242
 243         /* TODO: Better description. */
 244         /** The device supports specifying the capturefile unit size. */
 245         SR_HWCAP_CAPTURE_UNITSIZE,
 246
 247         /* TODO: Better description. */
 248         /** The device supports setting the number of probes. */
 249         SR_HWCAP_CAPTURE_NUM_PROBES,
 250
 251         /*--- Acquisition modes ---------------------------------------------*/
 252
 253         /**
 254          * The device supports setting a sample time limit, i.e. how long the
 255          * sample acquisition should run (in ms).
 256          */
 257         SR_HWCAP_LIMIT_MSEC,
 258
 259         /**
 260          * The device supports setting a sample number limit, i.e. how many
 261          * samples should be acquired.
 262          */
 263         SR_HWCAP_LIMIT_SAMPLES,
 264
 265         /**
 266          * The device supports continuous sampling, i.e. neither a time limit
 267          * nor a sample number limit has to be supplied, it will just acquire
 268          * samples continuously, until explicitly stopped by a certain command.
 269          */
 270         SR_HWCAP_CONTINUOUS,
 271
 272         /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
 273 };
 274
 275 struct sr_hwcap_option {
 276         int capability;
 277         int type;
 278         char *description;
 279         char *shortname;
 280 };
 281
 282 struct sr_device_instance {
 283         int index;
 284         int status;
 285         int instance_type;
 286         char *vendor;
 287         char *model;
 288         char *version;
 289         void *priv;
 290 };
 291
 292 /* sr_device_instance types */
 293 enum {
 294         SR_USB_INSTANCE,
 295         SR_SERIAL_INSTANCE,
 296 };
 297
 298 /* Device instance status */
 299 enum {
 300         SR_ST_NOT_FOUND,
 301         /* Found, but still booting */
 302         SR_ST_INITIALIZING,
 303         /* Live, but not in use */
 304         SR_ST_INACTIVE,
 305         /* Actively in use in a session */
 306         SR_ST_ACTIVE,
 307 };
 308
 309 /*
 310  * TODO: This sucks, you just kinda have to "know" the returned type.
 311  * TODO: Need a DI to return the number of trigger stages supported.
 312  */
 313
 314 /* Device info IDs */
 315 enum {
 316         /* struct sr_device_instance for this specific device */
 317         SR_DI_INSTANCE,
 318         /* The number of probes connected to this device */
 319         SR_DI_NUM_PROBES,
 320         /* The probe names on this device */
 321         SR_DI_PROBE_NAMES,
 322         /* Samplerates supported by this device, (struct sr_samplerates) */
 323         SR_DI_SAMPLERATES,
 324         /* Types of trigger supported, out of "01crf" (char *) */
 325         SR_DI_TRIGGER_TYPES,
 326         /* The currently set samplerate in Hz (uint64_t) */
 327         SR_DI_CUR_SAMPLERATE,
 328         /* Supported pattern generator modes */
 329         SR_DI_PATTERNMODES,
 330 };
 331
 332 /*
 333  * A device supports either a range of samplerates with steps of a given
 334  * granularity, or is limited to a set of defined samplerates. Use either
 335  * step or list, but not both.
 336  */
 337 struct sr_samplerates {
 338         uint64_t low;
 339         uint64_t high;
 340         uint64_t step;
 341         uint64_t *list;
 342 };
 343
 344 struct sr_device_plugin {
 345         /* Plugin-specific */
 346         char *name;
 347         char *longname;
 348         int api_version;
 349         int (*init) (const char *deviceinfo);
 350         void (*cleanup) (void);
 351
 352         /* Device-specific */
 353         int (*opendev) (int device_index);
 354         int (*closedev) (int device_index);
 355         void *(*get_device_info) (int device_index, int device_info_id);
 356         int (*get_status) (int device_index);
 357         int *(*get_capabilities) (void);
 358         int (*set_configuration) (int device_index, int capability, void *value);
 359         int (*start_acquisition) (int device_index, gpointer session_device_id);
 360         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 361 };
 362
 363 struct sr_session {
 364         /* List of struct sr_device* */
 365         GSList *devices;
 366         /* list of sr_receive_data_callback */
 367         GSList *datafeed_callbacks;
 368         GTimeVal starttime;
 369         gboolean running;
 370 };
 371
 372 #include "sigrok-proto.h"
 373
 374 #ifdef __cplusplus
 375 }
 376 #endif
 377
 378 #endif