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  * Status/error codes returned by libsigrok functions.
  32  *
  33  * All possible return codes of libsigrok functions must be listed here.
  34  * Functions should never return hardcoded numbers as status, but rather
  35  * use these #defines instead. All error codes are negative numbers.
  36  *
  37  * The error codes are globally unique in libsigrok, i.e. if one of the
  38  * libsigrok functions returns a "malloc error" it must be exactly the same
  39  * return value as used by all other functions to indicate "malloc error".
  40  * There must be no functions which indicate two different errors via the
  41  * same return code.
  42  *
  43  * Also, for compatibility reasons, no defined return codes are ever removed
  44  * or reused for different #defines later. You can only add new #defines and
  45  * return codes, but never remove or redefine existing ones.
  46  */
  47 #define SIGROK_OK                        0 /* No error */
  48 #define SIGROK_ERR                      -1 /* Generic/unspecified error */
  49 #define SIGROK_ERR_MALLOC               -2 /* Malloc/calloc/realloc error */
  50 #define SIGROK_ERR_SAMPLERATE           -3 /* Incorrect samplerate */
  51
  52 /* limited by uint64_t */
  53 #define MAX_NUM_PROBES 64
  54 #define MAX_PROBENAME_LEN 32
  55
  56
  57 /* Handy little macros */
  58 #define KHZ(n) ((n) * 1000)
  59 #define MHZ(n) ((n) * 1000000)
  60 #define GHZ(n) ((n) * 1000000000)
  61
  62 #ifndef ARRAY_SIZE
  63 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
  64 #endif
  65
  66 #ifndef ARRAY_AND_SIZE
  67 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
  68 #endif
  69
  70 /* Data types, used by hardware plugins for set_configuration() */
  71 enum {
  72         T_UINT64,
  73         T_CHAR,
  74 };
  75
  76 enum {
  77         PROTO_RAW,
  78 };
  79
  80 /* (Unused) protocol decoder stack entry */
  81 struct protocol {
  82         char *name;
  83         int id;
  84         int stackindex;
  85 };
  86
  87 /*
  88  * Datafeed
  89  */
  90
  91 /* datafeed_packet.type values */
  92 enum {
  93         DF_HEADER,
  94         DF_END,
  95         DF_TRIGGER,
  96         DF_LOGIC,
  97         DF_PD,
  98 };
  99
 100 struct datafeed_packet {
 101         uint16_t type;
 102         uint64_t length;
 103         uint16_t unitsize;
 104         void *payload;
 105 };
 106
 107 struct datafeed_header {
 108         int feed_version;
 109         struct timeval starttime;
 110         uint64_t samplerate;
 111         int protocol_id;
 112         int num_probes;
 113 };
 114
 115 /*
 116  * Input
 117  */
 118 struct input {
 119         struct input_format *format;
 120         void *param;
 121         void *internal;
 122 };
 123
 124 struct input_format {
 125         char *extension;
 126         char *description;
 127         int (*format_match) (const char *filename);
 128         int (*in_loadfile) (const char *filename);
 129 };
 130
 131 struct input_format **input_list(void);
 132
 133
 134 /*
 135  * Output
 136  */
 137 struct output {
 138         struct output_format *format;
 139         struct device *device;
 140         char *param;
 141         void *internal;
 142 };
 143
 144 struct output_format {
 145         char *extension;
 146         char *description;
 147         int df_type;
 148         int (*init) (struct output *o);
 149         int (*data) (struct output *o, char *data_in, uint64_t length_in,
 150                      char **data_out, uint64_t *length_out);
 151         int (*event) (struct output *o, int event_type, char **data_out,
 152                       uint64_t *length_out);
 153 };
 154
 155 struct output_format **output_list(void);
 156
 157
 158 int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
 159                   char *data_in, uint64_t length_in, char **data_out,
 160                   uint64_t *length_out);
 161
 162 char *sigrok_samplerate_string(uint64_t samplerate);
 163 char *sigrok_period_string(uint64_t frequency);
 164
 165 /*--- analyzer.c ------------------------------------------------------------*/
 166
 167 struct analyzer {
 168         char *name;
 169         char *filename;
 170         /*
 171          * TODO: Parameters? If so, configured plugins need another struct.
 172          * TODO: Input and output format?
 173          */
 174 };
 175
 176 /*--- backend.c -------------------------------------------------------------*/
 177
 178 int sigrok_init(void);
 179 void sigrok_cleanup(void);
 180
 181 /*--- datastore.c -----------------------------------------------------------*/
 182
 183 /* Size of a chunk in units */
 184 #define DATASTORE_CHUNKSIZE 512000
 185
 186 struct datastore {
 187         /* Size in bytes of the number of units stored in this datastore */
 188         int ds_unitsize;
 189         unsigned int num_units; /* TODO: uint64_t */
 190         GSList *chunklist;
 191 };
 192
 193 int datastore_new(int unitsize, struct datastore **ds);
 194 int datastore_destroy(struct datastore *ds);
 195 void datastore_put(struct datastore *ds, void *data, unsigned int length,
 196                    int in_unitsize, int *probelist);
 197
 198 /*--- debug.c ---------------------------------------------------------------*/
 199
 200 void hexdump(unsigned char *address, int length);
 201
 202 /*--- device.c --------------------------------------------------------------*/
 203
 204 /*
 205  * This represents a generic device connected to the system.
 206  * For device-specific information, ask the plugin. The plugin_index refers
 207  * to the device index within that plugin; it may be handling more than one
 208  * device. All relevant plugin calls take a device_index parameter for this.
 209  */
 210 struct device {
 211         /* Which plugin handles this device */
 212         struct device_plugin *plugin;
 213         /* A plugin may handle multiple devices of the same type */
 214         int plugin_index;
 215         /* List of struct probe* */
 216         GSList *probes;
 217         /* Data acquired by this device, if any */
 218         struct datastore *datastore;
 219 };
 220
 221 struct probe {
 222         int index;
 223         gboolean enabled;
 224         char *name;
 225         char *trigger;
 226 };
 227
 228 extern GSList *devices;
 229
 230 void device_scan(void);
 231 void device_close_all(void);
 232 GSList *device_list(void);
 233 struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes);
 234 void device_clear(struct device *device);
 235 void device_destroy(struct device *dev);
 236
 237 void device_probe_clear(struct device *device, int probenum);
 238 void device_probe_add(struct device *device, char *name);
 239 struct probe *probe_find(struct device *device, int probenum);
 240 void device_probe_name(struct device *device, int probenum, char *name);
 241
 242 void device_trigger_clear(struct device *device);
 243 void device_trigger_set(struct device *device, int probenum, char *trigger);
 244
 245 /*--- hwplugin.c ------------------------------------------------------------*/
 246
 247 /* Hardware plugin capabilities */
 248 enum {
 249         HWCAP_DUMMY,            /* Used to terminate lists */
 250         HWCAP_LOGIC_ANALYZER,
 251         HWCAP_SAMPLERATE,       /* Change samplerate */
 252         HWCAP_PROBECONFIG,      /* Configure probe mask */
 253         HWCAP_CAPTURE_RATIO,    /* Set pre/post-trigger capture ratio */
 254         HWCAP_LIMIT_MSEC,       /* Set a time limit for sample acquisition */
 255         HWCAP_LIMIT_SAMPLES,    /* Set a limit on number of samples */
 256 };
 257
 258 struct hwcap_option {
 259         int capability;
 260         int type;
 261         char *description;
 262         char *shortname;
 263 };
 264
 265 struct sigrok_device_instance {
 266         int index;
 267         int status;
 268         int instance_type;
 269         char *vendor;
 270         char *model;
 271         char *version;
 272         void *priv;
 273         union {
 274                 struct usb_device_instance *usb;
 275                 struct serial_device_instance *serial;
 276         };
 277 };
 278
 279 /* sigrok_device_instance types */
 280 enum {
 281         USB_INSTANCE,
 282         SERIAL_INSTANCE,
 283 };
 284
 285 struct usb_device_instance {
 286         uint8_t bus;
 287         uint8_t address;
 288         struct libusb_device_handle *devhdl;
 289 };
 290
 291 struct serial_device_instance {
 292         char *port;
 293         int fd;
 294 };
 295
 296 /* Device instance status */
 297 enum {
 298         ST_NOT_FOUND,
 299         /* Found, but still booting */
 300         ST_INITIALIZING,
 301         /* Live, but not in use */
 302         ST_INACTIVE,
 303         /* Actively in use in a session */
 304         ST_ACTIVE,
 305 };
 306
 307 /*
 308  * TODO: This sucks, you just kinda have to "know" the returned type.
 309  * TODO: Need a DI to return the number of trigger stages supported.
 310  */
 311
 312 /* Device info IDs */
 313 enum {
 314         /* struct sigrok_device_instance for this specific device */
 315         DI_INSTANCE,
 316         /* The number of probes connected to this device */
 317         DI_NUM_PROBES,
 318         /* Samplerates supported by this device, (struct samplerates) */
 319         DI_SAMPLERATES,
 320         /* Types of trigger supported, out of "01crf" (char *) */
 321         DI_TRIGGER_TYPES,
 322         /* The currently set samplerate in Hz (uint64_t) */
 323         DI_CUR_SAMPLERATE,
 324 };
 325
 326 /*
 327  * A device supports either a range of samplerates with steps of a given
 328  * granularity, or is limited to a set of defined samplerates. Use either
 329  * step or list, but not both.
 330  */
 331 struct samplerates {
 332         uint64_t low;
 333         uint64_t high;
 334         uint64_t step;
 335         uint64_t *list;
 336 };
 337
 338 struct device_plugin {
 339         /* Plugin-specific */
 340         char *name;
 341         int api_version;
 342         int (*init) (char *deviceinfo);
 343         void (*cleanup) (void);
 344
 345         /* Device-specific */
 346         int (*open) (int device_index);
 347         void (*close) (int device_index);
 348         void *(*get_device_info) (int device_index, int device_info_id);
 349         int (*get_status) (int device_index);
 350         int *(*get_capabilities) (void);
 351         int (*set_configuration) (int device_index, int capability, void *value);
 352         int (*start_acquisition) (int device_index, gpointer session_device_id);
 353         void (*stop_acquisition) (int device_index, gpointer session_device_id);
 354 };
 355
 356 struct gsource_fd {
 357         GSource source;
 358         GPollFD gpfd;
 359         /* Not really using this */
 360         GSource *timeout_source;
 361 };
 362
 363 typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
 364
 365 int load_hwplugins(void);
 366 GSList *list_hwplugins(void);
 367
 368 /* Generic device instances */
 369 struct sigrok_device_instance *sigrok_device_instance_new(int index,
 370        int status, const char *vendor, const char *model, const char *version);
 371 struct sigrok_device_instance *get_sigrok_device_instance(
 372                         GSList *device_instances, int device_index);
 373 void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
 374
 375 /* USB-specific instances */
 376 struct usb_device_instance *usb_device_instance_new(uint8_t bus,
 377                 uint8_t address, struct libusb_device_handle *hdl);
 378 void usb_device_instance_free(struct usb_device_instance *usb);
 379
 380 /* Serial-specific instances */
 381 struct serial_device_instance *serial_device_instance_new(
 382                                         const char *port, int fd);
 383 void serial_device_instance_free(struct serial_device_instance *serial);
 384
 385 int find_hwcap(int *capabilities, int hwcap);
 386 struct hwcap_option *find_hwcap_option(int hwcap);
 387 void source_remove(int fd);
 388 void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
 389                 void *user_data);
 390
 391 /*--- session.c -------------------------------------------------------------*/
 392
 393 typedef void (*source_callback_remove) (int fd);
 394 typedef void (*source_callback_add) (int fd, int events, int timeout,
 395                 receive_data_callback callback, void *user_data);
 396 typedef void (*datafeed_callback) (struct device *device,
 397                                  struct datafeed_packet *packet);
 398
 399 struct session {
 400         /* List of struct device* */
 401         GSList *devices;
 402         /* List of struct analyzer* */
 403         GSList *analyzers;
 404         /* Datafeed callbacks */
 405         GSList *datafeed_callbacks;
 406         GTimeVal starttime;
 407 };
 408
 409 /* Session setup */
 410 struct session *session_load(const char *filename);
 411 struct session *session_new(void);
 412 void session_destroy(void);
 413 void session_device_clear(void);
 414 int session_device_add(struct device *device);
 415
 416 /* Protocol analyzers setup */
 417 void session_pa_clear(void);
 418 void session_pa_add(struct analyzer *pa);
 419
 420 /* Datafeed setup */
 421 void session_datafeed_callback_clear(void);
 422 void session_datafeed_callback_add(datafeed_callback callback);
 423
 424 /* Session control */
 425 int session_start(void);
 426 void session_stop(void);
 427 void session_bus(struct device *device, struct datafeed_packet *packet);
 428 void make_metadata(char *filename);
 429 int session_save(char *filename);
 430
 431 /*--- hwcommon.c ------------------------------------------------------------*/
 432
 433 int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
 434 int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
 435 int ezusb_upload_firmware(libusb_device *dev, int configuration,
 436                           const char *filename);
 437
 438 GSList *list_serial_ports(void);
 439 int serial_open(const char *pathname, int flags);
 440 int serial_close(int fd);
 441 int serial_flush(int fd);
 442 void *serial_backup_params(int fd);
 443 void serial_restore_params(int fd, void *backup);
 444 int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
 445                       int flowcontrol);
 446
 447 /* libsigrok/hardware/common/misc.c */
 448 /* TODO: Should not be public. */
 449 int opendev2(int device_index, struct sigrok_device_instance **sdi,
 450              libusb_device *dev, struct libusb_device_descriptor *des,
 451              int *skip, uint16_t vid, uint16_t pid, int interface);
 452 int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
 453              struct libusb_device_descriptor *des,
 454              uint16_t vid, uint16_t pid, int interface);
 455
 456 #endif