sigrok.h

   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 #include <libusb.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /*
  35  * Status/error codes returned by libsigrok functions.
  36  *
  37  * All possible return codes of libsigrok functions must be listed here.
  38  * Functions should never return hardcoded numbers as status, but rather
  39  * use these #defines instead. All error codes are negative numbers.
  40  *
  41  * The error codes are globally unique in libsigrok, i.e. if one of the
  42  * libsigrok functions returns a "malloc error" it must be exactly the same
  43  * return value as used by all other functions to indicate "malloc error".
  44  * There must be no functions which indicate two different errors via the
  45  * same return code.
  46  *
  47  * Also, for compatibility reasons, no defined return codes are ever removed
  48  * or reused for different #defines later. You can only add new #defines and
  49  * return codes, but never remove or redefine existing ones.
  50  */
  51 #define SIGROK_OK                 0 /* No error */
  52 #define SIGROK_ERR               -1 /* Generic/unspecified error */
  53 #define SIGROK_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
  54 #define SIGROK_ERR_SAMPLERATE    -3 /* Incorrect samplerate */
  55
  56 /* limited by uint64_t */
  57 #define MAX_NUM_PROBES 64
  58 #define MAX_PROBENAME_LEN 32
  59
  60 /* Handy little macros */
  61 #define KHZ(n) ((n) * 1000)
  62 #define MHZ(n) ((n) * 1000000)
  63 #define GHZ(n) ((n) * 1000000000)
  64
  65 #define HZ_TO_NS(n) (1000000000 / (n))
  66
  67 #ifndef ARRAY_SIZE
  68 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  69 #endif
  70
  71 #ifndef ARRAY_AND_SIZE
  72 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  73 #endif
  74
  75 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
  76
  77 /* Data types used by hardware plugins for set_configuration() */
  78 enum {
  79         T_UINT64,
  80         T_CHAR,
  81 };
  82
  83 enum {
  84         PROTO_RAW,
  85 };
  86
  87 /* (Unused) protocol decoder stack entry */
  88 struct protocol {
  89         char *name;
  90         int id;
  91         int stackindex;
  92 };
  93
  94 /* datafeed_packet.type values */
  95 enum {
  96         DF_HEADER,
  97         DF_END,
  98         DF_TRIGGER,
  99         DF_LOGIC,
 100         DF_ANALOG,
 101         DF_PD,
 102 };
 103
 104 struct datafeed_packet {
 105         uint16_t type;
 106         uint64_t length;
 107         uint16_t unitsize;
 108         void *payload;
 109 };
 110
 111 struct datafeed_header {
 112         int feed_version;
 113         struct timeval starttime;
 114         uint64_t samplerate;
 115         int protocol_id;
 116         int num_analog_probes;
 117         int num_logic_probes;
 118 };
 119
 120 struct analog_probe {
 121         uint8_t att;
 122         uint8_t res;    /* Needs to be a power of 2, FIXME */
 123         uint16_t val;   /* Max hardware ADC width is 16bits */
 124 };
 125
 126 struct analog_sample {
 127         uint8_t num_probes; /* Max hardware probes is 256 */
 128         struct analog_probe probes[];
 129 };
 130
 131 struct input {
 132         struct input_format *format;
 133         char *param;
 134         struct device *vdevice;
 135 };
 136
 137 struct input_format {
 138         char *extension;
 139         char *description;
 140         int (*format_match) (const char *filename);
 141         int (*init) (struct input *in);
 142         int (*loadfile) (struct input *in, const char *filename);
 143 };
 144
 145 struct output {
 146         struct output_format *format;
 147         struct device *device;
 148         char *param;
 149         void *internal;
 150 };
 151
 152 struct output_format {
 153         char *extension;
 154         char *description;
 155         int df_type;
 156         int (*init) (struct output *o);
 157         int (*data) (struct output *o, char *data_in, uint64_t length_in,
 158                      char **data_out, uint64_t *length_out);
 159         int (*event) (struct output *o, int event_type, char **data_out,
 160                       uint64_t *length_out);
 161 };
 162
 163 struct analyzer {
 164         char *name;
 165         char *filename;
 166         /*
 167          * TODO: Parameters? If so, configured plugins need another struct.
 168          * TODO: Input and output format?
 169          */
 170 };
 171
 172 /* Size of a chunk in units */
 173 #define DATASTORE_CHUNKSIZE 512000
 174
 175 struct datastore {
 176         /* Size in bytes of the number of units stored in this datastore */
 177         int ds_unitsize;
 178         unsigned int num_units; /* TODO: uint64_t */
 179         GSList *chunklist;
 180 };
 181
 182 /*
 183  * This represents a generic device connected to the system.
 184  * For device-specific information, ask the plugin. The plugin_index refers
 185  * to the device index within that plugin; it may be handling more than one
 186  * device. All relevant plugin calls take a device_index parameter for this.
 187  */
 188 struct device {
 189         /* Which plugin handles this device */
 190         struct device_plugin *plugin;
 191         /* A plugin may handle multiple devices of the same type */
 192         int plugin_index;
 193         /* List of struct probe* */
 194         GSList *probes;
 195         /* Data acquired by this device, if any */
 196         struct datastore *datastore;
 197 };
 198
 199 enum {
 200         PROBE_TYPE_LOGIC,
 201         PROBE_TYPE_ANALOG,
 202 };
 203
 204 struct probe {
 205         int index;
 206         int type;
 207         gboolean enabled;
 208         char *name;
 209         char *trigger;
 210 };
 211
 212 extern GSList *devices;
 213
 214 /* Hardware plugin capabilities */
 215 enum {
 216         HWCAP_DUMMY,             /* Used to terminate lists */
 217         /* device classes */
 218         HWCAP_LOGIC_ANALYZER,
 219
 220         /* device options */
 221         HWCAP_SAMPLERATE,        /* Change samplerate */
 222         HWCAP_PROBECONFIG,       /* Configure probe mask */
 223         HWCAP_CAPTURE_RATIO,     /* Set pre/post-trigger capture ratio */
 224         HWCAP_PATTERN_MODE,      /* Pattern generator mode */
 225
 226         /* acquisition modes */
 227         HWCAP_LIMIT_MSEC,        /* Set a time limit for sample acquisition */
 228         HWCAP_LIMIT_SAMPLES,     /* Set a limit on number of samples */
 229         HWCAP_CONTINUOUS,
 230 };
 231
 232 struct hwcap_option {
 233         int capability;
 234         int type;
 235         char *description;
 236         char *shortname;
 237 };
 238
 239 struct sigrok_device_instance {
 240         int index;
 241         int status;
 242         int instance_type;
 243         char *vendor;
 244         char *model;
 245         char *version;
 246         void *priv;
 247         union {
 248                 struct usb_device_instance *usb;
 249                 struct serial_device_instance *serial;
 250         };
 251 };
 252
 253 /* sigrok_device_instance types */
 254 enum {
 255         USB_INSTANCE,
 256         SERIAL_INSTANCE,
 257 };
 258
 259 struct usb_device_instance {
 260         uint8_t bus;
 261         uint8_t address;
 262         struct libusb_device_handle *devhdl;
 263 };
 264
 265 struct serial_device_instance {
 266         char *port;
 267         int fd;
 268 };
 269
 270 /* Device instance status */
 271 enum {
 272         ST_NOT_FOUND,
 273         /* Found, but still booting */
 274         ST_INITIALIZING,
 275         /* Live, but not in use */
 276         ST_INACTIVE,
 277         /* Actively in use in a session */
 278         ST_ACTIVE,
 279 };
 280
 281 /*
 282  * TODO: This sucks, you just kinda have to "know" the returned type.
 283  * TODO: Need a DI to return the number of trigger stages supported.
 284  */
 285
 286 /* Device info IDs */
 287 enum {
 288         /* struct sigrok_device_instance for this specific device */
 289         DI_INSTANCE,
 290         /* The number of probes connected to this device */
 291         DI_NUM_PROBES,
 292         /* Samplerates supported by this device, (struct samplerates) */
 293         DI_SAMPLERATES,
 294         /* Types of trigger supported, out of "01crf" (char *) */
 295         DI_TRIGGER_TYPES,
 296         /* The currently set samplerate in Hz (uint64_t) */
 297         DI_CUR_SAMPLERATE,
 298         /* Supported pattern generator modes */
 299         DI_PATTERNMODES,
 300 };
 301
 302 /*
 303  * A device supports either a range of samplerates with steps of a given
 304  * granularity, or is limited to a set of defined samplerates. Use either
 305  * step or list, but not both.
 306  */
 307 struct samplerates {
 308         uint64_t low;
 309         uint64_t high;
 310         uint64_t step;
 311         uint64_t *list;
 312 };
 313
 314 struct device_plugin {
 315         /* Plugin-specific */
 316         char *name;
 317         int api_version;
 318         int (*init) (char *deviceinfo);
 319         void (*cleanup) (void);
 320
 321         /* Device-specific */
 322         int (*open) (int device_index);
 323         void (*close) (int device_index);
 324         void *(*get_device_info) (int device_index, int device_info_id);
 325         int (*get_status) (int device_index);
 326         int *(*get_capabilities) (void);
 327         int (*set_configuration) (int device_index, int capability, void *value);
 328         int (*start_acquisition) (int device_index, gpointer session_device_id);
 329         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 330 };
 331
 332 struct gsource_fd {
 333         GSource source;
 334         GPollFD gpfd;
 335         /* Not really using this */
 336         GSource *timeout_source;
 337 };
 338
 339 struct session {
 340         /* List of struct device* */
 341         GSList *devices;
 342         /* List of struct analyzer* */
 343         GSList *analyzers;
 344         /* Datafeed callbacks */
 345         GSList *datafeed_callbacks;
 346         GTimeVal starttime;
 347 };
 348
 349 #include "sigrok-proto.h"
 350
 351 #ifdef __cplusplus
 352 }
 353 #endif
 354
 355 #endif