/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2013 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 LIBSIGROK_SIGROK_H
-#define LIBSIGROK_SIGROK_H
+#ifndef LIBSIGROK_LIBSIGROK_H
+#define LIBSIGROK_LIBSIGROK_H
#include <stdio.h>
#include <sys/time.h>
* The public libsigrok header file to be used by frontends.
*
* This is the only file that libsigrok users (frontends) are supposed to
- * use and #include. There are other header files which get installed with
+ * use and \#include. There are other header files which get installed with
* libsigrok, but those are not meant to be used directly by frontends.
*
* The correct way to get/use the libsigrok API functions is:
*
- * @code{.c}
- * #include <libsigrok/libsigrok.h>
- * @endcode
+ @code{.c}
+ #include <libsigrok/libsigrok.h>
+ @endcode
*/
/*
SR_ERR_ARG = -3, /**< Function argument error. */
SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */
SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
+ SR_ERR_NA = -6, /**< Not applicable. */
+ SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
+ SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
+ SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */
+
+ /*
+ * Note: When adding entries here, don't forget to also update the
+ * sr_strerror() and sr_strerror_name() functions in error.c.
+ */
};
-#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
#define SR_MAX_PROBENAME_LEN 32
/* Handy little macros */
#define SR_PRIV
#endif
+/** Type definition for callback function for data reception. */
typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
/** Data types used by sr_config_info(). */
SR_T_RATIONAL_PERIOD,
SR_T_RATIONAL_VOLT,
SR_T_KEYVALUE,
-};
-
-/** Rational number data type, containing numerator and denominator values. */
-struct sr_rational {
- /** Numerator of the rational number. */
- uint64_t p;
- /** Denominator of the rational number. */
- uint64_t q;
+ SR_T_UINT64_RANGE,
+ SR_T_DOUBLE_RANGE,
+ SR_T_INT32,
};
/** Value for sr_datafeed_packet.type. */
enum {
+ /** Payload is sr_datafeed_header. */
SR_DF_HEADER = 10000,
+ /** End of stream (no further data). */
SR_DF_END,
+ /** Payload is struct sr_datafeed_meta */
SR_DF_META,
+ /** The trigger matched at this point in the data feed. No payload. */
SR_DF_TRIGGER,
+ /** Payload is struct sr_datafeed_logic. */
SR_DF_LOGIC,
+ /** Payload is struct sr_datafeed_analog. */
SR_DF_ANALOG,
+ /** Beginning of frame. No payload. */
SR_DF_FRAME_BEGIN,
+ /** End of frame. No payload. */
SR_DF_FRAME_END,
};
-/** Values for sr_datafeed_analog.mq. */
+/** Measured quantity, sr_datafeed_analog.mq. */
enum {
SR_MQ_VOLTAGE = 10000,
SR_MQ_CURRENT,
SR_MQ_CAPACITANCE,
SR_MQ_TEMPERATURE,
SR_MQ_FREQUENCY,
+ /** Duty cycle, e.g. on/off ratio. */
SR_MQ_DUTY_CYCLE,
+ /** Continuity test. */
SR_MQ_CONTINUITY,
SR_MQ_PULSE_WIDTH,
SR_MQ_CONDUCTANCE,
/** Logarithmic representation of sound pressure relative to a
* reference value. */
SR_MQ_SOUND_PRESSURE_LEVEL,
+ /** Carbon monoxide level */
SR_MQ_CARBON_MONOXIDE,
+ /** Humidity */
SR_MQ_RELATIVE_HUMIDITY,
+ /** Time */
+ SR_MQ_TIME,
};
-/** Values for sr_datafeed_analog.unit. */
+/** Unit of measured quantity, sr_datafeed_analog.unit. */
enum {
+ /** Volt */
SR_UNIT_VOLT = 10000,
+ /** Ampere (current). */
SR_UNIT_AMPERE,
+ /** Ohm (resistance). */
SR_UNIT_OHM,
+ /** Farad (capacity). */
SR_UNIT_FARAD,
+ /** Kelvin (temperature). */
SR_UNIT_KELVIN,
+ /** Degrees Celsius (temperature). */
SR_UNIT_CELSIUS,
+ /** Degrees Fahrenheit (temperature). */
SR_UNIT_FAHRENHEIT,
+ /** Hertz (frequency, 1/s, [Hz]). */
SR_UNIT_HERTZ,
+ /** Percent value. */
SR_UNIT_PERCENTAGE,
+ /** Boolean value. */
SR_UNIT_BOOLEAN,
+ /** Time in seconds. */
SR_UNIT_SECOND,
/** Unit of conductance, the inverse of resistance. */
SR_UNIT_SIEMENS,
* represented as the fraction of number of particles of the substance.
*/
SR_UNIT_CONCENTRATION,
+ /** Revolutions per minute. */
+ SR_UNIT_REVOLUTIONS_PER_MINUTE,
+ /** Apparent power [VA]. */
+ SR_UNIT_VOLT_AMPERE,
+ /** Real power [W]. */
+ SR_UNIT_WATT,
+ /** Consumption [Wh]. */
+ SR_UNIT_WATT_HOUR,
};
/** Values for sr_datafeed_analog.flags. */
/** Sound pressure level represented as a percentage of measurements
* that were over a preset alarm level. */
SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
+ /** Time is duration (as opposed to epoch, ...). */
+ SR_MQFLAG_DURATION = 0x20000,
+ /** Device is in "avg" mode, averaging upon each new value. */
+ SR_MQFLAG_AVG = 0x40000,
};
+/**
+ * @struct sr_context
+ * Opaque structure representing a libsigrok context.
+ *
+ * None of the fields of this structure are meant to be accessed directly.
+ *
+ * @see sr_init(), sr_exit().
+ */
struct sr_context;
+/** Packet in a sigrok data feed. */
struct sr_datafeed_packet {
uint16_t type;
const void *payload;
};
+/** Header of a sigrok data feed. */
struct sr_datafeed_header {
int feed_version;
struct timeval starttime;
};
+/** Datafeed payload for type SR_DF_META. */
struct sr_datafeed_meta {
GSList *config;
};
+/** Logic datafeed payload for type SR_DF_LOGIC. */
struct sr_datafeed_logic {
uint64_t length;
uint16_t unitsize;
void *data;
};
+/** Analog datafeed payload for type SR_DF_ANALOG. */
struct sr_datafeed_analog {
/** The probes for which data is included in this packet. */
GSList *probes;
+ /** Number of samples in data */
int num_samples;
- /** Measured quantity (voltage, current, temperature, and so on). */
+ /** Measured quantity (voltage, current, temperature, and so on).
+ * Use SR_MQ_VOLTAGE, ... */
int mq;
- /** Unit in which the MQ is measured. */
+ /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
int unit;
- /** Bitmap with extra information about the MQ. */
+ /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
uint64_t mqflags;
/** The analog value(s). The data is interleaved according to
* the probes list. */
void *internal;
};
+/** Input (file) format driver. */
struct sr_input_format {
/** The unique ID for this input format. Must not be NULL. */
char *id;
/**
* Check if this input module can load and parse the specified file.
*
- * @param filename The name (and path) of the file to check.
+ * @param[in] filename The name (and path) of the file to check.
*
- * @return TRUE if this module knows the format, FALSE if it doesn't.
+ * @retval TRUE This module knows the format.
+ * @retval FALSE This module does not know the format.
*/
int (*format_match) (const char *filename);
* @param in A pointer to a valid 'struct sr_input' that the caller
* has to allocate and provide to this function. It is also
* the responsibility of the caller to free it later.
- * @param filename The name (and path) of the file to use.
+ * @param[in] filename The name (and path) of the file to use.
*
- * @return SR_OK upon success, a negative error code upon failure.
+ * @retval SR_OK Success
+ * @retval other Negative error code.
*/
int (*init) (struct sr_input *in, const char *filename);
* the responsibility of the caller to free it later.
* @param filename The name (and path) of the file to use.
*
- * @return SR_OK upon success, a negative error code upon failure.
+ * @retval SR_OK Success
+ * @retval other Negative error code.
*/
int (*loadfile) (struct sr_input *in, const char *filename);
};
void *internal;
};
+/** Output (file) format driver. */
struct sr_output_format {
/**
* A unique ID for this output format. Must not be NULL.
*/
char *description;
+ /** Datafeed type, SR_DF_HEADER, etc. */
int df_type;
/**
*
* @param o Pointer to the respective 'struct sr_output'.
*
- * @return SR_OK upon success, a negative error code otherwise.
+ * @retval SR_OK Success
+ * @retval other Negative error code.
*/
int (*init) (struct sr_output *o);
* <code>data_out</code> parameter, so the caller knows not to try
* and g_free() it.
*
- * Note: This API call is obsolete, use recv() instead.
+ * Note: This API call is obsolete, use receive() instead.
*
* @param o Pointer to the respective 'struct sr_output'.
* @param data_in Pointer to the input data buffer.
* @param data_out Pointer to the allocated output buffer.
* @param length_out Length (in bytes) of the output.
*
- * @return SR_OK upon success, a negative error code otherwise.
+ * @retval SR_OK Success
+ * @retval other Negative error code.
*/
int (*data) (struct sr_output *o, const uint8_t *data_in,
uint64_t length_in, uint8_t **data_out,
* it stored in the <code>data_out</code> and <code>length_out</code>
* parameters, or NULL if no output was generated.
*
- * Note: This API call is obsolete, use recv() instead.
+ * Note: This API call is obsolete, use receive() instead.
*
* @param o Pointer to the respective 'struct sr_output'.
* @param event_type Type of event that occured.
* @param data_out Pointer to the allocated output buffer.
* @param length_out Length (in bytes) of the output.
*
- * @return SR_OK upon success, a negative error code otherwise.
+ * @retval SR_OK Success
+ * @retval other Negative error code.
*/
int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
- uint64_t *length_out);
+ uint64_t *length_out);
- GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
- const struct sr_datafeed_packet *packet);
+ /**
+ * This function is passed a copy of every packed in the data feed.
+ * Any output generated by the output module in response to the
+ * packet should be returned in a newly allocated GString
+ * <code>out</code>, which will be freed by the caller.
+ *
+ * Packets not of interest to the output module can just be ignored,
+ * and the <code>out</code> parameter set to NULL.
+ *
+ * @param o Pointer to the respective 'struct sr_output'.
+ * @param sdi The device instance that generated the packet.
+ * @param packet The complete packet.
+ * @param out A pointer where a GString * should be stored if
+ * the module generates output, or NULL if not.
+ *
+ * @retval SR_OK Success
+ * @retval other Negative error code.
+ */
+ int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
+ const struct sr_datafeed_packet *packet, GString **out);
+ /**
+ * This function is called after the caller is finished using
+ * the output module, and can be used to free any internal
+ * resources the module may keep.
+ *
+ * @retval SR_OK Success
+ * @retval other Negative error code.
+ */
int (*cleanup) (struct sr_output *o);
};
+/** Constants for probe type. */
enum {
- SR_PROBE_LOGIC = 10000,
- SR_PROBE_ANALOG,
+ /** Probe type is logic probe. */
+ SR_PROBE_LOGIC = 10000,
+ /** Probe type is analog probe. */
+ SR_PROBE_ANALOG,
};
+/** Information on single probe. */
struct sr_probe {
- /* The index field will go: use g_slist_length(sdi->probes) instead. */
+ /** Number of probes, starting at 0. @deprecated The index field
+ * will go: use g_slist_length(sdi->probes) instead. */
int index;
+ /** Probe type (SR_PROBE_LOGIC, ...) */
int type;
+ /** Is this probe enabled? */
gboolean enabled;
+ /** Name of probe. */
char *name;
+ /** Trigger string, format like used by sigrok-cli */
char *trigger;
};
+/** Structure for groups of probes that have common properties. */
+struct sr_probe_group {
+ /** Name of the probe group. */
+ char *name;
+ /** List of sr_probe structs of the probes belonging to this group. */
+ GSList *probes;
+ /** Private data for driver use. */
+ void *priv;
+};
+
+/** Used for setting or getting value of a config item. */
struct sr_config {
+ /** Config key like SR_CONF_CONN, etc. */
int key;
- const void *value;
+ /** Key-specific data. */
+ GVariant *data;
};
+/** Information about a config key. */
struct sr_config_info {
+ /** Config key like SR_CONF_CONN, etc. */
int key;
+ /** Data type like SR_T_CHAR, etc. */
int datatype;
+ /** Id string, e.g. "serialcomm". */
char *id;
+ /** Name, e.g. "Serial communication". */
char *name;
+ /** Verbose description (unused currently). */
char *description;
};
+/** Constants for device classes */
enum {
/*--- Device classes ------------------------------------------------*/
/** The device can measure humidity. */
SR_CONF_HYGROMETER,
+ /** The device can measure energy consumption. */
+ SR_CONF_ENERGYMETER,
+
+ /** The device can demodulate signals. */
+ SR_CONF_DEMODULATOR,
+
/*--- Driver scan options -------------------------------------------*/
/**
* flow 0 no flow control
* 1 hardware-based (RTS/CTS) flow control
* 2 software-based (XON/XOFF) flow control
- *
+ *
* This is always an optional parameter, since a driver typically
* knows the speed at which the device wants to communicate.
*/
/*--- Device configuration ------------------------------------------*/
- /** The device supports setting/changing its samplerate. */
+ /** The device supports setting its samplerate, in Hz. */
SR_CONF_SAMPLERATE = 30000,
/** The device supports setting a pre/post-trigger capture ratio. */
/** Trigger types. */
SR_CONF_TRIGGER_TYPE,
+ /** The device supports setting its sample interval, in ms. */
+ SR_CONF_SAMPLE_INTERVAL,
+
+ /** Number of timebases, as related to SR_CONF_TIMEBASE. */
+ SR_CONF_NUM_TIMEBASE,
+
+ /** Number of vertical divisions, as related to SR_CONF_VDIV. */
+ SR_CONF_NUM_VDIV,
+
+ /** Sound pressure level frequency weighting. */
+ SR_CONF_SPL_WEIGHT_FREQ,
+
+ /** Sound pressure level time weighting. */
+ SR_CONF_SPL_WEIGHT_TIME,
+
+ /** Sound pressure level measurement range. */
+ SR_CONF_SPL_MEASUREMENT_RANGE,
+
+ /** Max hold mode. */
+ SR_CONF_HOLD_MAX,
+
+ /** Min hold mode. */
+ SR_CONF_HOLD_MIN,
+
+ /** Logic low-high threshold range. */
+ SR_CONF_VOLTAGE_THRESHOLD,
+
+ /** The device supports using an external clock. */
+ SR_CONF_EXTERNAL_CLOCK,
+
+ /**
+ * The device supports swapping channels. Typical this is between
+ * buffered and unbuffered channels.
+ */
+ SR_CONF_SWAP,
+
+ /** Center frequency.
+ * The input signal is downmixed by this frequency before the ADC
+ * anti-aliasing filter.
+ */
+ SR_CONF_CENTER_FREQUENCY,
+
+ /** The device supports setting the number of logic probes. */
+ SR_CONF_NUM_LOGIC_PROBES,
+
+ /** The device supports setting the number of analog probes. */
+ SR_CONF_NUM_ANALOG_PROBES,
+
/*--- Special stuff -------------------------------------------------*/
/** Scan options supported by the driver. */
/** The device supports specifying the capturefile unit size. */
SR_CONF_CAPTURE_UNITSIZE,
- /** The device supports setting the number of probes. */
- SR_CONF_CAPTURE_NUM_PROBES,
+ /** Power off the device. */
+ SR_CONF_POWER_OFF,
+
+ /** Data source for acquisition. If not present, acquisition from
+ * the device is always "live", i.e. acquisition starts when the
+ * frontend asks and the results are sent out as soon as possible.
+ *
+ * If present, it indicates that either the device has no live
+ * acquisition capability (for example a pure data logger), or
+ * there is a choice. sr_config_list() returns those choices.
+ *
+ * In any case if a device has live acquisition capabilities, it
+ * is always the default. */
+ SR_CONF_DATA_SOURCE,
/*--- Acquisition modes ---------------------------------------------*/
* samples continuously, until explicitly stopped by a certain command.
*/
SR_CONF_CONTINUOUS,
+
+ /** The device has internal storage, into which data is logged. This
+ * starts or stops the internal logging. */
+ SR_CONF_DATALOG,
};
+/** Device instance data
+ */
struct sr_dev_inst {
+ /** Device driver. */
struct sr_dev_driver *driver;
+ /** Index of device in driver. */
int index;
+ /** Device instance status. SR_ST_NOT_FOUND, etc. */
int status;
+ /** Device instance type. SR_INST_USB, etc. */
int inst_type;
+ /** Device vendor. */
char *vendor;
+ /** Device model. */
char *model;
+ /** Device version. */
char *version;
+ /** List of probes. */
GSList *probes;
+ /** List of sr_probe_group structs */
+ GSList *probe_groups;
+ /** Device instance connection data (used?) */
+ void *conn;
+ /** Device instance private data (used?) */
void *priv;
};
-/** Types of device instances (sr_dev_inst). */
+/** Types of device instance, struct sr_dev_inst.type */
enum {
/** Device instance type for USB devices. */
SR_INST_USB = 10000,
/** Device instance type for serial port devices. */
SR_INST_SERIAL,
+ /** Device instance type for SCPI devices. */
+ SR_INST_SCPI,
};
-/** Device instance status. */
+/** Device instance status, struct sr_dev_inst.status */
enum {
/** The device instance was not found. */
SR_ST_NOT_FOUND = 10000,
SR_ST_STOPPING,
};
-/*
- * 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 sr_samplerates {
- uint64_t low;
- uint64_t high;
- uint64_t step;
- const uint64_t *list;
-};
-
+/** Device driver data */
struct sr_dev_driver {
/* Driver-specific */
+ /** Driver name */
char *name;
+ /** Long name, e.g. device name. */
char *longname;
+ /** API version (currently 1). */
int api_version;
+ /** Init driver */
int (*init) (struct sr_context *sr_ctx);
+ /** Free driver */
int (*cleanup) (void);
+ /** Scan for devices */
GSList *(*scan) (GSList *options);
+ /** Get device list */
GSList *(*dev_list) (void);
int (*dev_clear) (void);
- int (*config_get) (int id, const void **value,
- const struct sr_dev_inst *sdi);
- int (*config_set) (int id, const void *value,
- const struct sr_dev_inst *sdi);
- int (*config_list) (int info_id, const void **data,
- const struct sr_dev_inst *sdi);
+ int (*config_get) (int id, GVariant **data,
+ const struct sr_dev_inst *sdi,
+ const struct sr_probe_group *probe_group);
+ int (*config_set) (int id, GVariant *data,
+ const struct sr_dev_inst *sdi,
+ const struct sr_probe_group *probe_group);
+ int (*config_list) (int info_id, GVariant **data,
+ const struct sr_dev_inst *sdi,
+ const struct sr_probe_group *probe_group);
/* Device-specific */
+ /** Open device */
int (*dev_open) (struct sr_dev_inst *sdi);
+ /** Close device */
int (*dev_close) (struct sr_dev_inst *sdi);
+ /** Start data aquisition. */
int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
void *cb_data);
+ /** Stop data aquisition. */
int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
void *cb_data);
/* Dynamic */
+ /** Device driver private data */
void *priv;
};
-struct sr_session {
- /** List of struct sr_dev pointers. */
- GSList *devs;
- /** List of sr_receive_data_callback_t items. */
- GSList *datafeed_callbacks;
- GTimeVal starttime;
-
- unsigned int num_sources;
-
- /*
- * Both "sources" and "pollfds" are of the same size and contain pairs
- * of descriptor and callback function. We can not embed the GPollFD
- * into the source struct since we want to be able to pass the array
- * of all poll descriptors to g_poll().
- */
- struct source *sources;
- GPollFD *pollfds;
- int source_timeout;
-};
+/**
+ * @struct sr_session
+ *
+ * Opaque data structure representing a libsigrok session. None of the fields
+ * of this structure are meant to be accessed directly.
+ */
+struct sr_session;
#include "proto.h"
#include "version.h"