#include <stdint.h>
#include <inttypes.h>
#include <glib.h>
+#ifdef HAVE_LIBUSB_1_0
#include <libusb.h>
+#endif
#ifdef __cplusplus
extern "C" {
* 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_SAMPLERATE -4 /* Incorrect samplerate */
-/* limited by uint64_t */
-#define MAX_NUM_PROBES 64
-#define MAX_PROBENAME_LEN 32
+#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 HZ_TO_NS(n) (1000000000 / (n))
+#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))
-#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);
+typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
/* Data types used by hardware plugins for set_configuration() */
enum {
- T_UINT64,
- T_CHAR,
- T_NULL,
+ SR_T_UINT64,
+ SR_T_CHAR,
+ SR_T_NULL,
};
enum {
- PROTO_RAW,
+ SR_PROTO_RAW,
};
+#if 0
/* (Unused) protocol decoder stack entry */
-struct protocol {
+struct sr_protocol {
char *name;
int id;
int stackindex;
};
+#endif
-/* datafeed_packet.type values */
+/* sr_datafeed_packet.type values */
enum {
- DF_HEADER,
- DF_END,
- DF_TRIGGER,
- DF_LOGIC,
- DF_ANALOG,
- DF_PD,
+ SR_DF_HEADER,
+ SR_DF_END,
+ SR_DF_TRIGGER,
+ SR_DF_LOGIC,
+ SR_DF_ANALOG,
+ SR_DF_PD,
};
-struct datafeed_packet {
+struct sr_datafeed_packet {
uint16_t type;
uint64_t length;
uint16_t unitsize;
void *payload;
};
-struct datafeed_header {
+struct sr_datafeed_header {
int feed_version;
struct timeval starttime;
uint64_t samplerate;
int num_logic_probes;
};
-struct analog_probe {
+#if 0
+struct sr_analog_probe {
uint8_t att;
uint8_t res; /* Needs to be a power of 2, FIXME */
uint16_t val; /* Max hardware ADC width is 16bits */
};
-struct analog_sample {
+struct sr_analog_sample {
uint8_t num_probes; /* Max hardware probes is 256 */
- struct analog_probe probes[];
+ struct sr_analog_probe probes[];
};
+#endif
-struct input {
- struct input_format *format;
+struct sr_input {
+ struct sr_input_format *format;
char *param;
- struct device *vdevice;
+ struct sr_device *vdevice;
};
-struct input_format {
+struct sr_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);
+ int (*init) (struct sr_input *in);
+ int (*loadfile) (struct sr_input *in, const char *filename);
};
-struct output {
- struct output_format *format;
- struct device *device;
+struct sr_output {
+ struct sr_output_format *format;
+ struct sr_device *device;
char *param;
void *internal;
};
-struct output_format {
+struct sr_output_format {
char *extension;
char *description;
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,
+ 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 analyzer {
+#if 0
+struct sr_analyzer {
char *name;
char *filename;
/*
* TODO: Input and output format?
*/
};
+#endif
-/* 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 */
* 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.
*/
-struct device {
+struct sr_device {
/* Which plugin handles this device */
- struct device_plugin *plugin;
+ struct sr_device_plugin *plugin;
/* A plugin may handle multiple devices of the same type */
int plugin_index;
- /* List of struct probe* */
+ /* List of struct sr_probe* */
GSList *probes;
/* Data acquired by this device, if any */
- struct datastore *datastore;
+ struct sr_datastore *datastore;
};
enum {
- PROBE_TYPE_LOGIC,
- PROBE_TYPE_ANALOG,
+ SR_PROBE_TYPE_LOGIC,
+ SR_PROBE_TYPE_ANALOG,
};
-struct probe {
+struct sr_probe {
int index;
int type;
gboolean enabled;
char *trigger;
};
+/* TODO: Get rid of this global variable. */
extern GSList *devices;
/* Hardware plugin capabilities */
enum {
- HWCAP_DUMMY, /* Used to terminate lists */
+ SR_HWCAP_DUMMY, /* Used to terminate lists */
/* device classes */
- HWCAP_LOGIC_ANALYZER,
+ SR_HWCAP_LOGIC_ANALYZER,
/* 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 */
+ SR_HWCAP_SAMPLERATE, /* Change samplerate */
+ SR_HWCAP_PROBECONFIG, /* Configure probe mask */
+ SR_HWCAP_CAPTURE_RATIO, /* Set pre/post-trigger capture ratio */
+ SR_HWCAP_PATTERN_MODE, /* Pattern generator mode */
+
+ /* special stuff */
+ SR_HWCAP_CAPTUREFILE, /* capturefile to inject */
+ SR_HWCAP_CAPTURE_UNITSIZE, /* unitsize of capturefile data */
+ SR_HWCAP_CAPTURE_NUM_PROBES,/* set number of probes */
/* acquisition modes */
- HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
- HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
- HWCAP_CONTINUOUS,
+ SR_HWCAP_LIMIT_MSEC, /* Set a time limit for sample acquisition */
+ SR_HWCAP_LIMIT_SAMPLES, /* Set a limit on number of samples */
+ SR_HWCAP_CONTINUOUS,
};
-struct hwcap_option {
+struct sr_hwcap_option {
int capability;
int type;
char *description;
char *shortname;
};
-struct sigrok_device_instance {
+struct sr_device_instance {
int index;
int status;
int instance_type;
char *version;
void *priv;
union {
- struct usb_device_instance *usb;
- struct serial_device_instance *serial;
+ struct sr_usb_device_instance *usb;
+ struct sr_serial_device_instance *serial;
};
};
-/* sigrok_device_instance types */
+/* sr_device_instance types */
enum {
- USB_INSTANCE,
- SERIAL_INSTANCE,
+ SR_USB_INSTANCE,
+ SR_SERIAL_INSTANCE,
};
-struct usb_device_instance {
+#ifdef HAVE_LIBUSB_1_0
+struct sr_usb_device_instance {
uint8_t bus;
uint8_t address;
struct libusb_device_handle *devhdl;
};
+#endif
-struct serial_device_instance {
+struct sr_serial_device_instance {
char *port;
int fd;
};
/* 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_device_instance for this specific device */
+ SR_DI_INSTANCE,
/* The number of probes connected to this device */
- DI_NUM_PROBES,
- /* Samplerates supported by this device, (struct samplerates) */
- DI_SAMPLERATES,
+ SR_DI_NUM_PROBES,
+ /* 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 */
- DI_PATTERNMODES,
+ 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 {
+struct sr_device_plugin {
/* Plugin-specific */
char *name;
+ char *longname;
int api_version;
- int (*init) (char *deviceinfo);
+ int (*init) (const char *deviceinfo);
void (*cleanup) (void);
/* Device-specific */
void (*stop_acquisition) (int device_index, gpointer session_device_id);
};
-struct gsource_fd {
- GSource source;
- GPollFD gpfd;
- /* Not really using this */
- GSource *timeout_source;
-};
-
-struct session {
- /* List of struct device* */
+struct sr_session {
+ /* List of struct sr_device* */
GSList *devices;
/* List of struct analyzer* */
GSList *analyzers;
- /* Datafeed callbacks */
+ /* list of sr_receive_data_callback */
GSList *datafeed_callbacks;
GTimeVal starttime;
+ gboolean running;
};
#include "sigrok-proto.h"
projects / libsigrok.git / blobdiff