/*
* 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>
-#ifdef HAVE_LIBUSB_1_0
-#include <libusb.h>
-#endif
#ifdef __cplusplus
extern "C" {
#endif
+/*
+ * Package version macros (can be used for conditional compilation).
+ */
+
+/** The libsigrok package 'major' version number. */
+#define SR_PACKAGE_VERSION_MAJOR @SR_PACKAGE_VERSION_MAJOR@
+
+/** The libsigrok package 'minor' version number. */
+#define SR_PACKAGE_VERSION_MINOR @SR_PACKAGE_VERSION_MINOR@
+
+/** The libsigrok package 'micro' version number. */
+#define SR_PACKAGE_VERSION_MICRO @SR_PACKAGE_VERSION_MICRO@
+
+/** The libsigrok package version ("major.minor.micro") as string. */
+#define SR_PACKAGE_VERSION_STRING "@SR_PACKAGE_VERSION@"
+
+/*
+ * Library/libtool version macros (can be used for conditional compilation).
+ */
+
+/** The libsigrok libtool 'current' version number. */
+#define SR_LIB_VERSION_CURRENT @SR_LIB_VERSION_CURRENT@
+
+/** The libsigrok libtool 'revision' version number. */
+#define SR_LIB_VERSION_REVISION @SR_LIB_VERSION_REVISION@
+
+/** The libsigrok libtool 'age' version number. */
+#define SR_LIB_VERSION_AGE @SR_LIB_VERSION_AGE@
+
+/** The libsigrok libtool version ("current:revision:age") as string. */
+#define SR_LIB_VERSION_STRING "@SR_LIB_VERSION@"
+
/*
* Status/error codes returned by libsigrok functions.
*
#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 */
+#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
+#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
+#define SR_MAX_PROBENAME_LEN 32
/* Handy little macros */
#define SR_HZ(n) (n)
#define SR_HZ_TO_NS(n) (1000000000 / (n))
/* libsigrok loglevels. */
-#define SR_LOG_NONE 0
-#define SR_LOG_ERR 1
-#define SR_LOG_WARN 2
-#define SR_LOG_INFO 3
-#define SR_LOG_DBG 4
-#define SR_LOG_SPEW 5
+#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. */
-typedef int (*sr_receive_data_callback) (int fd, int revents, void *user_data);
+/*
+ * 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
+ */
+
+/* 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_t)(int fd, int revents, void *cb_data);
-/* Data types used by hardware plugins for set_configuration() */
+/* Data types used by hardware drivers for dev_config_set() */
enum {
SR_T_UINT64,
SR_T_CHAR,
SR_DF_END,
SR_DF_TRIGGER,
SR_DF_LOGIC,
- SR_DF_ANALOG,
SR_DF_PD,
};
struct sr_datafeed_packet {
uint16_t type;
- /* timeoffset since start, in picoseconds */
- uint64_t timeoffset;
- /* duration of data in this packet, in picoseconds */
- uint64_t duration;
void *payload;
};
int feed_version;
struct timeval starttime;
uint64_t samplerate;
- int num_analog_probes;
int num_logic_probes;
};
void *data;
};
-#if defined(HAVE_LA_ALSA)
-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 sr_analog_sample {
- uint8_t num_probes; /* Max hardware probes is 256 */
- struct sr_analog_probe probes[];
-};
-#endif
-
struct sr_input {
struct sr_input_format *format;
char *param;
- struct sr_device *vdevice;
+ struct sr_dev *vdev;
};
struct sr_input_format {
struct sr_output {
struct sr_output_format *format;
- struct sr_device *device;
+ struct sr_dev *dev;
char *param;
void *internal;
};
char *description;
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,
+ int (*data) (struct sr_output *o, const uint8_t *data_in,
+ uint64_t length_in, uint8_t **data_out,
+ uint64_t *length_out);
+ int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
uint64_t *length_out);
};
/*
* 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 sr_device {
- /* Which plugin handles this device */
- struct sr_device_plugin *plugin;
- /* A plugin may handle multiple devices of the same type */
- int plugin_index;
+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 */
enum {
SR_PROBE_TYPE_LOGIC,
- SR_PROBE_TYPE_ANALOG,
};
struct sr_probe {
char *trigger;
};
-/* Hardware plugin capabilities */
+/* Hardware driver capabilities */
enum {
- SR_HWCAP_DUMMY, /* Used to terminate lists */
+ SR_HWCAP_DUMMY = 0, /* Used to terminate lists. Must be 0! */
/*--- Device classes ------------------------------------------------*/
/* TODO: SR_HWCAP_SCOPE, SW_HWCAP_PATTERN_GENERATOR, etc.? */
+ /*--- Device types --------------------------------------------------*/
+
+ /** The device is demo device. */
+ SR_HWCAP_DEMO_DEV,
+
/*--- Device options ------------------------------------------------*/
/** The device supports setting/changing its samplerate. */
};
struct sr_hwcap_option {
- int capability;
+ int hwcap;
int type;
char *description;
char *shortname;
};
-struct sr_device_instance {
+struct sr_dev_inst {
int index;
int status;
- int instance_type;
+ int inst_type;
char *vendor;
char *model;
char *version;
void *priv;
- union {
- struct sr_usb_device_instance *usb;
- struct sr_serial_device_instance *serial;
- };
};
-/* sr_device_instance types */
+/* sr_dev_inst types */
enum {
- SR_USB_INSTANCE,
- SR_SERIAL_INSTANCE,
-};
-
-#ifdef HAVE_LIBUSB_1_0
-struct sr_usb_device_instance {
- uint8_t bus;
- uint8_t address;
- struct libusb_device_handle *devhdl;
-};
-#endif
-
-struct sr_serial_device_instance {
- char *port;
- int fd;
+ /** Device instance type for USB devices. */
+ SR_INST_USB,
+ /** Device instance type for serial port devices. */
+ SR_INST_SERIAL,
};
/* Device instance status */
/* Device info IDs */
enum {
- /* struct sr_device_instance for this specific device */
- SR_DI_INSTANCE,
+ /* struct sr_dev_inst for this specific device */
+ SR_DI_INST,
/* The number of probes connected to this device */
SR_DI_NUM_PROBES,
/* The probe names on this device */
SR_DI_TRIGGER_TYPES,
/* The currently set samplerate in Hz (uint64_t) */
SR_DI_CUR_SAMPLERATE,
- /* Supported pattern generator modes */
- SR_DI_PATTERNMODES,
+ /* Supported patterns (in pattern generator mode) */
+ SR_DI_PATTERNS,
};
/*
uint64_t *list;
};
-struct sr_device_plugin {
- /* Plugin-specific */
+struct sr_dev_driver {
+ /* Driver-specific */
char *name;
char *longname;
int api_version;
- int (*init) (const char *deviceinfo);
- void (*cleanup) (void);
+ int (*init) (const char *devinfo);
+ int (*cleanup) (void);
/* Device-specific */
- int (*opendev) (int device_index);
- int (*closedev) (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);
+ 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, void *session_dev_id);
+ int (*dev_acquisition_stop) (int dev_index, void *session_dev_id);
};
struct sr_session {
- /* List of struct sr_device* */
- GSList *devices;
- /* List of struct analyzer* */
- GSList *analyzers;
- /* list of sr_receive_data_callback */
+ /* List of struct sr_dev* */
+ GSList *devs;
+ /* list of sr_receive_data_callback_t */
GSList *datafeed_callbacks;
GTimeVal starttime;
gboolean running;
projects / libsigrok.git / blobdiff