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