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