#include <glib.h>
#include <libusb.h>
-/* Returned status/error codes */
-#define SIGROK_STATUS_DISABLED 0
-#define SIGROK_OK 1
-#define SIGROK_NOK 2
-#define SIGROK_ERR_BADVALUE 20
+/*
+ * Status/error codes returned by libsigrok functions.
+ *
+ * All possible return codes of libsigrok functions must be listed here.
+ * Functions should never return hardcoded numbers as status, but rather
+ * use these #defines instead. All error codes are negative numbers.
+ *
+ * The error codes are globally unique in libsigrok, i.e. if one of the
+ * libsigrok functions returns a "malloc error" it must be exactly the same
+ * return value as used by all other functions to indicate "malloc error".
+ * There must be no functions which indicate two different errors via the
+ * same return code.
+ *
+ * Also, for compatibility reasons, no defined return codes are ever removed
+ * 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 */
+
+/* limited by uint64_t */
+#define MAX_NUM_PROBES 64
+#define MAX_PROBENAME_LEN 32
/* Handy little macros */
-#define KHZ(n) (n * 1000)
-#define MHZ(n) (n * 1000000)
-#define GHZ(n) (n * 1000000000)
+#define KHZ(n) ((n) * 1000)
+#define MHZ(n) ((n) * 1000000)
+#define GHZ(n) ((n) * 1000000000)
-/* Data types, used by hardware plugins for set_configuration() */
+#define HZ_TO_NS(n) (1000000000 / (n))
+
+#ifndef ARRAY_SIZE
+#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
+#endif
+
+#ifndef ARRAY_AND_SIZE
+#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
+#endif
+
+typedef int (*receive_data_callback) (int fd, int revents, void *user_data);
+
+/* Data types used by hardware plugins for set_configuration() */
enum {
T_UINT64,
T_CHAR,
int stackindex;
};
-/*
- * datafeed
- */
-
/* datafeed_packet.type values */
enum {
DF_HEADER,
DF_END,
DF_TRIGGER,
- DF_LOGIC8,
- DF_LOGIC16,
- DF_LOGIC24,
- DF_LOGIC32,
- DF_LOGIC48,
- DF_LOGIC64,
+ DF_LOGIC,
+ DF_ANALOG,
+ DF_PD,
};
struct datafeed_packet {
uint16_t type;
- uint16_t length;
+ uint64_t length;
+ uint16_t unitsize;
void *payload;
};
struct timeval starttime;
uint64_t samplerate;
int protocol_id;
- int num_probes;
+ int num_analog_probes;
+ int num_logic_probes;
+};
+
+struct input {
+ struct input_format *format;
+ char *param;
+ struct device *vdevice;
+};
+
+struct input_format {
+ char *extension;
+ char *description;
+ int (*format_match) (const char *filename);
+ int (*init) (struct input *in);
+ int (*loadfile) (struct input *in, const char *filename);
};
-/*
- * output
- */
struct output {
struct output_format *format;
struct device *device;
struct output_format {
char *extension;
char *description;
- void (*init) (struct output *o);
+ int df_type;
+ 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,
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);
-
-/*--- analyzer.c ------------------------------------------------------------*/
-
struct analyzer {
char *name;
char *filename;
*/
};
-/*--- backend.c -------------------------------------------------------------*/
-
-int sigrok_init(void);
-void sigrok_cleanup(void);
-
-/*--- datastore.c -----------------------------------------------------------*/
-
/* Size of a chunk in units */
#define DATASTORE_CHUNKSIZE 512000
struct datastore {
/* Size in bytes of the number of units stored in this datastore */
int ds_unitsize;
- unsigned int num_units;
+ unsigned int num_units; /* TODO: uint64_t */
GSList *chunklist;
};
-struct datastore *datastore_new(int unitsize);
-void 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
struct datastore *datastore;
};
+enum {
+ PROBE_TYPE_LOGIC,
+ PROBE_TYPE_ANALOG,
+};
+
struct probe {
int index;
+ int type;
gboolean enabled;
char *name;
char *trigger;
extern GSList *devices;
-void device_scan(void);
-void device_close_all(void);
-GSList *device_list(void);
-struct device *device_new(struct device_plugin *plugin, int plugin_index);
-void device_clear(struct device *device);
-void device_destroy(struct device *dev);
-
-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);
-
-void device_trigger_clear(struct device *device);
-void device_trigger_set(struct device *device, int probenum, char *trigger);
-
-/*--- hwplugin.c ------------------------------------------------------------*/
-
/* Hardware plugin capabilities */
enum {
- HWCAP_DUMMY, // used to terminate lists
+ HWCAP_DUMMY, /* Used to terminate lists */
+ /* device classes */
HWCAP_LOGIC_ANALYZER,
- HWCAP_SAMPLERATE, // change samplerate
- HWCAP_PROBECONFIG, // configure probe mask
- HWCAP_CAPTURE_RATIO, // set pre-trigger / post-trigger ratio
- HWCAP_LIMIT_MSEC, // set a time limit for sample acquisition
- HWCAP_LIMIT_SAMPLES, // set a limit on number of samples
+
+ /* device options */
+ HWCAP_SAMPLERATE, /* Change samplerate */
+ HWCAP_PROBECONFIG, /* Configure probe mask */
+ HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
+ HWCAP_PATTERN_MODE, /* Pattern generator mode */
+
+ /* acquisition modes */
+ HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
+ HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
+ HWCAP_CONTINUOUS,
};
struct hwcap_option {
char *vendor;
char *model;
char *version;
+ void *priv;
union {
struct usb_device_instance *usb;
struct serial_device_instance *serial;
DI_TRIGGER_TYPES,
/* The currently set samplerate in Hz (uint64_t) */
DI_CUR_SAMPLERATE,
+ /* Supported pattern generator modes */
+ DI_PATTERNMODES,
};
-/* a device supports either a range of samplerates with steps of a given
- * granularity, or is limited to a set of defined samplerates. use either
+/*
+ * A device supports either a range of samplerates with steps of a given
+ * granularity, or is limited to a set of defined samplerates. Use either
* step or list, but not both.
*/
struct samplerates {
};
struct device_plugin {
- /* plugin-specific */
+ /* Plugin-specific */
char *name;
int api_version;
int (*init) (char *deviceinfo);
void (*cleanup) (void);
- /* device-specific */
+ /* Device-specific */
int (*open) (int device_index);
void (*close) (int device_index);
void *(*get_device_info) (int device_index, int device_info_id);
GSource *timeout_source;
};
-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, char *vendor, char *model, 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(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 */
+ /* Datafeed callbacks */
GSList *datafeed_callbacks;
GTimeVal starttime;
};
-/* Session setup */
-struct session *session_load(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);
-
-GSList *list_serial_ports(void);
+#include "sigrok-proto.h"
#endif
projects / libsigrok.git / blobdiff