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 #define SR_MAX_NUM_PROBES       64 /* Limited by uint64_t. */
  59 #define SR_MAX_PROBENAME_LEN    32
  60
  61 /* Handy little macros */
  62 #define SR_HZ(n)  (n)
  63 #define SR_KHZ(n) ((n) * 1000)
  64 #define SR_MHZ(n) ((n) * 1000000)
  65 #define SR_GHZ(n) ((n) * 1000000000)
  66
  67 #define SR_HZ_TO_NS(n) (1000000000 / (n))
  68
  69 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
  70
  71 /* Data types used by hardware plugins for set_configuration() */
  72 enum {
  73         SR_T_UINT64,
  74         SR_T_CHAR,
  75         SR_T_NULL,
  76 };
  77
  78 enum {
  79         SR_PROTO_RAW,
  80 };
  81
  82 /* (Unused) protocol decoder stack entry */
  83 struct sr_protocol {
  84         char *name;
  85         int id;
  86         int stackindex;
  87 };
  88
  89 /* sr_datafeed_packet.type values */
  90 enum {
  91         SR_DF_HEADER,
  92         SR_DF_END,
  93         SR_DF_TRIGGER,
  94         SR_DF_LOGIC,
  95         SR_DF_ANALOG,
  96         SR_DF_PD,
  97 };
  98
  99 struct sr_datafeed_packet {
 100         uint16_t type;
 101         uint64_t length;
 102         uint16_t unitsize;
 103         void *payload;
 104 };
 105
 106 struct sr_datafeed_header {
 107         int feed_version;
 108         struct timeval starttime;
 109         uint64_t samplerate;
 110         int protocol_id;
 111         int num_analog_probes;
 112         int num_logic_probes;
 113 };
 114
 115 struct sr_analog_probe {
 116         uint8_t att;
 117         uint8_t res;    /* Needs to be a power of 2, FIXME */
 118         uint16_t val;   /* Max hardware ADC width is 16bits */
 119 };
 120
 121 struct sr_analog_sample {
 122         uint8_t num_probes; /* Max hardware probes is 256 */
 123         struct sr_analog_probe probes[];
 124 };
 125
 126 struct sr_input {
 127         struct sr_input_format *format;
 128         char *param;
 129         struct sr_device *vdevice;
 130 };
 131
 132 struct sr_input_format {
 133         char *extension;
 134         char *description;
 135         int (*format_match) (const char *filename);
 136         int (*init) (struct sr_input *in);
 137         int (*loadfile) (struct sr_input *in, const char *filename);
 138 };
 139
 140 struct sr_output {
 141         struct sr_output_format *format;
 142         struct sr_device *device;
 143         char *param;
 144         void *internal;
 145 };
 146
 147 struct sr_output_format {
 148         char *extension;
 149         char *description;
 150         int df_type;
 151         int (*init) (struct sr_output *o);
 152         int (*data) (struct sr_output *o, const char *data_in,
 153                      uint64_t length_in, char **data_out, uint64_t *length_out);
 154         int (*event) (struct sr_output *o, int event_type, char **data_out,
 155                       uint64_t *length_out);
 156 };
 157
 158 struct sr_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 struct sr_datastore {
 168         /* Size in bytes of the number of units stored in this datastore */
 169         int ds_unitsize;
 170         unsigned int num_units; /* TODO: uint64_t */
 171         GSList *chunklist;
 172 };
 173
 174 /*
 175  * This represents a generic device connected to the system.
 176  * For device-specific information, ask the plugin. The plugin_index refers
 177  * to the device index within that plugin; it may be handling more than one
 178  * device. All relevant plugin calls take a device_index parameter for this.
 179  */
 180 struct sr_device {
 181         /* Which plugin handles this device */
 182         struct sr_device_plugin *plugin;
 183         /* A plugin may handle multiple devices of the same type */
 184         int plugin_index;
 185         /* List of struct sr_probe* */
 186         GSList *probes;
 187         /* Data acquired by this device, if any */
 188         struct sr_datastore *datastore;
 189 };
 190
 191 enum {
 192         SR_PROBE_TYPE_LOGIC,
 193         SR_PROBE_TYPE_ANALOG,
 194 };
 195
 196 struct sr_probe {
 197         int index;
 198         int type;
 199         gboolean enabled;
 200         char *name;
 201         char *trigger;
 202 };
 203
 204 extern GSList *devices;
 205
 206 /* Hardware plugin capabilities */
 207 enum {
 208         SR_HWCAP_DUMMY,             /* Used to terminate lists */
 209         /* device classes */
 210         SR_HWCAP_LOGIC_ANALYZER,
 211
 212         /* device options */
 213         SR_HWCAP_SAMPLERATE,        /* Change samplerate */
 214         SR_HWCAP_PROBECONFIG,       /* Configure probe mask */
 215         SR_HWCAP_CAPTURE_RATIO,     /* Set pre/post-trigger capture ratio */
 216         SR_HWCAP_PATTERN_MODE,      /* Pattern generator mode */
 217
 218         /* special stuff */
 219         SR_HWCAP_CAPTUREFILE,       /* capturefile to inject */
 220         SR_HWCAP_CAPTURE_UNITSIZE,  /* unitsize of capturefile data */
 221         SR_HWCAP_CAPTURE_NUM_PROBES,/* set number of probes */
 222
 223         /* acquisition modes */
 224         SR_HWCAP_LIMIT_MSEC,        /* Set a time limit for sample acquisition */
 225         SR_HWCAP_LIMIT_SAMPLES,     /* Set a limit on number of samples */
 226         SR_HWCAP_CONTINUOUS,
 227 };
 228
 229 struct sr_hwcap_option {
 230         int capability;
 231         int type;
 232         char *description;
 233         char *shortname;
 234 };
 235
 236 struct sr_device_instance {
 237         int index;
 238         int status;
 239         int instance_type;
 240         char *vendor;
 241         char *model;
 242         char *version;
 243         void *priv;
 244         union {
 245                 struct sr_usb_device_instance *usb;
 246                 struct sr_serial_device_instance *serial;
 247         };
 248 };
 249
 250 /* sr_device_instance types */
 251 enum {
 252         SR_USB_INSTANCE,
 253         SR_SERIAL_INSTANCE,
 254 };
 255
 256 #ifdef HAVE_LIBUSB_1_0
 257 struct sr_usb_device_instance {
 258         uint8_t bus;
 259         uint8_t address;
 260         struct libusb_device_handle *devhdl;
 261 };
 262 #endif
 263
 264 struct sr_serial_device_instance {
 265         char *port;
 266         int fd;
 267 };
 268
 269 /* Device instance status */
 270 enum {
 271         SR_ST_NOT_FOUND,
 272         /* Found, but still booting */
 273         SR_ST_INITIALIZING,
 274         /* Live, but not in use */
 275         SR_ST_INACTIVE,
 276         /* Actively in use in a session */
 277         SR_ST_ACTIVE,
 278 };
 279
 280 /*
 281  * TODO: This sucks, you just kinda have to "know" the returned type.
 282  * TODO: Need a DI to return the number of trigger stages supported.
 283  */
 284
 285 /* Device info IDs */
 286 enum {
 287         /* struct sr_device_instance for this specific device */
 288         SR_DI_INSTANCE,
 289         /* The number of probes connected to this device */
 290         SR_DI_NUM_PROBES,
 291         /* Samplerates supported by this device, (struct sr_samplerates) */
 292         SR_DI_SAMPLERATES,
 293         /* Types of trigger supported, out of "01crf" (char *) */
 294         SR_DI_TRIGGER_TYPES,
 295         /* The currently set samplerate in Hz (uint64_t) */
 296         SR_DI_CUR_SAMPLERATE,
 297         /* Supported pattern generator modes */
 298         SR_DI_PATTERNMODES,
 299 };
 300
 301 /*
 302  * A device supports either a range of samplerates with steps of a given
 303  * granularity, or is limited to a set of defined samplerates. Use either
 304  * step or list, but not both.
 305  */
 306 struct sr_samplerates {
 307         uint64_t low;
 308         uint64_t high;
 309         uint64_t step;
 310         uint64_t *list;
 311 };
 312
 313 struct sr_device_plugin {
 314         /* Plugin-specific */
 315         char *name;
 316         char *longname;
 317         int api_version;
 318         int (*init) (const 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 sr_session {
 333         /* List of struct sr_device* */
 334         GSList *devices;
 335         /* List of struct analyzer* */
 336         GSList *analyzers;
 337         /* list of sr_receive_data_callback */
 338         GSList *datafeed_callbacks;
 339         GTimeVal starttime;
 340         gboolean running;
 341 };
 342
 343 #include "sigrok-proto.h"
 344
 345 #ifdef __cplusplus
 346 }
 347 #endif
 348
 349 #endif