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