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