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 input {
 121         struct input_format *format;
 122         char *param;
 123         struct device *vdevice;
 124 };
 125
 126 struct input_format {
 127         char *extension;
 128         char *description;
 129         int (*format_match) (const char *filename);
 130         int (*init) (struct input *in);
 131         int (*loadfile) (struct input *in, const char *filename);
 132 };
 133
 134 struct output {
 135         struct output_format *format;
 136         struct device *device;
 137         char *param;
 138         void *internal;
 139 };
 140
 141 struct output_format {
 142         char *extension;
 143         char *description;
 144         int df_type;
 145         int (*init) (struct output *o);
 146         int (*data) (struct output *o, char *data_in, uint64_t length_in,
 147                      char **data_out, uint64_t *length_out);
 148         int (*event) (struct output *o, int event_type, char **data_out,
 149                       uint64_t *length_out);
 150 };
 151
 152 struct analyzer {
 153         char *name;
 154         char *filename;
 155         /*
 156          * TODO: Parameters? If so, configured plugins need another struct.
 157          * TODO: Input and output format?
 158          */
 159 };
 160
 161 /* Size of a chunk in units */
 162 #define DATASTORE_CHUNKSIZE 512000
 163
 164 struct datastore {
 165         /* Size in bytes of the number of units stored in this datastore */
 166         int ds_unitsize;
 167         unsigned int num_units; /* TODO: uint64_t */
 168         GSList *chunklist;
 169 };
 170
 171 /*
 172  * This represents a generic device connected to the system.
 173  * For device-specific information, ask the plugin. The plugin_index refers
 174  * to the device index within that plugin; it may be handling more than one
 175  * device. All relevant plugin calls take a device_index parameter for this.
 176  */
 177 struct device {
 178         /* Which plugin handles this device */
 179         struct device_plugin *plugin;
 180         /* A plugin may handle multiple devices of the same type */
 181         int plugin_index;
 182         /* List of struct probe* */
 183         GSList *probes;
 184         /* Data acquired by this device, if any */
 185         struct datastore *datastore;
 186 };
 187
 188 enum {
 189         PROBE_TYPE_LOGIC,
 190         PROBE_TYPE_ANALOG,
 191 };
 192
 193 struct probe {
 194         int index;
 195         int type;
 196         gboolean enabled;
 197         char *name;
 198         char *trigger;
 199 };
 200
 201 extern GSList *devices;
 202
 203 /* Hardware plugin capabilities */
 204 enum {
 205         HWCAP_DUMMY,             /* Used to terminate lists */
 206         /* device classes */
 207         HWCAP_LOGIC_ANALYZER,
 208
 209         /* device options */
 210         HWCAP_SAMPLERATE,        /* Change samplerate */
 211         HWCAP_PROBECONFIG,       /* Configure probe mask */
 212         HWCAP_CAPTURE_RATIO,     /* Set pre/post-trigger capture ratio */
 213         HWCAP_PATTERN_MODE,      /* Pattern generator mode */
 214
 215         /* acquisition modes */
 216         HWCAP_LIMIT_MSEC,        /* Set a time limit for sample acquisition */
 217         HWCAP_LIMIT_SAMPLES,     /* Set a limit on number of samples */
 218         HWCAP_CONTINUOUS,
 219 };
 220
 221 struct hwcap_option {
 222         int capability;
 223         int type;
 224         char *description;
 225         char *shortname;
 226 };
 227
 228 struct sigrok_device_instance {
 229         int index;
 230         int status;
 231         int instance_type;
 232         char *vendor;
 233         char *model;
 234         char *version;
 235         void *priv;
 236         union {
 237                 struct usb_device_instance *usb;
 238                 struct serial_device_instance *serial;
 239         };
 240 };
 241
 242 /* sigrok_device_instance types */
 243 enum {
 244         USB_INSTANCE,
 245         SERIAL_INSTANCE,
 246 };
 247
 248 struct usb_device_instance {
 249         uint8_t bus;
 250         uint8_t address;
 251         struct libusb_device_handle *devhdl;
 252 };
 253
 254 struct serial_device_instance {
 255         char *port;
 256         int fd;
 257 };
 258
 259 /* Device instance status */
 260 enum {
 261         ST_NOT_FOUND,
 262         /* Found, but still booting */
 263         ST_INITIALIZING,
 264         /* Live, but not in use */
 265         ST_INACTIVE,
 266         /* Actively in use in a session */
 267         ST_ACTIVE,
 268 };
 269
 270 /*
 271  * TODO: This sucks, you just kinda have to "know" the returned type.
 272  * TODO: Need a DI to return the number of trigger stages supported.
 273  */
 274
 275 /* Device info IDs */
 276 enum {
 277         /* struct sigrok_device_instance for this specific device */
 278         DI_INSTANCE,
 279         /* The number of probes connected to this device */
 280         DI_NUM_PROBES,
 281         /* Samplerates supported by this device, (struct samplerates) */
 282         DI_SAMPLERATES,
 283         /* Types of trigger supported, out of "01crf" (char *) */
 284         DI_TRIGGER_TYPES,
 285         /* The currently set samplerate in Hz (uint64_t) */
 286         DI_CUR_SAMPLERATE,
 287         /* Supported pattern generator modes */
 288         DI_PATTERNMODES,
 289 };
 290
 291 /*
 292  * A device supports either a range of samplerates with steps of a given
 293  * granularity, or is limited to a set of defined samplerates. Use either
 294  * step or list, but not both.
 295  */
 296 struct samplerates {
 297         uint64_t low;
 298         uint64_t high;
 299         uint64_t step;
 300         uint64_t *list;
 301 };
 302
 303 struct device_plugin {
 304         /* Plugin-specific */
 305         char *name;
 306         int api_version;
 307         int (*init) (char *deviceinfo);
 308         void (*cleanup) (void);
 309
 310         /* Device-specific */
 311         int (*open) (int device_index);
 312         void (*close) (int device_index);
 313         void *(*get_device_info) (int device_index, int device_info_id);
 314         int (*get_status) (int device_index);
 315         int *(*get_capabilities) (void);
 316         int (*set_configuration) (int device_index, int capability, void *value);
 317         int (*start_acquisition) (int device_index, gpointer session_device_id);
 318         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 319 };
 320
 321 struct gsource_fd {
 322         GSource source;
 323         GPollFD gpfd;
 324         /* Not really using this */
 325         GSource *timeout_source;
 326 };
 327
 328 struct session {
 329         /* List of struct device* */
 330         GSList *devices;
 331         /* List of struct analyzer* */
 332         GSList *analyzers;
 333         /* Datafeed callbacks */
 334         GSList *datafeed_callbacks;
 335         GTimeVal starttime;
 336 };
 337
 338 #include "sigrok-proto.h"
 339
 340 #ifdef __cplusplus
 341 }
 342 #endif
 343
 344 #endif