/*
* This file is part of the sigrok project.
*
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef SIGROK_SIGROK_H
-#define SIGROK_SIGROK_H
+#ifndef LIBSIGROK_SIGROK_H
+#define LIBSIGROK_SIGROK_H
#include <stdio.h>
#include <sys/time.h>
#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
-#include <libusb.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
/*
* Status/error codes returned by libsigrok functions.
* or reused for different #defines later. You can only add new #defines and
* return codes, but never remove or redefine existing ones.
*/
-#define SIGROK_OK 0 /* No error */
-#define SIGROK_ERR -1 /* Generic/unspecified error */
-#define SIGROK_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
-#define SIGROK_ERR_SAMPLERATE -3 /* Incorrect samplerate */
+#define SR_OK 0 /* No error */
+#define SR_ERR -1 /* Generic/unspecified error */
+#define SR_ERR_MALLOC -2 /* Malloc/calloc/realloc error */
+#define SR_ERR_ARG -3 /* Function argument error */
+#define SR_ERR_BUG -4 /* Errors hinting at internal bugs */
+#define SR_ERR_SAMPLERATE -5 /* Incorrect samplerate */
+
+#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
+#define SR_MAX_PROBENAME_LEN 32
/* Handy little macros */
-#define KHZ(n) ((n) * 1000)
-#define MHZ(n) ((n) * 1000000)
-#define GHZ(n) ((n) * 1000000000)
+#define SR_HZ(n) (n)
+#define SR_KHZ(n) ((n) * 1000)
+#define SR_MHZ(n) ((n) * 1000000)
+#define SR_GHZ(n) ((n) * 1000000000)
-#ifndef ARRAY_SIZE
-#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
-#endif
+#define SR_HZ_TO_NS(n) (1000000000 / (n))
-/* Data types, used by hardware plugins for set_configuration() */
-enum {
- T_UINT64,
- T_CHAR,
-};
-
-enum {
- PROTO_RAW,
-};
-
-/* (Unused) protocol decoder stack entry */
-struct protocol {
- char *name;
- int id;
- int stackindex;
-};
+/* libsigrok loglevels. */
+#define SR_LOG_NONE 0 /**< Output no messages at all. */
+#define SR_LOG_ERR 1 /**< Output error messages. */
+#define SR_LOG_WARN 2 /**< Output warnings. */
+#define SR_LOG_INFO 3 /**< Output informational messages. */
+#define SR_LOG_DBG 4 /**< Output debug messages. */
+#define SR_LOG_SPEW 5 /**< Output very noisy debug messages. */
/*
- * Datafeed
+ * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
+ *
+ * Variables and functions marked 'static' are private already and don't
+ * need SR_PRIV. However, functions which are not static (because they need
+ * to be used in other libsigrok-internal files) but are also not meant to
+ * be part of the public libsigrok API, must use SR_PRIV.
+ *
+ * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
+ *
+ * Details: http://gcc.gnu.org/wiki/Visibility
*/
-/* datafeed_packet.type values */
+/* Marks public libsigrok API symbols. */
+#define SR_API __attribute__((visibility("default")))
+
+/* Marks private, non-public libsigrok symbols (not part of the API). */
+#define SR_PRIV __attribute__((visibility("hidden")))
+
+typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
+
+/* Data types used by hardware drivers for dev_config_set() */
+enum {
+ SR_T_UINT64,
+ SR_T_CHAR,
+ SR_T_BOOL,
+};
+
+/* sr_datafeed_packet.type values */
enum {
- DF_HEADER,
- DF_END,
- DF_TRIGGER,
- DF_LOGIC8,
- DF_LOGIC16,
- DF_LOGIC24,
- DF_LOGIC32,
- DF_LOGIC48,
- DF_LOGIC64,
+ SR_DF_HEADER,
+ SR_DF_END,
+ SR_DF_TRIGGER,
+ SR_DF_LOGIC,
+ SR_DF_PD,
};
-struct datafeed_packet {
+struct sr_datafeed_packet {
uint16_t type;
- uint64_t length;
void *payload;
};
-struct datafeed_header {
+struct sr_datafeed_header {
int feed_version;
struct timeval starttime;
uint64_t samplerate;
- int protocol_id;
- int num_probes;
+ int num_logic_probes;
};
-/*
- * Input
- */
-struct input {
- struct input_format *format;
- void *param;
- void *internal;
+struct sr_datafeed_logic {
+ uint64_t length;
+ uint16_t unitsize;
+ void *data;
};
-struct input_format {
- char *extension;
- char *description;
- int (*format_match) (char *filename);
- int (*in_loadfile) (char *filename);
+struct sr_input {
+ struct sr_input_format *format;
+ char *param;
+ struct sr_dev *vdev;
};
-struct input_format **input_list(void);
-
+struct sr_input_format {
+ char *id;
+ char *description;
+ int (*format_match) (const char *filename);
+ int (*init) (struct sr_input *in);
+ int (*loadfile) (struct sr_input *in, const char *filename);
+};
-/*
- * Output
- */
-struct output {
- struct output_format *format;
- struct device *device;
+struct sr_output {
+ struct sr_output_format *format;
+ struct sr_dev *dev;
char *param;
void *internal;
};
-struct output_format {
- char *extension;
+struct sr_output_format {
+ char *id;
char *description;
- int (*init) (struct output *o);
- int (*data) (struct output *o, char *data_in, uint64_t length_in,
- char **data_out, uint64_t *length_out);
- int (*event) (struct output *o, int event_type, char **data_out,
+ int df_type;
+ int (*init) (struct sr_output *o);
+ int (*data) (struct sr_output *o, const char *data_in,
+ uint64_t length_in, char **data_out, uint64_t *length_out);
+ int (*event) (struct sr_output *o, int event_type, char **data_out,
uint64_t *length_out);
};
-struct output_format **output_list(void);
-
-
-int filter_probes(int in_unitsize, int out_unitsize, int *probelist,
- char *data_in, uint64_t length_in, char **data_out,
- uint64_t *length_out);
-
-char *sigrok_samplerate_string(uint64_t samplerate);
-
-/*--- analyzer.c ------------------------------------------------------------*/
-
-struct analyzer {
- char *name;
- char *filename;
- /*
- * TODO: Parameters? If so, configured plugins need another struct.
- * TODO: Input and output format?
- */
-};
-
-/*--- backend.c -------------------------------------------------------------*/
-
-int sigrok_init(void);
-void sigrok_cleanup(void);
-
-/*--- datastore.c -----------------------------------------------------------*/
-
-/* Size of a chunk in units */
-#define DATASTORE_CHUNKSIZE 512000
-
-struct datastore {
+struct sr_datastore {
/* Size in bytes of the number of units stored in this datastore */
int ds_unitsize;
unsigned int num_units; /* TODO: uint64_t */
GSList *chunklist;
};
-int datastore_new(int unitsize, struct datastore **ds);
-int datastore_destroy(struct datastore *ds);
-void datastore_put(struct datastore *ds, void *data, unsigned int length,
- int in_unitsize, int *probelist);
-
-/*--- debug.c ---------------------------------------------------------------*/
-
-void hexdump(unsigned char *address, int length);
-
-/*--- device.c --------------------------------------------------------------*/
-
/*
* This represents a generic device connected to the system.
- * For device-specific information, ask the plugin. The plugin_index refers
- * to the device index within that plugin; it may be handling more than one
- * device. All relevant plugin calls take a device_index parameter for this.
+ * For device-specific information, ask the driver. The driver_index refers
+ * to the device index within that driver; it may be handling more than one
+ * device. All relevant driver calls take a dev_index parameter for this.
*/
-struct device {
- /* Which plugin handles this device */
- struct device_plugin *plugin;
- /* A plugin may handle multiple devices of the same type */
- int plugin_index;
- /* List of struct probe* */
+struct sr_dev {
+ /* Which driver handles this device */
+ struct sr_dev_driver *driver;
+ /* A driver may handle multiple devices of the same type */
+ int driver_index;
+ /* List of struct sr_probe* */
GSList *probes;
/* Data acquired by this device, if any */
- struct datastore *datastore;
+ struct sr_datastore *datastore;
};
-#define MAX_PROBENAME_LEN 32
-struct probe {
+enum {
+ SR_PROBE_TYPE_LOGIC,
+};
+
+struct sr_probe {
int index;
+ int type;
gboolean enabled;
char *name;
char *trigger;
};
-extern GSList *devices;
+/* Hardware driver capabilities */
+enum {
+ SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
-void device_scan(void);
-void device_close_all(void);
-GSList *device_list(void);
-struct device *device_new(struct device_plugin *plugin, int plugin_index, int num_probes);
-void device_clear(struct device *device);
-void device_destroy(struct device *dev);
+ /*--- Device classes ------------------------------------------------*/
-void device_probe_clear(struct device *device, int probenum);
-void device_probe_add(struct device *device, char *name);
-struct probe *probe_find(struct device *device, int probenum);
-void device_probe_name(struct device *device, int probenum, char *name);
+ /** The device can act as logic analyzer. */
+ SR_HWCAP_LOGIC_ANALYZER,
-void device_trigger_clear(struct device *device);
-void device_trigger_set(struct device *device, int probenum, char *trigger);
+ /* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
-/*--- hwplugin.c ------------------------------------------------------------*/
+ /*--- Device types --------------------------------------------------*/
-/* Hardware plugin capabilities */
-enum {
- HWCAP_DUMMY, /* Used to terminate lists */
- HWCAP_LOGIC_ANALYZER,
- HWCAP_SAMPLERATE, /* Change samplerate */
- HWCAP_PROBECONFIG, /* Configure probe mask */
- HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
- HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
- HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
+ /** The device is demo device. */
+ SR_HWCAP_DEMO_DEV,
+
+ /*--- Device options ------------------------------------------------*/
+
+ /** The device supports setting/changing its samplerate. */
+ SR_HWCAP_SAMPLERATE,
+
+ /* TODO: Better description? Rename to PROBE_AND_TRIGGER_CONFIG? */
+ /** The device supports setting a probe mask. */
+ SR_HWCAP_PROBECONFIG,
+
+ /** The device supports setting a pre/post-trigger capture ratio. */
+ SR_HWCAP_CAPTURE_RATIO,
+
+ /* TODO? */
+ /** The device supports setting a pattern (pattern generator mode). */
+ SR_HWCAP_PATTERN_MODE,
+
+ /** The device supports Run Length Encoding. */
+ SR_HWCAP_RLE,
+
+ /*--- Special stuff -------------------------------------------------*/
+
+ /* TODO: Better description. */
+ /** The device supports specifying a capturefile to inject. */
+ SR_HWCAP_CAPTUREFILE,
+
+ /* TODO: Better description. */
+ /** The device supports specifying the capturefile unit size. */
+ SR_HWCAP_CAPTURE_UNITSIZE,
+
+ /* TODO: Better description. */
+ /** The device supports setting the number of probes. */
+ SR_HWCAP_CAPTURE_NUM_PROBES,
+
+ /*--- Acquisition modes ---------------------------------------------*/
+
+ /**
+ * The device supports setting a sample time limit, i.e. how long the
+ * sample acquisition should run (in ms).
+ */
+ SR_HWCAP_LIMIT_MSEC,
+
+ /**
+ * The device supports setting a sample number limit, i.e. how many
+ * samples should be acquired.
+ */
+ SR_HWCAP_LIMIT_SAMPLES,
+
+ /**
+ * The device supports continuous sampling, i.e. neither a time limit
+ * nor a sample number limit has to be supplied, it will just acquire
+ * samples continuously, until explicitly stopped by a certain command.
+ */
+ SR_HWCAP_CONTINUOUS,
+
+ /* TODO: SR_HWCAP_JUST_SAMPLE or similar. */
};
-struct hwcap_option {
- int capability;
+struct sr_hwcap_option {
+ int hwcap;
int type;
char *description;
char *shortname;
};
-struct sigrok_device_instance {
+struct sr_dev_inst {
int index;
int status;
- int instance_type;
+ int inst_type;
char *vendor;
char *model;
char *version;
- union {
- struct usb_device_instance *usb;
- struct serial_device_instance *serial;
- };
+ void *priv;
};
-/* sigrok_device_instance types */
+/* sr_dev_inst types */
enum {
- USB_INSTANCE,
- SERIAL_INSTANCE,
-};
-
-struct usb_device_instance {
- uint8_t bus;
- uint8_t address;
- struct libusb_device_handle *devhdl;
-};
-
-struct serial_device_instance {
- char *port;
- int fd;
+ SR_USB_INST,
+ SR_SERIAL_INST,
};
/* Device instance status */
enum {
- ST_NOT_FOUND,
+ SR_ST_NOT_FOUND,
/* Found, but still booting */
- ST_INITIALIZING,
+ SR_ST_INITIALIZING,
/* Live, but not in use */
- ST_INACTIVE,
+ SR_ST_INACTIVE,
/* Actively in use in a session */
- ST_ACTIVE,
+ SR_ST_ACTIVE,
};
/*
/* Device info IDs */
enum {
- /* struct sigrok_device_instance for this specific device */
- DI_INSTANCE,
+ /* struct sr_dev_inst for this specific device */
+ SR_DI_INST,
/* The number of probes connected to this device */
- DI_NUM_PROBES,
- /* Samplerates supported by this device, (struct samplerates) */
- DI_SAMPLERATES,
+ SR_DI_NUM_PROBES,
+ /* The probe names on this device */
+ SR_DI_PROBE_NAMES,
+ /* Samplerates supported by this device, (struct sr_samplerates) */
+ SR_DI_SAMPLERATES,
/* Types of trigger supported, out of "01crf" (char *) */
- DI_TRIGGER_TYPES,
+ SR_DI_TRIGGER_TYPES,
/* The currently set samplerate in Hz (uint64_t) */
- DI_CUR_SAMPLERATE,
+ SR_DI_CUR_SAMPLERATE,
+ /* Supported pattern generator modes */
+ SR_DI_PATTERNMODES,
};
/*
* granularity, or is limited to a set of defined samplerates. Use either
* step or list, but not both.
*/
-struct samplerates {
+struct sr_samplerates {
uint64_t low;
uint64_t high;
uint64_t step;
uint64_t *list;
};
-struct device_plugin {
- /* Plugin-specific */
+struct sr_dev_driver {
+ /* Driver-specific */
char *name;
+ char *longname;
int api_version;
- int (*init) (char *deviceinfo);
- void (*cleanup) (void);
+ int (*init) (const char *devinfo);
+ int (*cleanup) (void);
/* Device-specific */
- int (*open) (int device_index);
- void (*close) (int device_index);
- void *(*get_device_info) (int device_index, int device_info_id);
- int (*get_status) (int device_index);
- int *(*get_capabilities) (void);
- int (*set_configuration) (int device_index, int capability, void *value);
- int (*start_acquisition) (int device_index, gpointer session_device_id);
- void (*stop_acquisition) (int device_index, gpointer session_device_id);
-};
-
-struct gsource_fd {
- GSource source;
- GPollFD gpfd;
- /* Not really using this */
- GSource *timeout_source;
+ int (*dev_open) (int dev_index);
+ int (*dev_close) (int dev_index);
+ void *(*dev_info_get) (int dev_index, int dev_info_id);
+ int (*dev_status_get) (int dev_index);
+ int *(*hwcap_get_all) (void);
+ int (*dev_config_set) (int dev_index, int hwcap, void *value);
+ int (*dev_acquisition_start) (int dev_index, gpointer session_dev_id);
+ int (*dev_acquisition_stop) (int dev_index, gpointer session_dev_id);
};
-typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
-
-int load_hwplugins(void);
-GSList *list_hwplugins(void);
-
-/* Generic device instances */
-struct sigrok_device_instance *sigrok_device_instance_new(int index,
- int status, const char *vendor, const char *model, const char *version);
-struct sigrok_device_instance *get_sigrok_device_instance(
- GSList *device_instances, int device_index);
-void sigrok_device_instance_free(struct sigrok_device_instance *sdi);
-
-/* USB-specific instances */
-struct usb_device_instance *usb_device_instance_new(uint8_t bus,
- uint8_t address, struct libusb_device_handle *hdl);
-void usb_device_instance_free(struct usb_device_instance *usb);
-
-/* Serial-specific instances */
-struct serial_device_instance *serial_device_instance_new(
- const char *port, int fd);
-void serial_device_instance_free(struct serial_device_instance *serial);
-
-int find_hwcap(int *capabilities, int hwcap);
-struct hwcap_option *find_hwcap_option(int hwcap);
-void source_remove(int fd);
-void source_add(int fd, int events, int timeout, receive_data_callback rcv_cb,
- void *user_data);
-
-/*--- session.c -------------------------------------------------------------*/
-
-typedef void (*source_callback_remove) (int fd);
-typedef void (*source_callback_add) (int fd, int events, int timeout,
- receive_data_callback callback, void *user_data);
-typedef void (*datafeed_callback) (struct device *device,
- struct datafeed_packet *packet);
-
-struct session {
- /* List of struct device* */
- GSList *devices;
- /* List of struct analyzer* */
- GSList *analyzers;
- /* Datafeed callbacks */
+struct sr_session {
+ /* List of struct sr_dev* */
+ GSList *devs;
+ /* list of sr_receive_data_callback */
GSList *datafeed_callbacks;
GTimeVal starttime;
+ gboolean running;
};
-/* Session setup */
-struct session *session_load(const char *filename);
-struct session *session_new(void);
-void session_destroy(void);
-void session_device_clear(void);
-int session_device_add(struct device *device);
-
-/* Protocol analyzers setup */
-void session_pa_clear(void);
-void session_pa_add(struct analyzer *pa);
-
-/* Datafeed setup */
-void session_datafeed_callback_clear(void);
-void session_datafeed_callback_add(datafeed_callback callback);
-
-/* Session control */
-int session_start(void);
-void session_stop(void);
-void session_bus(struct device *device, struct datafeed_packet *packet);
-void make_metadata(char *filename);
-int session_save(char *filename);
-
-/*--- hwcommon.c ------------------------------------------------------------*/
-
-int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
-int ezusb_install_firmware(libusb_device_handle *hdl, char *filename);
-int ezusb_upload_firmware(libusb_device *dev, int configuration,
- const char *filename);
-
-GSList *list_serial_ports(void);
-int serial_open(const char *pathname, int flags);
-int serial_close(int fd);
-int serial_flush(int fd);
-void *serial_backup_params(int fd);
-void serial_restore_params(int fd, void *backup);
-int serial_set_params(int fd, int speed, int bits, int parity, int stopbits,
- int flowcontrol);
-
-/* libsigrok/hardware/common/misc.c */
-/* TODO: Should not be public. */
-int opendev2(int device_index, struct sigrok_device_instance **sdi,
- libusb_device *dev, struct libusb_device_descriptor *des,
- int *skip, uint16_t vid, uint16_t pid, int interface);
-int opendev3(struct sigrok_device_instance **sdi, libusb_device *dev,
- struct libusb_device_descriptor *des,
- uint16_t vid, uint16_t pid, int interface);
+#include "sigrok-proto.h"
+
+#ifdef __cplusplus
+}
+#endif
#endif
projects / libsigrok.git / blobdiff