sigrok.h

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010-2012 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 LIBSIGROK_SIGROK_H
  21 #define LIBSIGROK_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
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * Status/error codes returned by libsigrok functions.
  35  *
  36  * All possible return codes of libsigrok functions must be listed here.
  37  * Functions should never return hardcoded numbers as status, but rather
  38  * use these #defines instead. All error codes are negative numbers.
  39  *
  40  * The error codes are globally unique in libsigrok, i.e. if one of the
  41  * libsigrok functions returns a "malloc error" it must be exactly the same
  42  * return value as used by all other functions to indicate "malloc error".
  43  * There must be no functions which indicate two different errors via the
  44  * same return code.
  45  *
  46  * Also, for compatibility reasons, no defined return codes are ever removed
  47  * or reused for different #defines later. You can only add new #defines and
  48  * return codes, but never remove or redefine existing ones.
  49  */
  50 #define SR_OK                 0 /* No error */
  51 #define SR_ERR               -1 /* Generic/unspecified error */
  52 #define SR_ERR_MALLOC        -2 /* Malloc/calloc/realloc error */
  53 #define SR_ERR_ARG           -3 /* Function argument error */
  54 #define SR_ERR_BUG           -4 /* Errors hinting at internal bugs */
  55 #define SR_ERR_SAMPLERATE    -5 /* Incorrect samplerate */
  56
  57 #define SR_MAX_NUM_PROBES    64 /* Limited by uint64_t. */
  58 #define SR_MAX_PROBENAME_LEN 32
  59
  60 /* Handy little macros */
  61 #define SR_HZ(n)  (n)
  62 #define SR_KHZ(n) ((n) * 1000)
  63 #define SR_MHZ(n) ((n) * 1000000)
  64 #define SR_GHZ(n) ((n) * 1000000000)
  65
  66 #define SR_HZ_TO_NS(n) (1000000000 / (n))
  67
  68 /* libsigrok loglevels. */
  69 #define SR_LOG_NONE                0 /**< Output no messages at all. */
  70 #define SR_LOG_ERR            1 /**< Output error messages. */
  71 #define SR_LOG_WARN                2 /**< Output warnings. */
  72 #define SR_LOG_INFO                3 /**< Output informational messages. */
  73 #define SR_LOG_DBG            4 /**< Output debug messages. */
  74 #define SR_LOG_SPEW                5 /**< Output very noisy debug messages. */
  75
  76 /*
  77  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
  78  *
  79  * Variables and functions marked 'static' are private already and don't
  80  * need SR_PRIV. However, functions which are not static (because they need
  81  * to be used in other libsigrok-internal files) but are also not meant to
  82  * be part of the public libsigrok API, must use SR_PRIV.
  83  *
  84  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
  85  *
  86  * Details: http://gcc.gnu.org/wiki/Visibility
  87  */
  88
  89 /* Marks public libsigrok API symbols. */
  90 #define SR_API __attribute__((visibility("default")))
  91
  92 /* Marks private, non-public libsigrok symbols (not part of the API). */
  93 #define SR_PRIV __attribute__((visibility("hidden")))
  94
  95 typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
  96
  97 /* Data types used by hardware plugins for set_configuration() */
  98 enum {
  99         SR_T_UINT64,
 100         SR_T_CHAR,
 101         SR_T_BOOL,
 102 };
 103
 104 /* sr_datafeed_packet.type values */
 105 enum {
 106         SR_DF_HEADER,
 107         SR_DF_END,
 108         SR_DF_TRIGGER,
 109         SR_DF_LOGIC,
 110         SR_DF_PD,
 111 };
 112
 113 struct sr_datafeed_packet {
 114         uint16_t type;
 115         void *payload;
 116 };
 117
 118 struct sr_datafeed_header {
 119         int feed_version;
 120         struct timeval starttime;
 121         uint64_t samplerate;
 122         int num_logic_probes;
 123 };
 124
 125 struct sr_datafeed_logic {
 126         uint64_t length;
 127         uint16_t unitsize;
 128         void *data;
 129 };
 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 struct sr_datastore {
 164         /* Size in bytes of the number of units stored in this datastore */
 165         int ds_unitsize;
 166         unsigned int num_units; /* TODO: uint64_t */
 167         GSList *chunklist;
 168 };
 169
 170 /*
 171  * This represents a generic device connected to the system.
 172  * For device-specific information, ask the plugin. The plugin_index refers
 173  * to the device index within that plugin; it may be handling more than one
 174  * device. All relevant plugin calls take a device_index parameter for this.
 175  */
 176 struct sr_device {
 177         /* Which plugin handles this device */
 178         struct sr_device_plugin *plugin;
 179         /* A plugin may handle multiple devices of the same type */
 180         int plugin_index;
 181         /* List of struct sr_probe* */
 182         GSList *probes;
 183         /* Data acquired by this device, if any */
 184         struct sr_datastore *datastore;
 185 };
 186
 187 enum {
 188         SR_PROBE_TYPE_LOGIC,
 189 };
 190
 191 struct sr_probe {
 192         int index;
 193         int type;
 194         gboolean enabled;
 195         char *name;
 196         char *trigger;
 197 };
 198
 199 /* Hardware plugin capabilities */
 200 enum {
 201         SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
 202
 203         /*--- Device classes ------------------------------------------------*/
 204
 205         /** The device can act as logic analyzer. */
 206         SR_HWCAP_LOGIC_ANALYZER,
 207
 208         /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
 209
 210         /*--- Device types --------------------------------------------------*/
 211
 212         /** The device is demo device. */
 213         SR_HWCAP_DEMO_DEVICE,
 214
 215         /*--- Device options ------------------------------------------------*/
 216
 217         /** The device supports setting/changing its samplerate. */
 218         SR_HWCAP_SAMPLERATE,
 219
 220         /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
 221         /** The device supports setting a probe mask. */
 222         SR_HWCAP_PROBECONFIG,
 223
 224         /** The device supports setting a pre/post-trigger capture ratio. */
 225         SR_HWCAP_CAPTURE_RATIO,
 226
 227         /* TODO? */
 228         /** The device supports setting a pattern (pattern generator mode). */
 229         SR_HWCAP_PATTERN_MODE,
 230
 231         /** The device supports Run Length Encoding. */
 232         SR_HWCAP_RLE,
 233
 234         /*--- Special stuff -------------------------------------------------*/
 235
 236         /* TODO: Better description. */
 237         /** The device supports specifying a capturefile to inject. */
 238         SR_HWCAP_CAPTUREFILE,
 239
 240         /* TODO: Better description. */
 241         /** The device supports specifying the capturefile unit size. */
 242         SR_HWCAP_CAPTURE_UNITSIZE,
 243
 244         /* TODO: Better description. */
 245         /** The device supports setting the number of probes. */
 246         SR_HWCAP_CAPTURE_NUM_PROBES,
 247
 248         /*--- Acquisition modes ---------------------------------------------*/
 249
 250         /**
 251          * The device supports setting a sample time limit, i.e. how long the
 252          * sample acquisition should run (in ms).
 253          */
 254         SR_HWCAP_LIMIT_MSEC,
 255
 256         /**
 257          * The device supports setting a sample number limit, i.e. how many
 258          * samples should be acquired.
 259          */
 260         SR_HWCAP_LIMIT_SAMPLES,
 261
 262         /**
 263          * The device supports continuous sampling, i.e. neither a time limit
 264          * nor a sample number limit has to be supplied, it will just acquire
 265          * samples continuously, until explicitly stopped by a certain command.
 266          */
 267         SR_HWCAP_CONTINUOUS,
 268
 269         /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
 270 };
 271
 272 struct sr_hwcap_option {
 273         int capability;
 274         int type;
 275         char *description;
 276         char *shortname;
 277 };
 278
 279 struct sr_device_instance {
 280         int index;
 281         int status;
 282         int instance_type;
 283         char *vendor;
 284         char *model;
 285         char *version;
 286         void *priv;
 287 };
 288
 289 /* sr_device_instance types */
 290 enum {
 291         SR_USB_INSTANCE,
 292         SR_SERIAL_INSTANCE,
 293 };
 294
 295 /* Device instance status */
 296 enum {
 297         SR_ST_NOT_FOUND,
 298         /* Found, but still booting */
 299         SR_ST_INITIALIZING,
 300         /* Live, but not in use */
 301         SR_ST_INACTIVE,
 302         /* Actively in use in a session */
 303         SR_ST_ACTIVE,
 304 };
 305
 306 /*
 307  * TODO: This sucks, you just kinda have to "know" the returned type.
 308  * TODO: Need a DI to return the number of trigger stages supported.
 309  */
 310
 311 /* Device info IDs */
 312 enum {
 313         /* struct sr_device_instance for this specific device */
 314         SR_DI_INSTANCE,
 315         /* The number of probes connected to this device */
 316         SR_DI_NUM_PROBES,
 317         /* The probe names on this device */
 318         SR_DI_PROBE_NAMES,
 319         /* Samplerates supported by this device, (struct sr_samplerates) */
 320         SR_DI_SAMPLERATES,
 321         /* Types of trigger supported, out of "01crf" (char *) */
 322         SR_DI_TRIGGER_TYPES,
 323         /* The currently set samplerate in Hz (uint64_t) */
 324         SR_DI_CUR_SAMPLERATE,
 325         /* Supported pattern generator modes */
 326         SR_DI_PATTERNMODES,
 327 };
 328
 329 /*
 330  * A device supports either a range of samplerates with steps of a given
 331  * granularity, or is limited to a set of defined samplerates. Use either
 332  * step or list, but not both.
 333  */
 334 struct sr_samplerates {
 335         uint64_t low;
 336         uint64_t high;
 337         uint64_t step;
 338         uint64_t *list;
 339 };
 340
 341 struct sr_device_plugin {
 342         /* Plugin-specific */
 343         char *name;
 344         char *longname;
 345         int api_version;
 346         int (*init) (const char *deviceinfo);
 347         void (*cleanup) (void);
 348
 349         /* Device-specific */
 350         int (*opendev) (int device_index);
 351         int (*closedev) (int device_index);
 352         void *(*get_device_info) (int device_index, int device_info_id);
 353         int (*get_status) (int device_index);
 354         int *(*get_capabilities) (void);
 355         int (*set_configuration) (int device_index, int capability, void *value);
 356         int (*start_acquisition) (int device_index, gpointer session_device_id);
 357         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 358 };
 359
 360 struct sr_session {
 361         /* List of struct sr_device* */
 362         GSList *devices;
 363         /* list of sr_receive_data_callback */
 364         GSList *datafeed_callbacks;
 365         GTimeVal starttime;
 366         gboolean running;
 367 };
 368
 369 #include "sigrok-proto.h"
 370
 371 #ifdef __cplusplus
 372 }
 373 #endif
 374
 375 #endif